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

Options
Container with options used in most server calls.
ItemList
The container for the individual Items. It is expected that there are one or more Items per ItemList.
ReturnValuesOnReply
Indicates whether to return the Value for each item (i.e., the Value of the ItemValue structure). The returned value is the value “accepted” by the server, or device. If a Value is returned, then the associated QualityField will also be returned, and as appropriate the LimitField, and VendorField. The returned value is equivalent to the value which would be returned by the server to the client if the client had performed a read request directly after the write request. Values are never returned if the Write fails. If an item is write-only the server will return E_WRITEONLY in the response for this item. The response will provide no value element for the affected item.
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 write a set of item values to either an XML-DA or OPC-DA server.

Syntax

Visual Basic (Usage)Copy Code
Dim instance As OpcXmlDA
Dim Options As RequestOptions
Dim ItemList As WriteRequestItemList
Dim ReturnValuesOnReply As Boolean
Dim callback As AsyncCallback
Dim asyncState As Object
Dim value As IAsyncResult
 
value = instance.BeginWrite(Options, ItemList, ReturnValuesOnReply, callback, asyncState)

Parameters

Options
Container with options used in most server calls.
ItemList
The container for the individual Items. It is expected that there are one or more Items per ItemList.
ReturnValuesOnReply
Indicates whether to return the Value for each item (i.e., the Value of the ItemValue structure). The returned value is the value “accepted” by the server, or device. If a Value is returned, then the associated QualityField will also be returned, and as appropriate the LimitField, and VendorField. The returned value is equivalent to the value which would be returned by the server to the client if the client had performed a read request directly after the write request. Values are never returned if the Write fails. If an item is write-only the server will return E_WRITEONLY in the response for this item. The response will provide no value element for the affected item.
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.