Free Group File from Memory (QzhbCloseGroupList) API
Required Parameter Group:
1 grplist Input Binary(4)
2 write Input Binary(4)
3 errcode I/O Char(*)
Threadsafe: Yes
Use the QzhbCloseGroupList API to free the memory of an in-memory copy of a
group file. You can optionally write the in-memory version of the grouplist back
to the group file before the memory is freed.
Authorities and locks
None.
Required parameter group
grplist
INPUT:BINARY(4)
The group list handle returned from a call to the QzhbCreateGroupList API or
QzhbOpenGroupList API.
write
INPUT:BINARY(4)
The value of 0 (false) or a value of 1 (true), indicating whether or not to write
the contents of the in-memory group list back to the group file before freeing it
from memory. If you specify 1 for this parameter, and the write fails, the
memory is not freed and the grplist handle is still valid.
Note: In order to specify a write value of 1, you must have previously used
either the QzhbCreateConfigList API or specified a writelock of 1 on the
QzhbOpenGroupList API. If these conditions are not met, the contents of
the file are not written.
errcode
I/O:CHAR(*)
The structure in which to return error information.
Error messages
CPF3CF1 E
Error code parameter not valid.
HTPA001 E
Input parameter &1 not valid.
HTPA202 E
Unable to update group file &1.
HTPA203 E
Input group list handle in parameter &1 not valid.
Chapter2. Application Programming Interfaces 67