libtiepie
 All Files Functions Typedefs Groups
Library

Functions

TpVersion_t LibGetVersion ()
uint32_t LibGetConfig (uint8_t *pBuffer, uint32_t dwBufferLength)
LibTiePieStatus_t LibGetLastStatus ()
const char * LibGetLastStatusStr ()

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 current last status value, last status is set after each call to the library.

Example:

printf( "LibGetLastStatus = %d\n" , LibGetLastStatus() );
See also:
Status return codes
LibGetLastStatusStr
Returns:
Status code
const char* LibGetLastStatusStr ( )

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

Example:

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

Get librarty 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