LibTiePie  0.4.1
Library for interfacing TiePie engineering instruments
 All Files Functions Typedefs Groups Pages
Library

Functions

TpVersion_t LibGetVersion ()
 Get library version number.
 
uint32_t LibGetConfig (uint8_t *pBuffer, uint32_t dwBufferLength)
 Get library configuration number.
 
LibTiePieStatus_t LibGetLastStatus ()
 Get last status value, last status is set after each call to the library.
 
const char * LibGetLastStatusStr ()
 Get last status value as text, last status is set after each call to the library.
 

Detailed Description

Function Documentation

uint32_t LibGetConfig ( uint8_t *  pBuffer,
uint32_t  dwBufferLength 
)

Get library configuration number.

Example:

uint32_t dwLength = LibGetConfig( NULL , 0 );
uint8_t Buffer[ dwLength ];
dwLength = LibGetConfig( Buffer , dwLength );
printf( "LibGetConfig = 0x" );
for( uint32_t i = 0 ; i < dwLength ; i++ )
printf( "%02x" , Buffer[ i ] );
printf( "\n" );
Parameters
pBuffer
dwBufferLength
Returns
Config number length.
LibTiePieStatus_t LibGetLastStatus ( )

Get last status value, last status is set after each call to the library.

Example:

printf( "LibGetLastStatus = %d\n" , LibGetLastStatus() );
Returns
Status code.
See Also
LibGetLastStatusStr
const char* LibGetLastStatusStr ( )

Get last status value as text, last status is set after each call to the library.

Example:

printf( "LibGetLastStatusStr = %s\n" , LibGetLastStatusStr() );
Returns
Status code as text.
See Also
LibGetLastStatus
TpVersion_t LibGetVersion ( )

Get library version number.

Example:

uint16_t wMajor = TPVERSION_MAJOR( Version );
uint16_t wMinor = TPVERSION_MINOR( Version );
uint16_t wRelease = TPVERSION_RELEASE( Version );
uint16_t wBuild = TPVERSION_BUILD( Version );
printf( "LibGetVersion = %u.%u.%u.%u\n" , wMajor , wMinor , wRelease , wBuild );
Returns
Library version number.