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 Status As ServerStatus Dim value As ReplyBase value = instance.GetStatus(LocaleID, ClientRequestHandle, Status) | |
| C# | |
|---|---|
[SoapDocumentMethodAttribute(Action="http://opcfoundation.org/webservices/XMLDA/1.0/GetStatus", RequestNamespace="http://opcfoundation.org/webservices/XMLDA/1.0/", ResponseNamespace="http://opcfoundation.org/webservices/XMLDA/1.0/", Use=SoapBindingUse.Literal, ParameterStyle=SoapParameterStyle.Wrapped)] public ReplyBase GetStatus( string LocaleID, string ClientRequestHandle, out ServerStatus Status ) | |
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.
- Status
- Returned server status information.
Return Value
Container of information that represents the basic information for most responses.Example
| Visual Basic | Copy Code |
|---|---|
Private Function getVendor(ByVal Srv As XmlServer) As String Dim status As ServerStatus Dim reply As ReplyBase reply = Srv.GetStatus(Nothing, Nothing, status) Return status.VendorInfo End Function | |
| C# | Copy Code |
|---|---|
private string getVendor( XmlServer Srv) { ServerStatus status ; ReplyBase reply ; reply = Srv.GetStatus(null, null, status); return status.VendorInfo ; } | |
Requirements
Target Platforms:Windows XP Professional, Windows Server 2003 family, Windows Vista, Windows 7, Windows Server 2008 family
>