Export LDIF File (QgldExportLdif)

Required Parameter Group: 1 Input data Input Char(*) 2 Length of input data Input Binary(4) 3 Format name Input Char(8) 4 Error code I/O Char(*) Threadsafe: No

The Export LDIF File (QgldExportLdif) API exports the directory server contents to a Lightweight Directory Access Protocol Data Interchange Format (LDIF) file.

or provide the correct administrator DN and password.

Directory Authority

The caller must provide the administrator DN and password if the caller does not have *ALLOBJ and *IOSYSCFG special authorities.

Object Authorities

The caller must have Execute (*X) authority to each directory in the path name preceding the name of the LDIF file.

The caller must have Write (*W) authority to the LDIF file.

Required Parameter Group

Input data

INPUT; CHAR(*)

Input data required to identify the LDIF file and the administrator name and password. The content and format of this structure are determined by the format name. See Format of Input Data for a description of these formats.

Length of input data

INPUT; BINARY(4)

The length of the input data structure.

Format name

INPUT; CHAR(8)

The content and format of the input data. The possible format name follows:

LDIF0100

Export LDIF file.

See Format of Input Data for a description of this format.

Error code

I/O; CHAR(*)

The structure in which to return error information. For the format of the structure, see Error Code Parameter.

Format of Input Data

For details about the format of the input data, see the following section. For details about the fields in each format, see Field Descriptions.

LDIF0100 Format

Field Descriptions

Administrator DN. The distinguished name of the server administrator. This field is specified in UCS-2 (CCSID 13488).

Administrator password. The password for the server administrator. This field is specified in UCS-2 (CCSID 13488).

LDIF file. The integrated file system path name of the LDIF file to be used. This field is specified in UCS-2 (CCSID 13488).

Length of administrator DN. The length, in Unicode characters, of the administrator DN field.

Length of administrator password. The length, in Unicode characters, of the administrator password field.

Length of LDIF file. The length, in Unicode characters, of the LDIF file field.

Length of subtree DN. The length, in Unicode characters, of the subtree DN field.

Offset to administrator DN. The offset, in bytes, from the start of the input data to the administrator DN field.

Offset to administrator password. The offset, in bytes, from the start of the input data to the administrator password field.

Offset to LDIF file. The offset, in bytes, from the start of the input data to the LDIF file field.

Offset to subtree DN. The offset, in bytes, from the start of the input data to the subtree DN field.

Subtree DN. The distinguished name (DN) of the root of a directory subtree to export to the LDIF file. This object, and all descendant objects will be exported. To export the entire directory tree, specify 0 (zero) for the offset to subtree DN and length of subtree DN fields. This field is specified in UCS-2 (CCSID 13488).

Error Messages

GLD0202 E

Administrator DN or password not correct.

GLD0213 E

Error opening or creating file.

GLD0215 E

Server has not been configured.

GLD0218 E

*ALLOBJ and *IOSYSCFG special authorities required.

GLD022B E

Can not find object &1.