XMLDA.NET Reference
BeginGetStatus Method
See Also  Send Feedback
xmldanet.xmlda Namespace > OpcXmlDA Class : BeginGetStatus Method

LocaleID
An optional value supplied by the client that specifies the language for textual status data.
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.
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.

Glossary Item Box

XML-DA method to asynchronously read the current XML-DA or OPC-DA server status.
The purpose of the GetStatus service is:
- It provides a common mechanism for checking the status of the server - whether it is operational or in need of maintenance.
- It provides a common mechanism for obtaining vendor-specific information about the server that is not available through the other OPC services (version number, etc).
- Provides insight for clients as to the relative time synchronization between the client and server. As an example, this information is useful for Read requests.

Syntax

Visual Basic (Usage)Copy Code
Dim instance As OpcXmlDA
Dim LocaleID As String
Dim ClientRequestHandle As String
Dim callback As AsyncCallback
Dim asyncState As Object
Dim value As IAsyncResult
 
value = instance.BeginGetStatus(LocaleID, ClientRequestHandle, callback, asyncState)
C# 
public IAsyncResult BeginGetStatus( 
   string LocaleID,
   string ClientRequestHandle,
   AsyncCallback callback,
   object asyncState
)

Parameters

LocaleID
An optional value supplied by the client that specifies the language for textual status data.
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.
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

An object that supports the IAsyncResult interface stores state information for an asynchronous operation, and provides a synchronization object to allow threads to be signaled when the operation

Requirements

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

>

See Also

© 2002-2012 Advosol Inc. All Rights Reserved.