Roassetrealizerevent – BrightSign Object Reference Manual (FW 5.1) User Manual

Page 189

Advertising
background image

181

roAssetRealizerEvent

This event object is returned when the

roAssetRealizer.Realize()

method is called. It yields information about the success

or failure of the realization process.

Interfaces:

ifAssetRealizerEvent

,

ifUserData


The ifAssetRealizerEvent interface provides the following:

GetEvent() As Integer: Returns an integer value indicating the type of the event:

101 EVENT_REALIZE_SUCCESS

The specified sync list was successfully realized.

-102 EVENT_REALIZE_INCOMPLETE

Realization could not begin because at least one of the required files is not
available in the pool.

-103 EVENT_REALIZE_FAILED_SAFE

Realization has failed. Nothing has been written to the destination, so it is
likely safe to continue the realization process. More information is about
the failure is available via the

GetFailureReason() and GetName()

methods.

-104 EVENT_REALIZE_FAILED_UNSAFE Realization has failed while running, and changes have been made to

destination files. It may not be safe to continue the realization process.
More information about the failure is available via the
GetFailureReason() and GetName() methods.

GetName() As String: Retrieves the name of the affected file if the realization process fails.

GetResponseCode() As Integer: Retrieves the roUrlTransfer response code associated with the event (if
any).

GetFailureReason() As String: Returns additional information if the realization process fails.

GetFileIndex() As Integer: Retrieves the zero-based index number of the the file in the sync spec.

Advertising