ListEventDescendants
From The Contingency Market
Contents |
ListEventDescendants(ulSessionID,uSequenceID,sIntegrity,sEventID,uGenerations,sParameterType,sPattern,bIncompleteOnly)
List the specified event's descendant 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)->ListEventDescendants(sEventID,sPattern)/secret"). -
string sEventID - ID of event whose children should be listed (blank for root event).
-
uint uGenerations - How many generations to descend. 0=all, 1=children, 2=children+grandchildren, 3=etc.
-
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.
-
bool bIncompleteOnly - Whether to omit officially observed events from the results.
RETURNS
[ SEventData {sID,sIDParent,bDependent,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.
-
bool bDependent - Whether the child is dependent upon its parent.
-
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
ListEventDescendants(null,3,"URL_RSS") according to the respective template currently returns
- Begin>0/+hip666p.blogspot.com>=0/+http://hip666p.blogspot.com/feeds/posts/default?alt=rss>=0/+HiP.P's list of boring things he's done>=0:URL_RSS
- Begin>0/+web-tart.co.uk>=0/+http://web-tart.co.uk/online/files/tartnews.xml>=0/+Tart Feed>0:URL_RSS
- Begin>0/+www.digitalproductions.co.uk>=0/+http://www.digitalproductions.co.uk/index.php?rss=1>=0/+Digital Productions>0:URL_RSS
- Begin>0/+www.movingtofreedom.org>=0/+http://www.movingtofreedom.org/feed/>=0/+Moving to Freedom>0:URL_RSS
- Begin>0/+www.p2pnet.net>=0/+http://www.p2pnet.net/feed>=0/+p2pnet news>0:URL_RSS.

