EnsureEventChild

From The Contingency Market

Jump to: navigation, search

Contents

EnsureEventChild(ulSessionID,uSequenceID,sIntegrity,sEventID,sEventParameterName,sEventParameterMinimum,sEventParameterMaximum,bEventParameterInsideMinMax)

Ensures that an event has been defined.

PARAMETERS

ulong ulSessionID 
ID of authenticated session.
uint uSequenceID 
Sequence number.
string sIntegrity 
md5("ipaddr(sid,seq)->EnsureEventChild(sEventID,sEventParameterName,sEventParameterMinimum,sEventParameterMaximum,bEventParameterInsideMinMax)/secret")
string sEventID 
Unique ID of parent event (blank for root).
string sEventParameterName 
Predefined name of event parameter.
string sEventParameterMinimum 
Minimum value (must of a type compatible with the type of the event parameter).
string sEventParameterMaximum 
Maximum value (must of a type compatible with the type of the event parameter).
bool bEventParameterInsideMinMax 
True if value must be within min & max.

RETURNS

SEventData {sID,sIDParent,sName,sPath,sDetails,sParameterName,sParameterType,sParameterMinimum,sParameterMaximum,bParameterInsideMinMax}

string sID 
32 digit hex representing this event's globally unique id.
string sIDParent 
ID of parent event.
string sName 
Event name.
string sPath 
Event path.
string sParameterName 
Name of event parameter.
string sParameterType 
Type of event parameter.
string sParameterMinimum 
Lower bound for event parameter.
string sParameterMaximum 
Upper bound for event parameter.
bool bParameterInsideMinMax 
Whether parameter value must lie within bounds or not (for event to occur).

FAULTS

Session. Event.

Views
Personal tools