WireWare native: WireWare FindServiceByPropsNode
From FactorityWiki
Contents |
Summary
Searches a specific node for a specified service.
WIREWARE_RESULT WireWare_FindServiceByPropsNode (
| WIREWARE_CSTR | properties | // pointer to list of properties | |
| WIREWARE_NODE_ID | nodeID | // the node ID of the node to search | |
| PWIREWARE_SERVICE_ID | service | // pointer to a memory location for the service ID | |
| WIREWARE_TIMEOUT | timeout | // timeout in ms |
);
Parameters
| properties |
Points to a null-terminated string. It specifies a list of properties, which are used to initialize the WireWare subsystem.
A property is a name/value pair. The definition of a property is a string, which contains the name and the value, which are separated by a "=".
Example: value_one=1
A property list is a concatenation of multiple property definitions, which are separated by a ";".
Example: value_one=2;string_two=two
|
| nodeID |
Specifies a node, which has to be search for a service which matches the given properties.
|
| service |
Specifies a pointer to a memory location, to which the service ID is copied, if the specified service has been found.
|
| timeout |
Specifies the maximum allowed execution time (in ms) for this function.
|
Result
If the function succeeds, the return value is WIREWARE_ERROR_NONE. Otherwise it returns an appropriate error code.
Explanation
This function searches a node for a service, which matches the given properties. The search algorithm honors the configured routing rules. If the node with the given node ID is not reachable by applying the routing rules, the search failes.
If no appropriate service has been found, the function always times out. In this case the function blocks always the for time, which has been specified in the timeout parameter. The functions result is WIREWARE_ERROR_TIMEOUT in this case.
