Here is an example of a call to the FREE command:
GIMAPI('FREE ',0,0,'ENU',rc,cc,msgbuff)
- FREE
- is a keyword that specifies that GIMAPI is to process a free
request. Note that it is necessary to pad the string containing the
FREE command with blanks to bring it to a length of eight characters.
- 0,0
- The parmptr and outptr parameters must both
be set to zero (0) on the FREE command.
- ENU
- The language parameter must be specified as either
ENU, JPN, or three blanks. The FREE command does not return any messages,
so it does not matter which of these choices is specified.
- rc
- A storage area owned by the calling program representing a 4-byte
numeric variable. This variable will contain the return code for the
FREE command. GIMAPI will always set this variable to zero (0) after
processing the FREE command.
- cc
- A storage area owned by the calling program representing a 4-byte
numeric variable. This variable will contain the condition code for
the FREE command. GIMAPI will always set this variable to zero (0)
after processing the FREE command.
- msgbuff
- A pointer variable. No messages are issued by the FREE command,
but this pointer variable must be passed to GIMAPI.
The parmptr, outptr, language, rc, cc, and msgbuff parameters must all be specified on
the GIMAPI call, even though none of these parameters are used by
the FREE command.