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

PxiSession Class Constructors Methods Fields Properties Events See Also


The PxiSession type exposes the following members.

Constructors

NameDescription
PxiSession

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

Methods

NameDescription
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 event type on the queuing mechanism for a session.

Dispose

Overloaded. Releases all resources used by Session.

EnableEvent

Overloaded. Enables notification of an event.

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

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.

OnPxiInterrupt Raises the PxiInterrupt event of the PxiSession 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.

ReserveTrigger Reserves a PXI trigger line on which the device can output a trigger signal.
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.)
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.)
UnreserveTrigger Releases a previously reserved PXI trigger line so that another device in the system can use it.
WaitOnEvent

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

Fields

NameDescription
UnknownSlotNumber Indicates that the slot number is unknown.

Properties

NameDescription
AllowDma Gets or sets if I/O accesses use DMA or Programmed I/O. (Inherited from RegisterBasedSession.)
BusNumber Gets the PXI bus number of the device.
ChassisNumber Gets the PXI chassis number of the device.
DestinationIncrement Gets or sets how many elements the destination offset is incremented after every transfer. (Inherited from RegisterBasedSession.)
DeviceNumber Gets the PXI device number for the current device.
DStarBusNumber The differential star bus number of the device.
DStarSetNumber The number of the set of PXI differential star lines connected to the device.
FunctionNumber Gets the PXI function number for the current device.
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.)
IsPxiExpress Gets whether the device associated with this session is a PXI Express or PCI Express device.
LastStatus Gets the last NI-VISA driver status code that was received when this API called a NI-VISA driver method. (Inherited from Session.)
LinkWidth Gets the PCI Express or PXI Express link width negotiated between the PCI Express or PXI Express host controller and the device.
ManufacturerID Gets the manufacturer identification number of the device.
ManufacturerName Gets the name of the manufacturer.
MaximumLinkWidth Gets the maximum PCI Express or PXI Express link width of the device.
MemoryBaseBar0 Gets the memory base address for base address register (BAR) 0.
MemoryBaseBar1 Gets the memory base address for base address register (BAR) 1.
MemoryBaseBar2 Gets the memory base address for base address register (BAR) 2.
MemoryBaseBar3 Gets the memory base address for base address register (BAR) 3.
MemoryBaseBar4 Gets the memory base address for base address register (BAR) 4.
MemoryBaseBar5 Gets the memory base address for base address register (BAR) 5.
MemorySizeBar0 Gets the memory size for base address register (BAR) 0.
MemorySizeBar1 Gets the memory size for base address register (BAR) 1.
MemorySizeBar2 Gets the memory size for base address register (BAR) 2.
MemorySizeBar3 Gets the memory size for base address register (BAR) 3.
MemorySizeBar4 Gets the memory size for base address register (BAR) 4.
MemorySizeBar5 Gets the memory size for base address register (BAR) 5.
MemoryTypeBar0 Gets the memory type for base address register (BAR) 0.
MemoryTypeBar1 Gets the memory type for base address register (BAR) 1.
MemoryTypeBar2 Gets the memory type for base address register (BAR) 2.
MemoryTypeBar3 Gets the memory type for base address register (BAR) 3.
MemoryTypeBar4 Gets the memory type for base address register (BAR) 4.
MemoryTypeBar5 Gets the memory type for base address register (BAR) 5.
ModelCode Gets the model code for the device.
ModelName Gets the model name of the device.
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.)
SlotLinkWidth Gets the PCI Express or PXI Express link width of the PCI Express or PXI Express peripheral slot in which the device resides.
SlotLocalBusLeft Gets the slot number or special feature connected to the local bus left lines of the device.
SlotLocalBusRight Gets the slot number or special feature connected to the local bus right lines of the device.
SlotNumber Gets the physical slot location of the device.
SlotPath Gets the slot path of the device.
SourceIncrement Gets or sets how many elements the source offset is incremented after every transfer. (Inherited from RegisterBasedSession.)
StarTriggerBus Gets the star trigger bus number of the device.
StarTriggerLine Gets the PXI star line connected to the device.
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.)
Timeout Gets or sets the minimum timeout value to use in milliseconds when accessing the device associated with the session. (Inherited from Session.)
TriggerBus Gets the trigger bus number of the device.
VisaEventQueueLength Gets or sets the maximum number of events that can be queued at any time on the session. (Inherited from Session.)

Events

NameDescription
PxiInterrupt Occurs when the device associated with the session receives a PXI interrupt.

See Also

Reference

PxiSession Class

NationalInstruments.VisaNS Namespace

WAS THIS ARTICLE HELPFUL?

Not Helpful