6.1-roUPnPServiceEvent

Owned by Anonymous
Sept 28, 2021
1 min read

ON THIS PAGE


This event object is returned whenever a UPnP event message is received (for example, from a Subscribe() operation on the roUPnPService object). If a UPnP event message contains multiple state variables, separate event objects will be returned for each state variable.

ifUPnPServiceEvent 

GetUUID() As String

Returns the subscription ID of the subscription service sending the event. This string matches the value returned by the GetSID() method of the roUPnPService instance that generated the event.

GetVariable() As String

Returns the name of the UPnP state variable to which the value corresponds.

GetValue() As String

Returns the value of the variable.

GetSequence() As Integer

Returns the incrementing sequence number, which denotes the UPnP message from which the update originated. The sequence number will be the same for multiple variable updates reported in a single UPnP event.

ifUserData

SetUserData(user_data As Object)

Sets the user data that will be returned when events are raised.

GetUserData() As Object

Returns the user data that has previously been set via SetUserData(). It will return Invalid if no data has been set.