UDF_VFREE UDF IDL INTERFACE MANUAL UDF_VFREE
NAME
UDF_VFREE
USAGE
vS =  UDF_VFREE, fh, Item, dN
INPUT DEFINITIONS
fh - Index into the information array to the UDF for which the VIDF memory area is being freed. fh is the return value obtained from the call to UDF_OPEN for this UDF source.
Item - String input which specifies what memory block is to be freed The valid options are:
ALL - Frees all string and data memory malloced in reading the VIDF file.
ALLSTRINGS - Frees all string memory malloced in reading the VIDF file.
BODY - Frees all string memory malloced when parsing the body of the VIDF.
TABLERAW - Frees all string memory malloced when parsing the dNth VIDF table definition when returning RAW table information.
TABLECOOKED - Frees all string memory malloced when parsing the dNth VIDF table definition when returning COOKED table information.
CONSTANTRAW - Frees all string memory malloced when parsing the dNth VIDF constant definition when returning RAW constant information.
CONSTANTCOOKED - Frees all string memory malloced when parsing the dNth VIDF constant definition when returning COOKED constant information.
dN - The table or constant definition number to use when returning freeing memory associated with a specific table or constant acquisition. This value is not used when Item is set to ALL, ALLSTRINGS, or BODY and need not be included in the call in any of those instances.
RETURN DEFINITION
None.
DESCRIPTION
UDF_VFREE() frees part or all of the memory malloced when parsing the VIDF file associated with the UDF linked to the fh value established in a call to UDF_OPEN. If Item is set to 'ALL' then all of the memory associated with the VIDF is freed otherwise just memory malloced to hold various string fields is freed. Setting Item to 'ALLSTRINGS' frees all string memory, otherwise it is freed by the Item option under which it was allocated.

ERRORS
NONE
APPLICABLE FORMATS
UDF V2.2, V2.1, IDFS V2.1
RESTRICTIONS
None.
SEE ALSO
UDF_VIDF
Mar 12, 2007
&larr Previous TOC HOME Next &rarr
UDF_VIDF KeyWords