ListEventChildren
From The Contingency Market
Contents |
ListEventChildren(ulSessionID,uSequenceID,sIntegrity,sEventID,sPattern)
List the specified event's child events that have a parameter name matching a given pattern.
PARAMETERS
-
ulong ulSessionID - ID of authenticated session.
-
uint uSequenceID - Sequence number.
-
string sIntegrity -
md5("ipaddr(sid,seq)->ListEventChildren(sEventID,sPattern)/secret"). -
string sEventID - ID of event whose children should be listed (blank for root event).
-
string sPattern - Wildcarded search pattern compared against event parameter name. Empty matches all. % any string. _ any char. [a-z] char in range. [^a-z] char not in range.
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.
TEST
ListEventChildren() according to the respective template currently returns
