IAsyncMessage::WriteString

Description

Writes data to device asynchronously. The data argument is a string.

The write operation asynchronously transfers data.  The data to be written is in the buffer represented by buf. This operation normally returns before the transfer terminates.  An I/O Completion event will be posted when the transfer is actually completed.

The operation returns jobId, which you can use either with Terminate to abort the operation, or with an I/O Completion event to identify which asynchronous write operation completed.

VB Prototype

value As Long = WriteString(
  buffer As String
)

C++ Prototype

HRESULT WriteString(
  BSTR buffer,
  long* pJobId
);

Parameters

buffer

The I/O data to write in the form of a BSTR.

pJobId

This job ID can be used to terminate the operation or to identify the event object resulting from this call.

Return Value

Refer to the table of return codes.

See Also

ComponentVersion, SpecVersion, HardwareInterfaceName, HardwareInterfaceNumber, HardwareInterfaceType, LockState, OptionString, ProgID, ResourceName, SessionType, SoftwareManufacturerID, SoftwareManufacturerName, Timeout, LastStatus, IOProtocol, SendEndEnabled, TerminationCharacter, TerminationCharacterEnabled, GetAttribute, SetAttribute, LockRsrc, UnlockRsrc, Init, Close, AssertTrigger, Clear, ReadSTB, Read, Write, WriteString, Terminate, IAsyncMessage Overview