The following tables list the members exposed by RequestOptions.
Public Constructors
| Name | Description | |
|---|---|---|
 | RequestOptions Constructor |
Public Properties
| Name | Description | |
|---|---|---|
 | 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. |
| LocaleID | An optional value supplied by the client that specifies the language for certain return data (see specification Section 2.4). |
| RequestDeadline | Indicates the specific absolute time (in UTC) that the client wants to wait for the Server to process a response by either returning whatever data it might have or confirm that there was some error condition which prevents a successful response. Data for items, which is not available by that time, should be returned as errors. If the RequestDeadline is earlier than the current time of the server (RcvTime) then the whole request fails. If (RequestDeadline - RcvTime) <= 0 Then E_TIMEDOUT fault If (RequestDeadline - current time) <= 0 Then E_TIMEDOUT errors for unprocessed items The request may timeout independently of RequestDeadline based on other system parameters. In the case of the system based timeout, the whole request will fail. The client can thus expect that the request will come to some closure based on the lesser of the RequestDeadline and the system based timeout. If omitted then the server will use some server specific period to process the response. The expectation is that the client and server are reasonably time synched which is necessary for this service to work properly. The client may gain some insight in calculating this attribute by reviewing RcvTime, and ReplyTime in the ReplyBase for responses. The server specific timeout might be determined by something equivalent to a TCP/IP timeout or perhaps by the time required to make a connection to a remote RTU. It is expected that the server specific maximum time will generally be no more than a minute or two although this depends on the details of the underlying system. |
| RequestDeadlineSpecified | If FALSE then the RequestDeadline value is not defined or ignored. |
| ReturnDiagnosticInfo | If TRUE the server will return verbose server specific diagnostic information to provide additional information relative to item specific errors. The server is required to return specific diagnostic information or a blank string if diagnostic information is not available. |
| ReturnErrorText | If TRUE (default) the server will return verbose error description. See also LocaleID, below and the Error type. |
| ReturnItemName | Indicates whether to return ItemName for each item. Default is False which means ItemName will not be returned. |
| ReturnItemPath | Indicates whether to return ItemPath for each item. Default is False which means ItemPath will not be returned. |
| ReturnItemTime | Indicates whether to return the timestamp for each item. Default is False which means item time will not be returned. Item values and quality are not client options and are returned according to the value??s quality ?? see description in ItemValue section. |