5 Service Sets ToC Previous Next

5.8 View Service Set ToC Previous Next

5.8.3 BrowseNext ToC Previous Next

5.8.3.1 Description ToC

This Service is used to request the next set of Browse or BrowseNext response information that is too large to be sent in a single response. “Too large” in this context means that the Server is not able to return a larger response or that the number of results to return exceeds the maximum number of results to return that was specified by the Client in the original Browse request. The BrowseNext shall be submitted on the same Session that was used to submit the Browse or BrowseNext that is being continued.

5.8.3.2 Parameters ToC

Table 37 defines the parameters for the Service.

Table 37 – BrowseNext Service Parameters

Name Type Description
Request    
   requestHeader Request Header Common request parameters (see 7.28 for RequestHeader definition).
   releaseContinuationPoints Boolean A Boolean parameter with the following values:
   TRUE passed continuationPoints shall be reset to free resources in the Server. The continuation points are released and the results and diagnosticInfos arrays are empty.
   FALSE passed continuationPoints shall be used to get the next set of browse information.
A Client shall always use the continuation point returned by a Browse or BrowseNext response to free the resources for the continuation point in the Server. If the Client does not want to get the next set of browse information, BrowseNext shall be called with this parameter set to TRUE.
   continuationPoints [] Continuation Point A list of Server-defined opaque values that represent continuation points. The value for a continuation point was returned to the Client in a previous Browse or BrowseNext response. These values are used to identify the previously processed Browse or BrowseNext request that is being continued and the point in the result set from which the browse response is to continue.
Clients may mix continuation points from different Browse or BrowseNext responses.
The ContinuationPoint type is described in 7.6.
     
Response    
   responseHeader Response Header Common response parameters (see 7.29 for ResponseHeader definition).
   results [] BrowseResult A list of references that met the criteria specified in the original Browse request.
The size and order of this list matches the size and order of the continuationPoints request parameter.
The BrowseResult type is defined in 7.3.
   diagnosticInfos [] Diagnostic Info List of diagnostic information for the results (see 7.8 for DiagnosticInfo definition). The size and order of the list matches the size and order of the results response parameter. This list is empty if diagnostics information was not requested in the request header or if no diagnostic information was encountered in processing of the request.

5.8.3.3 Service results ToC

Table 38 defines the Service results specific to this Service. Common StatusCodes are defined in Table 177.

Table 38 – BrowseNext Service Result Codes

Symbolic Id Description
Bad_NothingToDo See Table 177 for the description of this result code.
Bad_TooManyOperations See Table 177 for the description of this result code.

5.8.3.4 StatusCodes ToC

Table 39 defines values for the results parameter that are specific to this Service. Common StatusCodes are defined in Table 178.

Table 39 – BrowseNext Operation Level Result Codes

Symbolic Id Description
Bad_NodeIdInvalid See Table 178 for the description of this result code.
Bad_NodeIdUnknown See Table 178 for the description of this result code.
Bad_ReferenceTypeIdInvalid See Table 178 for the description of this result code.
Bad_BrowseDirectionInvalid See Table 178 for the description of this result code.
Bad_NodeNotInView See Table 178 for the description of this result code.
Bad_ContinuationPointInvalid See Table 178 for the description of this result code.

Previous Next