IMessageBasedSession Members

NI-VisaNS .NET Class Library Help for Visual Studio 2010

Edition Date: August 2012

Part Number: 370627F-01

»View Product Info
Download Help (Windows Only)

IMessageBasedSession Interface Methods Properties Events See Also


The IMessageBasedSession type exposes the following members.

Methods

NameDescription
AssertTrigger Asserts a software or hardware trigger.
BeginRead

Overloaded. Initiates an asynchronous read from a device.

BeginWrite

Overloaded. Initiates an asynchronous write with ASCII-encoded string data to a device.

Clear Clears a device.
DisableEvent Disables notification of the specified event type on the specified event-handling mechanism.
DiscardEvent Discards event occurrences for the specified event type on the queuing mechanism for a session.
EnableEvent Enables notification of an event.
EndReadByteArray Handles the end of an asynchronous read and returns the read byte array.
EndReadString Handles the end of an asynchronous read and returns the ASCII-encoded read string.
EndWrite Handles the end of an asynchronous write.
GetServiceGets the service object of the specified type. (Inherited from IServiceProvider.)
Query

Overloaded. Performs a synchronous write of byte array data, followed by a synchronous read.

ReadByteArray

Overloaded. Synchronously reads byte array data from a device or interface.

ReadStatusByte Reads the status byte of a service request.
ReadString

Overloaded. Synchronously reads ASCII-encoded string data from a device or interface.

ReadToFile

Overloaded. Synchronously reads data and stores the transferred data in a file.

Terminate

Overloaded. Aborts all in-progress asynchronous read and write operations.

WaitOnEvent

Overloaded. Waits infinitely long for an occurrence of the specified event for a session.

Write

Overloaded. Synchronously writes an array of bytes to the device or interface.

WriteFromFile

Overloaded. Gets data from a file and synchronously writes it to the device or interface.

Properties

NameDescription
DefaultBufferSize Gets or sets the default size of read or write buffers when it is not explicitly defined as a parameter on read or write operations.
IOProtocol Gets or sets the I/O protocol to use for the current hardware interface.
ReadToFileAppends Get or sets a value indicating whether the ReadToFile method overwrites or appends data when opening a file.
SendEndEnabled Gets or sets a value indicating whether to assert END during the transfer of the last byte in the buffer.
TerminationCharacter Gets or sets the termination character.
TerminationCharacterEnabled Gets or sets a value indicating whether the read operation terminates when a termination character is received.

Events

NameDescription
ServiceRequest Occurs when the device associated with the session receives a service request.

See Also

Reference

IMessageBasedSession Interface

NationalInstruments.VisaNS Namespace

WAS THIS ARTICLE HELPFUL?

Not Helpful