The Method GetResultIdListFiltered is used to get a list of results matching certain filter criteria. The signature of this Method is specified below. Table 6 and Table 7 specify the Arguments and AddressSpace representation, respectively.
Signature
GetResultIdListFiltered (
[in]0:ContentFilter filter,
[in]0:RelativePath[] orderedBy,
[in]0:UInt32 maxResults,
[in]0:Int32 timeout,
[out]0:Handle resultHandle,
[out]0:TrimmedString[] resultIdList,
[out]0:Int32 error)
Table 6 – GetResultIdListFiltered Method Arguments
|
Argument |
Description |
|
filter |
Filter used to filter for specific results based on the meta data of the results. Valid BrowsePaths used in the filter can be built from the fields of the ResultReadyEventType, the ResultType VariableType or the ResultDataType or corresponding subtypes. |
|
orderedBy |
An array of RelativePaths identifying the ordering criteria for the results. If the array is null or empty, no ordering is executed. If several RelativePaths are provided, the first entry in the array is used as first ordering criteria, etc. |
|
maxResults |
Defines how many resultIds the Client wants to receive at most. If no maximum should be provided, it is set to 0. |
|
timeout |
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 has to be used by the Client to release the result set. If the instance of ResultManagementType does not support the ReleaseResultHandle Method, the resultHandle should always be set to 0. If the error is set to a value other than 0, the resultHandle may be set to 0. |
|
resultIdList |
List of resultIds of results matching the Filter. |
|
error |
0 – OK Values > 0 are reserved for errors defined by this and future standards. Values < 0 shall be used for application-specific errors. |
Table 7 – GetResultIdListFiltered Method AddressSpace Definition
|
Attribute |
Value |
||||
|
BrowseName |
GetResultIdListFiltered |
||||
|
References |
Node Class |
BrowseName |
DataType |
TypeDefinition |
ModellingRule |
|
0:HasProperty |
Variable |
0:InputArguments |
0:Argument[] |
0:PropertyType |
0:Mandatory |
|
0:HasProperty |
Variable |
0:OutputArguments |
0:Argument[] |
0:PropertyType |
0:Mandatory |