Scpi Functions

Functions
EXPORT int	PwrSnsr_SendSCPICommand (SessionID Vi, const char *Command)
	Send a SCPI command to the instrument. More...
EXPORT int	PwrSnsr_ReadSCPI (SessionID Vi, int ValueBufferSize, long *ValueActualSize, char Value[], int Timeout)
	Read a SCPI string response from the instrument. More...
EXPORT int	PwrSnsr_SendSCPIToNamedParser (SessionID Vi, const char *name, const char *Command)
	Send a SCPI command to the instrument using a named SCPI parser. More...
EXPORT int	PwrSnsr_ReadSCPIFromNamedParser (SessionID Vi, const char *name, int ValueBufferSize, long *ValueActualSize, char Value[], int Timeout)
	Read a SCPI string response from the instrument. More...
EXPORT int	PwrSnsr_SendSCPIBytes (SessionID Vi, int CommandBufferSize, char Command[])
	Send a SCPI command as a byte array. More...
EXPORT int	PwrSnsr_ReadSCPIBytes (SessionID Vi, int ValueBufferSize, char Value[], long *ValueActualSize, int Timeout)
	Read a SCPI byte array response from the instrument. More...

Detailed Description

SCPI command functions

Function Documentation

PwrSnsr_ReadSCPI()

EXPORT int PwrSnsr_ReadSCPI	(	SessionID	Vi,
		int	ValueBufferSize,
		long *	ValueActualSize,
		char	Value[],
		int	Timeout
	)

Read a SCPI string response from the instrument.

Parameters

Vi	The SessionID handle that you obtain from the PwrSnsr_init function. The handle identifies a particular instrument session.
ValueBufferSize	Number of elements in Value.
ValueActualSize	Number of elements actually written to Value.
Value	The string returned from the instrument SCPI interface.
Timeout	Time out in milliseconds for the read operation. Use -1 for infinite and -2 to use the existing time out value.

Returns

Success (0) or error code.

PwrSnsr_ReadSCPIBytes()

EXPORT int PwrSnsr_ReadSCPIBytes	(	SessionID	Vi,
		int	ValueBufferSize,
		char	Value[],
		long *	ValueActualSize,
		int	Timeout
	)

Read a SCPI byte array response from the instrument.

Parameters

Vi	The SessionID handle that you obtain from the PwrSnsr_init function. The handle identifies a particular instrument session.
ValueBufferSize	Number of elements in Value.
Value	The byte array returned from the instrument SCPI interface.
ValueActualSize
Timeout	Time out in milliseconds for the read operation. Use -1 for infinite and -2 to use the existing time out value. Time out in milliseconds for the read operation. Use -1 for infinite and -2 to use the existing time out value.

Returns

Success (0) or error code.

PwrSnsr_ReadSCPIFromNamedParser()

EXPORT int PwrSnsr_ReadSCPIFromNamedParser	(	SessionID	Vi,
		const char *	name,
		int	ValueBufferSize,
		long *	ValueActualSize,
		char	Value[],
		int	Timeout
	)

Read a SCPI string response from the instrument.

Parameters

Vi	The SessionID handle that you obtain from the PwrSnsr_init function. The handle identifies a particular instrument session.
name	Name of the parser. If parser doesn't exist, returns PWR_SNSR_ERROR_NULL_POINTER. PwrSnsr_SendSCPIToNamedParser can be used to create a named parser.
ValueBufferSize	Number of elements in Value.
ValueActualSize	Number of elements actually written to Value.
Value	The string returned from the instrument SCPI interface.
Timeout	Time out in milliseconds for the read operation. Use -1 for infinite and -2 to use the existing time out value.

Returns

Success (0) or error code.

PwrSnsr_SendSCPIBytes()

EXPORT int PwrSnsr_SendSCPIBytes	(	SessionID	Vi,
		int	CommandBufferSize,
		char	Command[]
	)

Send a SCPI command as a byte array.

Parameters

Vi	The SessionID handle that you obtain from the PwrSnsr_init function. The handle identifies a particular instrument session.
CommandBufferSize	Number of elements in Command.
Command	Command to send.

Returns

Success (0) or error code.

PwrSnsr_SendSCPICommand()

EXPORT int PwrSnsr_SendSCPICommand	(	SessionID	Vi,
		const char *	Command
	)

Send a SCPI command to the instrument.

Parameters

Vi	The SessionID handle that you obtain from the PwrSnsr_init function. The handle identifies a particular instrument session.
Command

Returns

Success (0) or error code.

PwrSnsr_SendSCPIToNamedParser()

EXPORT int PwrSnsr_SendSCPIToNamedParser	(	SessionID	Vi,
		const char *	name,
		const char *	Command
	)

Send a SCPI command to the instrument using a named SCPI parser.

Parameters

Vi	The SessionID handle that you obtain from the PwrSnsr_init function. The handle identifies a particular instrument session.
name	Name of the parser. Creates a new parser if the name is not already used.
Command

Returns

Success (0) or error code.