Intel 05-1832-002 User Manual

Page of 564
270
Voice API for Windows Operating Systems Library Reference — November 2003
dx_gtsernum( ) — retrieve the board serial number
dx_gtsernum( )
retrieve the board serial number
!
!
!
Description
The dx_gtsernum( ) function returns the board serial number, either the standard serial number or 
the silicon serial number, where supported. When available, the silicon serial number is the 
preferred method for uniquely identifying boards. 
The board serial number consists of eight ASCII characters and is printed on the serial number 
sticker on the board. The silicon serial number consists of an additional six-byte serial number 
encoded into the board and can include non-printable characters. 
The serial number and silicon serial number can be used for developing software security in an 
application program. For example, an application program can be “locked” to an Intel® telecom 
board as part of the application installation procedure, by getting and saving the serial number in a 
secure place within the application. From then on, when the application is executed, it can check 
for the presence of the board and match it with the board serial number secured within the 
application program.
Name:
int dx_gtsernum (devd, subfcn, buffp )
Inputs:
int devd
valid board device handle
int subfcn
sub-function
void *buffp
pointer to buffer for returned serial number
Returns:
0 if success
-1 if failure
Includes:
srllib.h
dxxxlib.h
Category:
Configuration
Mode:
synchronous
Platform:
DM3, Springware
Parameter
Description
devd 
specifies a valid board device handle
subfcn 
specifies one of the following sub-functions:
GS_SN – returns the standard board serial number, consisting of eight 
ASCII characters followed by a NULL byte. This number is printed on the 
serial number sticker attached to the board.
GS_SSN – returns the board silicon serial number (if supported), consisting 
of six bytes of any value, including 0x00. An EDX_BADPROD error is 
returned if the specified board does not support the silicon serial number.
buffp 
pointer to buffer where the serial number is returned