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

Page 258

Advertising
background image

250

roUrlEvent

This event is generated by the roUrlTransfer object.

Interfaces:

ifInt

,

ifUserData

,

ifUrlEvent

,

ifString

,

ifSourceIdentity


The ifInt interface provides the following:

GetInt() As Integer: Returns the type of event. The following event types are currently defined: transfer
complete (1), transfer started (2).

The ifUserData interface provides the following:

SetUserData(user_data As Object): Sets the user data that will be returned when events are raised.

GetUserData() As Object: Retrieves an arbitrary object set via the SetUserData() method of the
roUrlTransfer instance that generated this event.

The ifUrlEvent interface provides the following:

GetResponseCode() As Integer: Returns the protocol response code associated with an event. The following
codes indicate success:

o 200: Successful HTTP transfer
o 226: Successful FTP transfer
o 0: Successful local file transfer

For unexpected errors, the return value is negative. There are many possible negative errors from the CURL library,
but it is often best to look at the text version by calling

GetFailureReason.

Here are some potential errors. Not all of them can be generated by a BrightSign player:
Status

Name

Description

-1

CURLE_UNSUPPORTED_PROTOCOL

Advertising