Visual Basic (Usage)

Copy Code

Dim instance As OpcXmlDA Dim PropertyNames() As XmlQualifiedName Dim LocaleID As String Dim ClientRequestHandle As String Dim ItemPath As String Dim ItemName As String Dim ContinuationPoint As String Dim MaxElementsReturned As Integer Dim BrowseFilter As browseFilter Dim ElementNameFilter As String Dim VendorFilter As String Dim ReturnAllProperties As Boolean Dim ReturnPropertyValues As Boolean Dim ReturnErrorText As Boolean Dim callback As AsyncCallback Dim asyncState As Object Dim value As IAsyncResult   value = instance.BeginBrowse(PropertyNames, LocaleID, ClientRequestHandle, ItemPath, ItemName, ContinuationPoint, MaxElementsReturned, BrowseFilter, ElementNameFilter, VendorFilter, ReturnAllProperties, ReturnPropertyValues, ReturnErrorText, callback, asyncState)

public IAsyncResult BeginBrowse( 
   XmlQualifiedName[] PropertyNames,
   string LocaleID,
   string ClientRequestHandle,
   string ItemPath,
   string ItemName,
   string ContinuationPoint,
   int MaxElementsReturned,
   browseFilter BrowseFilter,
   string ElementNameFilter,
   string VendorFilter,
   bool ReturnAllProperties,
   bool ReturnPropertyValues,
   bool ReturnErrorText,
   AsyncCallback callback,
   object asyncState
)

Parameters

PropertyNames

A sequence of qualified property names to be returned with each element. If ReturnAllProperties is true, PropertyName is ignored and all properties are returned.

LocaleID

An optional value supplied by the client that specifies the language for certain return data (see section LocaleID, above).

ClientRequestHandle

An optional value supplied by the client that will be returned with the response. In larger and more complex systems it helps the client to associate the replies with the proper requests.

ItemPath

The ItemPath for the starting item. This is not the branch. The fully qualified item name is in the ItemName argument.
If this is a secondary Browse request, this must be identical to the value supplied in the initial request.

ItemName

The ItemName for the starting item.
If this is a secondary Browse request, this must be identical to the value supplied in the initial request.

ContinuationPoint

If this is a secondary Browse request, the BrowseResponse might have returned a Continuation Point where the server can restart the browse operation.
This will not be provided in the initial Browse request. This is an Opaque value that the server creates.
A Continuation Point will be returned in the response if a Server does support Continuation Point, and the response is larger than MaxItemsReturned. The Continuation Point will allow the Client to resume the Browse request from the previous completion point. When using continuation point, clients must pass the same mask and filter for all subsequent Browse calls. Failing to do so will return error E_INVALIDCONTINUATIONPOINT.

MaxElementsReturned

Server must not return any more elements than this value.
If the server supports Continuation Points, then the Server may return a Continuation Point at a value less than MaxElementsReturned. The server will set MoreElements to True if there are more elements than MaxItemsReturned. If MaxElementsReturned is missing or 0 then there is no client side restriction on the number of returned elements.

BrowseFilter

An enumeration {all, branch, item} specifying which subset of browse elements to return. See the table in the comments section below to determine which combination of bits in BrowseElement are returned for each value of BrowseFilter.

ElementNameFilter

An expression that is identical to the format as defined in DA 2.0, and DA 3.0 will be used to filter Element names, i.e., the user readable Name field.

VendorFilter

A Vendor specific expression that will be used to filter Vendor specific information. Impact to results of the ElementNameFilter is undefined.

ReturnAllProperties

Server must return all properties which are available for each of the returned elements. If ReturnAllProperties is True, PropertyName is ignored. If ReturnAllProperties is False, PropertyName will be used.

ReturnPropertyValues

Server must return the property values in addition to the property names.

ReturnErrorText

If TRUE the server will return verbose error description.

callback

Delegate of the method to be called when the asynchronous operation is completed.

asyncState

A user-provided object that distinguishes this particular asynchronous request from other requests.

Return Value

Target Platforms:Windows XP Professional, Windows Server 2003 family, Windows Vista, Windows 7, Windows Server 2008 family

Reference