Description

Functions to communicate with network instruments and instrument servers.

Functions
bool8_t	SrvConnect (LibTiePieHandle_t hServer, bool8_t bAsync)
	Connect to a specified network instrument or instrument server. This gives access to the network instrument or instruments connected to the instrument server. More...

bool8_t	SrvDisconnect (LibTiePieHandle_t hServer, bool8_t bForce)
	Disconnect from a specified network instrument or instrument server. This will close all opened instrument(s). More...

bool8_t	SrvRemove (LibTiePieHandle_t hServer, bool8_t bForce)
	Remove a specified specified network instrument or instrument server from the list of servers. More...

uint32_t	SrvGetStatus (LibTiePieHandle_t hServer)
	Retrieve the status of a specified network instrument or instrument server. More...

uint32_t	SrvGetLastError (LibTiePieHandle_t hServer)
	Get the last error from a specified network instrument or instrument server. More...

uint32_t	SrvGetURL (LibTiePieHandle_t hServer, char *pBuffer, uint32_t dwBufferLength)
	Get the URL of the specified network instrument or instrument server. More...

uint32_t	SrvGetID (LibTiePieHandle_t hServer, char *pBuffer, uint32_t dwBufferLength)
	Get the id of the specified network instrument or instrument server. More...

uint32_t	SrvGetIPv4Address (LibTiePieHandle_t hServer)
	Get the IPv4 address of the specified network instrument or instrument server. More...

uint16_t	SrvGetIPPort (LibTiePieHandle_t hServer)
	Get the IP port number of the specified network instrument or instrument server. More...

uint32_t	SrvGetName (LibTiePieHandle_t hServer, char *pBuffer, uint32_t dwBufferLength)
	Get the name of the specified network instrument or instrument server. More...

uint32_t	SrvGetDescription (LibTiePieHandle_t hServer, char *pBuffer, uint32_t dwBufferLength)
	Get the description of the specified network instrument or instrument server. More...

TpVersion_t	SrvGetVersion (LibTiePieHandle_t hServer)
	Get the software version number of the specified network instrument or instrument server. More...

uint32_t	SrvGetVersionExtra (LibTiePieHandle_t hServer, char *pBuffer, uint32_t dwBufferLength)
	Get the software version postfix of the specified network instrument or instrument server. More...

Function Documentation

bool8_t SrvConnect	(	LibTiePieHandle_t	hServer,
		bool8_t	bAsync
	)

Connect to a specified network instrument or instrument server. This gives access to the network instrument or instruments connected to the instrument server.

Parameters

[in]	hServer	A server handle identifying the server.
[in]	bAsync	Connect asynchronously

Returns: BOOL8_TRUE if successful, BOOL8_FALSE otherwise.

Since: 0.9

bool8_t SrvDisconnect	(	LibTiePieHandle_t	hServer,
		bool8_t	bForce
	)

Disconnect from a specified network instrument or instrument server. This will close all opened instrument(s).

Parameters

[in]	hServer	A server handle identifying the server.
[in]	bForce	If BOOL8_TRUE all open devices are closed, if BOOL8_FALSE remove only succeeds if no devices are open.

Returns: BOOL8_TRUE if successful, BOOL8_FALSE otherwise.

Since: 0.9

bool8_t SrvRemove	(	LibTiePieHandle_t	hServer,
		bool8_t	bForce
	)

Remove a specified specified network instrument or instrument server from the list of servers.

Parameters

[in]	hServer	A server handle identifying the server.
[in]	bForce	If BOOL8_TRUE all open devices are closed, if BOOL8_FALSE remove only succeeds if no devices are open.

Returns: BOOL8_TRUE if successful, BOOL8_FALSE otherwise.

Since: 0.9

uint32_t SrvGetStatus ( LibTiePieHandle_t hServer )

Retrieve the status of a specified network instrument or instrument server.

Parameters

[in] hServer A server handle identifying the server.

Returns: The status of the specified network instrument or instrument server, see LIBTIEPIE_SERVER_STATUS

Since: 0.9

uint32_t SrvGetLastError ( LibTiePieHandle_t hServer )

Get the last error from a specified network instrument or instrument server.

Parameters

[in] hServer A server handle identifying the server.

Returns: The last error given by the specified network instrument or instrument server, see LIBTIEPIE_SERVER_ERROR

Since: 0.9

uint32_t SrvGetURL	(	LibTiePieHandle_t	hServer,
		char *	pBuffer,
		uint32_t	dwBufferLength
	)

Get the URL of the specified network instrument or instrument server.

Parameters

[in]	hServer	A server handle identifying the server.
[out]	pBuffer	A pointer to a buffer for the URL.
[in]	dwBufferLength	The length of the buffer, in bytes.

Returns: The length of the URL in bytes, excluding terminating zero.

Since: 0.9

uint32_t SrvGetID	(	LibTiePieHandle_t	hServer,
		char *	pBuffer,
		uint32_t	dwBufferLength
	)

Get the id of the specified network instrument or instrument server.

Parameters

[in]	hServer	A server handle identifying the server.
[out]	pBuffer	A pointer to a buffer for the id.
[in]	dwBufferLength	The length of the buffer, in bytes.

Returns: The length of the id in bytes, excluding terminating zero.

Since: 0.9

uint32_t SrvGetIPv4Address ( LibTiePieHandle_t hServer )

Get the IPv4 address of the specified network instrument or instrument server.

Parameters

[in] hServer A server handle identifying the server.

Returns: The IPv4 address of the device, or zero if no IPv4 address is available.

Since: 0.9

uint16_t SrvGetIPPort ( LibTiePieHandle_t hServer )

Get the IP port number of the specified network instrument or instrument server.

Parameters

[in] hServer A server handle identifying the server.

Returns: The IP port number of the device, or zero if no IP port number is available.

Since: 0.9

uint32_t SrvGetName	(	LibTiePieHandle_t	hServer,
		char *	pBuffer,
		uint32_t	dwBufferLength
	)

Get the name of the specified network instrument or instrument server.

Parameters

[in]	hServer	A server handle identifying the server.
[out]	pBuffer	A pointer to a buffer for the name.
[in]	dwBufferLength	The length of the buffer, in bytes.

Returns: The length of the name in bytes, excluding terminating zero.

Since: 0.9

uint32_t SrvGetDescription	(	LibTiePieHandle_t	hServer,
		char *	pBuffer,
		uint32_t	dwBufferLength
	)

Get the description of the specified network instrument or instrument server.

Parameters

[in]	hServer	A server handle identifying the server.
[out]	pBuffer	A pointer to a buffer for the description.
[in]	dwBufferLength	The length of the buffer, in bytes.

Returns: The length of the description in bytes, excluding terminating zero.

Since: 0.9

TpVersion_t SrvGetVersion ( LibTiePieHandle_t hServer )

Get the software version number of the specified network instrument or instrument server.

Parameters

[in] hServer A server handle identifying the server.

Returns: The software version number of the server, or zero if no software version is available.

Since: 0.9

uint32_t SrvGetVersionExtra	(	LibTiePieHandle_t	hServer,
		char *	pBuffer,
		uint32_t	dwBufferLength
	)

Get the software version postfix of the specified network instrument or instrument server.

Parameters

[in]	hServer	A server handle identifying the server.
[out]	pBuffer	A pointer to a buffer for the software version postfix.
[in]	dwBufferLength	The length of the buffer, in bytes.

Returns: The length of the software version postfix in bytes, excluding terminating zero.

Since: 0.9