VxiSession 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)

VxiSession Class Constructors Methods Fields Properties Events See Also


The VxiSession type exposes the following members.

Constructors

NameDescription
VxiSession

Overloaded. Initializes a new instance of the VxiSession object from the specified resource name.

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.
CommandQuery Sends the device a miscellaneous command or query and/or retrieves the response to a previous query.
CreateObjRefCreates an object that contains all the relevant information required to generate a proxy used to communicate with a remote object. (Inherited from MarshalByRefObject.)
DisableEvent

Overloaded. Disables notification of the specified event type on the specified event-handling mechanism.

DiscardEvent

Overloaded. Discards event occurrences for the specified MessageBasedSession event type on the queuing mechanism for a session.

Dispose

Overloaded. Releases all resources used by Session.

EnableEvent

Overloaded. 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.
EqualsDetermines whether the specified Object is equal to the current Object. (Inherited from Object.)
Finalize Finalizes the instance of the Session class. (Inherited from Session.)
GetAttributeBoolean Provides direct read access to the NI-VISA driver-level attributes of Boolean data type. (Inherited from Session.)
GetAttributeByte Provides direct read access to the NI-VISA driver-level attributes of Byte data type. (Inherited from Session.)
GetAttributeInt16 Provides direct read access to the NI-VISA driver-level attributes of Int16 data type. (Inherited from Session.)
GetAttributeInt32 Provides direct read access to the NI-VISA driver-level attributes of Int32 data type. (Inherited from Session.)
GetAttributeInt64 Provides direct read access to the NI-VISA driver-level attributes of Int64 data type. (Inherited from Session.)
GetAttributeString Provides direct read access to the NI-VISA driver-level attributes of String data type. (Inherited from Session.)
GetHashCodeServes as a hash function for a particular type. (Inherited from Object.)
GetLifetimeServiceRetrieves the current lifetime service object that controls the lifetime policy for this instance. (Inherited from MarshalByRefObject.)
GetService Returns an object that represents a service provided by the VxiSession.
GetTypeGets the Type of the current instance. (Inherited from Object.)
In16

Overloaded. Reads in a 16-bit value from the specified memory address space and offset.

In32

Overloaded. Reads in a 32-bit value from the specified memory address space and offset.

In64

Overloaded. Reads in a 64-bit value from the specified memory address space and offset.

In8

Overloaded. Reads in an 8-bit value from the specified memory address space and offset.

InitializeLifetimeServiceObtains a lifetime service object to control the lifetime policy for this instance. (Inherited from MarshalByRefObject.)
InstallCustomEventHandler Installs a handler for a nonstandard or new event type. (Inherited from Session.)
LockResource

Overloaded. Establishes an exclusive lock to the specified resource using the Timeout property.

MemberwiseClone

Overloaded. Creates a shallow copy of the current Object.

MemoryAllocate Obsolete. Allocates memory from the memory region of a device.
MemoryAllocate64BitBusAddress Allocates memory from the memory region of a device.
MemoryFree

Overloaded. Frees memory previously allocated using the MemoryAllocate method.

MoveIn16

Overloaded. Moves a block of 16-bit data from the specified address space and offset to local memory.

MoveIn32

Overloaded. Moves a block of 32-bit data from the specified address space and offset to local memory.

MoveIn64

Overloaded. Moves a block of 64-bit data from the specified address space and offset to local memory.

MoveIn8

Overloaded. Moves a block of 8-bit data from the specified address space and offset to local memory.

MoveOut16

Overloaded. Moves a block of 16-bit data from local memory to the specified address space and offset.

MoveOut32

Overloaded. Moves a block of 32-bit data from local memory to the specified address space and offset.

MoveOut64

Overloaded. Moves a block of 64-bit data from local memory to the specified address space and offset.

MoveOut8

Overloaded. Moves a block of 8-bit data from local memory to the specified address space and offset.

OnServiceRequest Raises the ServiceRequest event of the VxiSession object.
OnSignalProcessor Raises the SignalProcessor event of the VxiSession object.
OnTrigger Raises the Trigger event of the VxiSession object.
OnVxiVmeInterrupt Raises the VxiVmeInterrupt event of the VxiSession object.
Out16

Overloaded. Writes a 16-bit value to the specified memory space and offset.

Out32

Overloaded. Writes a 32-bit value to the specified memory space and offset.

Out64

Overloaded. Writes a 64-bit value to the specified memory space and offset.

Out8

Overloaded. Writes an 8-bit value to the specified memory space and offset.

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.

SetAttributeBoolean Provides direct write access to the NI-VISA driver-level attributes of Boolean data type. (Inherited from Session.)
SetAttributeByte Provides direct write access to the NI-VISA driver-level attributes of Byte data type. (Inherited from Session.)
SetAttributeInt16 Provides direct write access to the NI-VISA driver-level attributes of Int16 data type. (Inherited from Session.)
SetAttributeInt32 Provides direct write access to the NI-VISA driver-level attributes of Int32 data type. (Inherited from Session.)
SetAttributeInt64 Provides direct write access to the NI-VISA driver-level attributes of Int64 data type. (Inherited from Session.)
SetAttributeString Provides direct write access to the NI-VISA driver-level attributes of String data type. (Inherited from Session.)
Terminate

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

ToString Overrides ToString. (Inherited from Session.)
UninstallCustomEventHandler Uninstalls a handler for a nonstandard or new event type that was installed with InstallCustomEventHandler. (Inherited from Session.)
UnlockResource Relinquishes a lock for the specified resource. (Inherited from Session.)
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. Synchronously reads data from a file and writes it to the device or interface.

Fields

NameDescription
UnknownLogicalAddress Indicates that the logical address is unknown.
UnknownSlotNumber Indicates that the slot number is unknown.

Properties

NameDescription
AllowDma Gets or sets a value indicating whether I/O accesses use DMA or Programmed I/O.
CommanderLogicalAddress Gets the unique logical address of the VXI device commander used in the specified session.
DefaultBufferSize Gets or sets the default size of read or write buffers when the size is not explicitly defined by a parameter on read or write operations.
DestinationByteOrder Gets or sets the byte order to use in high-level access operations, such as Out32 and MoveOut32, when writing to the destination.
DestinationIncrement Gets or sets how many elements the destination offset is incremented after every transfer.
DestinationPrivilege Gets or sets the address modifier to use in high-level access operations, such as Out32 and MoveOut32, when writing to the destination.
DeviceClass Gets the VXI-defined device class to which the resource belongs.
FastDataChannel Gets or sets the Fast Data Channel (FDC) that is used to transfer the buffer.
FastDataChannelMode Gets or sets the Fast Data Channel (FDC) mode.
FastDataChannelUsePair Gets or sets a value indicating whether to use a channel pair for transferring data.
Handle Gets access to the NI-VISA driver session handle that NI-VISA driver operations use internally. (Inherited from Session.)
HardwareInterfaceName Gets human-readable text that describes the current hardware interface. (Inherited from Session.)
HardwareInterfaceNumber Gets the board number for the current hardware interface. (Inherited from Session.)
HardwareInterfaceType Gets the hardware interface type of this session. (Inherited from Session.)
IOProtocol Gets or sets the input/output protocol to use for the current hardware interface.
Is4882Compliant Gets if the device associated with this session is 488.2 compliant.
IsImmediateServant Gets if the device associated with this session is an immediate servant of the controller running VISA.
LastStatus Gets the last NI-VISA driver status code that was received when this API called a NI-VISA driver method. (Inherited from Session.)
LogicalAddress Gets the logical address of the VXI or VME device used by the specified session.
MainframeLogicalAddress Gets the lowest logical address in the mainframe.
ManufacturerID Gets the manufacturer identification number of the device.
ManufacturerName Gets the name of the device manufacturer.
MemoryAddressSpace Gets the VXIbus address space used by the device.
MemoryBase Gets the base address of the device in VXIbus memory address space when running in 32-bit mode.
MemoryBase64 Gets the base address of the device in VXIbus memory address space when running in 64-bit mode.
MemorySize Gets the size of memory requested by the device in VXIbus address space when running in 32-bit mode.
MemorySize64 Gets the size of memory requested by the device in VXIbus address space when running in 64-bit mode.
ModelCode Gets the model code for the device.
ModelName Gets the model name of the device.
ReadToFileAppends Gets or sets a value indicating whether the ReadToFile method overwrites or appends data when opening a file.
ResourceClass Gets the resource class (for example, "INSTR") as defined by the canonical resource name. (Inherited from Session.)
ResourceImplementationVersion Gets the resource version that uniquely identifies each revision or implementation of a resource. (Inherited from Session.)
ResourceLockState Gets the current locking state of the resource. (Inherited from Session.)
ResourceManufacturerID Gets a value that corresponds to the VXI manufacturer ID of the vendor that implemented the VISA library. (Inherited from Session.)
ResourceManufacturerName Gets a string that corresponds to the manufacturer name of the vendor that implemented the VISA library. (Inherited from Session.)
ResourceName Gets the unique identifier for a resource. (Inherited from Session.)
ResourceSpecificationVersion Gets the resource version that uniquely identifies the VISA specification version to which the implementation is compliant. (Inherited from Session.)
SendEndEnabled Gets or sets a value indicating whether to assert END during the transfer of the last byte of the buffer.
SlotNumber Gets the physical slot location of the device.
SourceByteOrder Gets or sets the byte order to use when reading from the source.
SourceIncrement Gets or set how many elements the source offset is incremented after every transfer.
SourcePrivilege Gets or sets the address modifier to use when reading from the source.
SynchronizeCallbacks Specifies how events and callback delegates are invoked. (Inherited from Session.)
SynchronizingObject Obsolete. Gets or sets the object that marshals event-handler and callback calls. (Inherited from Session.)
TerminationCharacter Gets or sets the termination character.
TerminationCharacterEnabled Gets or sets if the read operation terminates when a termination character is received.
Timeout Gets or sets the minimum timeout value to use in milliseconds when accessing the device associated with the session. (Inherited from Session.)
TriggerLine Gets or sets the identifier for the current triggering mechanism.
TriggerSupport Gets the VXI trigger lines that this VISA implementation supports.
VisaEventQueueLength Gets or sets the maximum number of events that can be queued at any time on the session. (Inherited from Session.)

Events

NameDescription
ServiceRequest Occurs when a service request is received from the device associated with this session.
SignalProcessor Occurs when a VXIbus signal or VXIbus interrupt is received from the device associated with the session.
Trigger Occurs when a trigger interrupt is received from the device.
VxiVmeInterrupt Occurs when a VXIbus interrupt is received from the device associated with the session.

See Also

Reference

VxiSession Class

NationalInstruments.VisaNS Namespace

WAS THIS ARTICLE HELPFUL?

Not Helpful