|
The function synopses indicate how to call library functions. Information about required argument types and function result types is presented in the form of a C function declaration prefixed by #include statements indicating which headers, if any, must be used to access the function.
function-name
header file reference
function prototype
|
flags
|
minimum stack space used
|
function description
|
|
|
function-name
|
the name of the function
|
|
header file reference
|
an example showing how to include the relevant header file
|
|
function prototype
|
a prototype showing the function return type and any arguments
|
|
function description
|
a discussion of what the function does
|
|
flags
|
an indication of constraints on the use of the function. There are currently two flags: stand-alone and server. A function marked stand-alone my be used in stand-alone tasks. One marked server needs to access the host server and so cannot be used in stand-alone tasks.
|
|
minimum stack space used
|
an estimate in bytes of the minimum amount of stack space that is needed by a typical call; no value means that the function has a minimal stack requirement (less than 64 bytes).
Please note that this is a minimum; some functions may exceed this when given particular arguments.
|
|