This method is used to retrieve a result by identifier from a given system. Depending on the design of the system, the client may be informed by events of ResultReadyEventType that a new result is available. Then, the client might fetch this result using the information provided by events of ResultReadyEventType.
Since the ResultId is supposed to be system-wide unique, this method shall return only a single result. Since there may be additional result content to be retrieved, the server should keep result data available, resources permitting, until the client releases the handle using ReleaseResultHandle method. However, the client cannot rely on the data to remain available until then.
Signature
GetResultById (
[in]GuidResultId,
[in]Int32ResourceTimeout,
[out]UInt32ResultHandle,
[out]ResultDataTypeResult,
[out]Int32Error)
Table 48 - GetResultById Method Arguments
|
Argument |
Description |
|
ResultId |
System-wide unique identifier for the result. |
|
ResourceTimeout |
With this argument the client can give a hint to the server how long it will need access to the result data. A value > 0 indicates an estimated maximum time for processing the data in milliseconds. A value = 0 indicates that the client will not need anything besides the data returned by the method call. A value < 0 indicates that the client cannot give an estimate. The client cannot rely on the data being available during the indicated time period. The argument is merely a hint allowing the server to optimize its resource management. |
|
ResultHandle |
The server shall return to each client requesting result data a system-wide unique handle identifying the result set / client combination. This handle should be used by the client to indicate to the server that the result data is no longer needed, allowing the server to optimize its resource handling. |
|
Result |
The result including metadata. |
|
Error |
0 – OK Values > 0 are reserved for errors defined by this and future standards. Values < 0 shall be used for application-specific errors.
Note: If the error != 0, the server is allowed to return NULL values for Result and 0 for ResultHandle but server might still return some data which is application specific. |
Table 49 - GetResultById Method AddressSpace definition
|
Attribute |
Value |
||||
|
BrowseName |
GetResultById |
||||
|
References |
NodeClass |
BrowseName |
DataType |
TypeDefinition |
Others |
|
HasProperty |
Variable |
InputArguments |
Argument[] |
PropertyType |
M |
|
HasProperty |
Variable |
OutputArguments |
Argument[] |
PropertyType |
M |