Create a new Group File (QzhbCreateGroupList) API

In the IBM® HTTP Server for i, use the QzhbCreateGroupList() API to create a new empty group file, and return a handle to that empty in-memory version of the file.

Required Parameter Group:
1 path Input Binary(4)
2 path_len Input Binary(4)
3 grplist Output Binary(4)
4 errcode I/O Char(*)
Threadsafe: Yes

Normally this API would be followed by calls to the QzhbAddGroupToList() and QzhbAddUserToGroup() APIs, followed by the QzhbCloseGroupList() API to write group information out.

Upon successful completion of this API, a new group list handle is returned. This is a handle much like the one returned by the QzhbOpenGroupList() API against an already existing file, with a writelock argument of 1 (TRUE). After a call to the QzhbCreateGroupList() API the new file is left open for write access and the QzhbCloseGroupList() API can be invoked with a write argument of 1. For more details about the writelock argument, see Read a Group File into Memory (QzhbOpenGroupList) API.

Authorities and locks

  • *X authority to each directory in the path of the specified group file
  • *WX authority to the last directory in the path that will contain the group file path

Required parameter group

path
INPUT:BINARY(4)

The path to the group file to be created in the Integrated File System. You can specify an absolute or relative path to the working directory. This path should be in the job CCSID.

path_len
INPUT:BINARY(4)

The length of the path string.

grplist
OUTPUT:BINARY(4)

The variable that receives the integer handle of the newly created empty group list. Subsequent API calls use this handle.

errcode
I/O:CHAR(*)

The structure in which to return error information.

Error messages

CPF3CF1 E
Error code parameter not valid.
CPF3C1D E
Input variable length in parameter &1 not valid.
HTPA001 E
Input parameter &1 not valid.
HTPA202 E
Unable to update group file &1.
HTPA208 E
Group file &1 already exists.