Understanding The Function Descriptions; Function_Name - Intermec 5055 Reference Manual

This chapter describes the syntax and parameters for each function in the 5055
Programmer's Software Kit (PSK) library.

Understanding the Function Descriptions

The function descriptions in this chapter use these conventions:
•
•
•
•
•
The following example (function_name) explains the parts of the function descriptions.

function_name

Purpose: Briefly describes the function and its typical use.
Syntax: Lists the C-language function prototype and the required include file.
IN Parameters: Describes the input parameters for the function and lists acceptable values.
OUT Parameters: Describes the output parameters for the function and lists acceptable values.
IN/OUT Describes the parameters that are passed into and then back out of the function.
Parameters: Lists acceptable values. The function usually changes the value before returning.
Return Value: Describes the value returned by the function and lists acceptable values.
Notes: Describes any additional information about the function.
See Also: Lists similar PSK functions.
Example
/* A short code segment showing how to use the function.
The descriptions refer to many named constant variables, such as IM_COM1. These
variables always appear in uppercase and are described in IM5055.H.
The descriptions use common C/C++ notation.
Italic type indicates a variable that you replace with a real value.
Straight quotation marks (" ") indicate literal string entries. Include the quotation
marks in the command, such as: char *high_trast ="$+DJ7";
You can indent program statements with leading spaces to make your program
easier to read.
C/C++ is case sensitive. Follow the capitalization used in the descriptions.
5
function_name
*/
5-3