LibTiePie  0.9.13
Library for interfacing TiePie engineering instruments
Servers

Description

Modules

 Notifications
 Functions to set notifications that are triggered when the server list is changed.
 

Functions

bool8_t NetSrvAdd (const char *pURL, uint32_t dwURLLength, LibTiePieHandle_t *pHandle)
 Add a server to the list of servers. More...
 
bool8_t NetSrvRemove (const char *pURL, uint32_t dwURLLength, bool8_t bForce)
 Remove a server from the list of servers. More...
 
uint32_t NetSrvGetCount (void)
 Get the number of servers available. More...
 
LibTiePieHandle_t NetSrvGetByIndex (uint32_t dwIndex)
 Get the handle of a server, based on its index in the list of servers. More...
 
LibTiePieHandle_t NetSrvGetByURL (const char *pURL, uint32_t dwURLLength)
 Get the handle of a server, based on its URL. More...
 

Function Documentation

bool8_t NetSrvAdd ( const char *  pURL,
uint32_t  dwURLLength,
LibTiePieHandle_t pHandle 
)

Add a server to the list of servers.

Parameters
[in]pURLPointer to URL character buffer.
[in]dwURLLengthLength of URL buffer or LIBTIEPIE_STRING_LENGTH_NULL_TERMINATED.
[out]pHandleThe handle to the added server or NULL.
Returns
BOOL8_TRUE if added successfully, BOOL8_FALSE otherwise.
Since
0.9
bool8_t NetSrvRemove ( const char *  pURL,
uint32_t  dwURLLength,
bool8_t  bForce 
)

Remove a server from the list of servers.

Parameters
[in]pURLPointer to URL character buffer.
[in]dwURLLengthLength of URL buffer or LIBTIEPIE_STRING_LENGTH_NULL_TERMINATED.
[in]bForceIf BOOL8_TRUE all open devices are closed, if BOOL8_FALSE remove only succeeds if no devices are open.
Returns
BOOL8_TRUE if removed successfully, BOOL8_FALSE otherwise.
Since
0.9
uint32_t NetSrvGetCount ( void  )

Get the number of servers available.

Returns
The number of servers available.
Since
0.9
LibTiePieHandle_t NetSrvGetByIndex ( uint32_t  dwIndex)

Get the handle of a server, based on its index in the list of servers.

Parameters
[in]dwIndexA server index, 0 .. NetSrvGetCount() - 1.
Returns
The handle to the requested server or NULL.
Since
0.9
LibTiePieHandle_t NetSrvGetByURL ( const char *  pURL,
uint32_t  dwURLLength 
)

Get the handle of a server, based on its URL.

Parameters
[in]pURLPointer to URL character buffer.
[in]dwURLLengthLength of URL buffer or LIBTIEPIE_STRING_LENGTH_NULL_TERMINATED.
Returns
The handle to the requested server or NULL.
Since
0.9