Keysight VISA.NET Help
SerialSession Class Members
Properties  Methods  Events


The following tables list the members exposed by SerialSession.

Public Constructors
 NameDescription
Public ConstructorSerialSession ConstructorOverloaded.   
Top
Public Properties
 NameDescription
Public PropertyBaudRate The baud rate of the interface.  
Public PropertyBytesAvailable The number of bytes available in the global receive buffer.  
Public PropertyClearToSendState The current state of the Clear To Send (CTS) input signal.  
Public PropertyDataBits The number of data bits contained in each frame (5, 6, 7, or 8).  
Public PropertyDataCarrierDetectState The current state of the Data Carrier Detect (DCD) input signal.  
Public PropertyDataSetReadyState The current state of the Data Set Ready (DSR) input signal.  
Public PropertyDataTerminalReadyState The state of the Data Terminal Ready (DTR) output signal.  
Public PropertyEventQueueCapacity The maximum number of events that can be queued at any time on this session. The default is 50. (Inherited from Keysight.Visa.VisaSession)
Public PropertyExportEnabledTogether with the Keysight ResourceManager.FindExportedResourcesOnly property, determines whether the resource associated with this session instance is reported by the Keysight Find and Parse methods. (Inherited from Keysight.Visa.VisaSession)
Public PropertyFlowControl The flow control mechanism(s) used by this serial connection.  
Public PropertyFormattedIO A reference to the Formatted I/O interface. Keysight VISA.NET uses the standard Formatted I/O implementation provided by the IVI Foundation in the VISA.NET Shared Components. (Inherited from Keysight.Visa.MessageBasedSession)
Public PropertyHardwareInterfaceName A human-readable description of the hardware interface associated with this session. (Inherited from Keysight.Visa.VisaSession)
Public PropertyHardwareInterfaceNumber The board number of the hardware interface associated with this session. (Inherited from Keysight.Visa.VisaSession)
Public PropertyHardwareInterfaceType The type (GPIB, ASRL, etc.) of the hardware interface associated with this session. (Inherited from Keysight.Visa.VisaSession)
Public PropertyInternalHandle The VISA C handle to the underlying VISA C session. (Inherited from Keysight.Visa.VisaSession)
Public PropertyIOProtocol The protocol type for I/O communication with the device. This property applies to this session only (VISA local scope). (Inherited from Keysight.Visa.MessageBasedSession)
Public PropertyParity The parity used with every frame transmitted and received.  
Public PropertyRawIO A reference to the raw (no formatting) I/O interface. (Inherited from Keysight.Visa.MessageBasedSession)
Public PropertyReadTermination The method used to terminate read operations.  
Public PropertyReplacementCharacter The character used to replace incoming characters that arrive with errors (such as parity errors).  
Public PropertyRequestToSendState The current state of the Request To Send (RTS) output signal.  
Public PropertyResourceClass The resource class of the currently open resource. Possible values are INSTR, INTFC, MEMMAC, SOCKET, and BACKPLANE. (Inherited from Keysight.Visa.VisaSession)
Public PropertyResourceImplementationVersion The version of this Keysight VISA.NET implementation. (Inherited from Keysight.Visa.VisaSession)
Public PropertyResourceLockState The state of the resource-wide lock on the currently open resource. (Inherited from Keysight.Visa.VisaSession)
Public PropertyResourceManagerA private instance of the ResourceManager created when this session was instantiated, and available until this session is disposed. (Inherited from Keysight.Visa.VisaSession)
Public PropertyResourceManufacturerId The VXI manufacturer ID of the software vendor of this VISA.NET implementation - '4095'. (Inherited from Keysight.Visa.VisaSession)
Public PropertyResourceManufacturerName The name of the software vendor that corresponds to the ResourceManufacturerId property - 'Keysight Technologies, Inc.'. (Inherited from Keysight.Visa.VisaSession)
Public PropertyResourceName The VISA resource name of the currently open resource. This name is the canonical version of the resource name and therefore may vary from the resourceName parameter used to instantiate the session. (Inherited from Keysight.Visa.VisaSession)
Public PropertyResourceSpecificationVersion The version of the VISA.NET specification that describes the functionality provided by this session class. (Inherited from Keysight.Visa.VisaSession)
Public PropertyRingIndicatorState The current state of the Ring Indicator (RI) input signal.  
Public PropertySendEndEnabled Enables/disables sending the END signal on the last byte of a write. This property applies to this session only (VISA local scope). (Inherited from Keysight.Visa.MessageBasedSession)
Public PropertySessionType The type of the current session. (Inherited from Keysight.Visa.VisaSession)
Public PropertyStopBits The number of stop bits used to indicate the end of a frame.  
Public PropertySynchronizeCallbacks Specifies whether callbacks must be performed in a specific synchronization context. If false, the implementation is allowed to execute callbacks in any context. The default value is true. This property applies to this session only (local scope). (Inherited from Keysight.Visa.VisaSession)
Public PropertyTerminationCharacterThe ASCII character used to end reading. This property applies to this session only (VISA local scope). (Inherited from Keysight.Visa.MessageBasedSession)
Public PropertyTerminationCharacterEnabledIf true, read operations end when a termination character is received. This property applies to this session only (VISA local scope). (Inherited from Keysight.Visa.MessageBasedSession)
Public PropertyTimeoutMilliseconds The I/O timeout in milliseconds for I/O communication on this resource session. (Inherited from Keysight.Visa.VisaSession)
Public PropertyWaitForLockRelease Indicates whether methods and properties from this session instance will wait for a timeout period for a resource lock to be released (true) or not (false). (Inherited from Keysight.Visa.VisaSession)
Public PropertyWriteTermination The method used to terminate write operations.  
Public PropertyXOffCharacter The value of the XOFF character used for XON/XOFF flow control (both directions).  
Public PropertyXOnCharacter The value of the XON character used for XON/XOFF flow control (both directions).  
Top
Public Methods
 NameDescription
Public MethodAssertTrigger Asserts a software or hardware trigger, depending on the default trigger protocol for the session type. (Inherited from Keysight.Visa.MessageBasedSession)
Public MethodClear Performs an IEEE 488.1-style clear of the device and clears the input and output buffer (both raw and formatted I/O buffers). It also may terminate ending operations on the device. (Inherited from Keysight.Visa.MessageBasedSession)
Public MethodDisableEventDisables a calling program's ability to receive events of the type specified by the eventType argument using a VisaSession.WaitOnEvent method (any overload). (Inherited from Keysight.Visa.VisaSession)
Public MethodDiscardEventsDiscards events of the type specified by the eventType argument from the queue for that event type. (Inherited from Keysight.Visa.VisaSession)
Public MethodDisposeOverloaded.  Performs tasks associated with freeing, releasing, or resetting unmanaged VISA resources used by this session. (Inherited from Keysight.Visa.VisaSession)
Public MethodEnableEventEnables a calling program's ability to receive events of the type specified by the eventType argument using a WaitOnEvent method. (Inherited from Keysight.Visa.VisaSession)
Public MethodFlush Flushes the read and write buffers associated with serial interfaces.  
Public MethodLockResourceOverloaded.  Acquires a lock on the resource for this session. (Inherited from Keysight.Visa.VisaSession)
Public MethodReadStatusByte Reads the status from the device. For 488.2 instruments, this is the 488.2 status byte. (Inherited from Keysight.Visa.MessageBasedSession)
Public MethodSetBufferSize Sets the size of the read and/or write buffer for serial communication.  
Public MethodUnlockResource Unlocks the resource. (Inherited from Keysight.Visa.VisaSession)
Public MethodWaitOnEventOverloaded.  Waits for an occurrence of the specified event for this session. In particular, WaitOnEvent suspends execution of the thread on which it is called and waits for the specified event indefinitely. (Inherited from Keysight.Visa.VisaSession)
Top
Protected Methods
 NameDescription
Protected MethodFinalize Performs tasks associated with freeing, releasing, or resetting unmanaged VISA resources used by this session. (Inherited from Keysight.Visa.VisaSession)
Top
Public Events
 NameDescription
Public EventServiceRequest Occurs when a service request is received from the device. (Inherited from Keysight.Visa.MessageBasedSession)
Top
See Also

Reference

SerialSession Class
Keysight.Visa Namespace

 

 


© Keysight Technologies 2015-2025