Micro Focus COBOL Server 2.3 Update 2 for Windows > Enterprise Server > Enterprise Server Security > Using the Security Audit Manager > Audit Manager APIs > Audit File Processing APIs > CBL_AUDIT_FILE_OPEN

CBL_AUDIT_FILE_OPEN

Open an audit file.

Restriction: This topic applies only when the Enterprise Server feature is enabled.

Syntax:

call "CBL_AUDIT_FILE_OPEN" using by value     flags
                                 by reference auditfile-handle
                                 by reference auditfile-name
                                    returning status-code

Parameters:

	Typedef	Picture
flags	cblt-x4-comp5	pic x(4) comp-5
auditfile-handle	cblt-pointer	pointer
auditfile-name	pic x(n)	pic x(n)

On Entry:

flags

Bit	Value	Meaning
0	0	Open the specified audit file
	1	Open the audit file collection for which the specified file is a member
1	0	auditfile-name is space-terminated
	1	auditfile-name is null-terminated
2-31		Reserved for future use (must be 0)

On Exit:

auditfile-handle Audit handle to be specified to the CBL_AUDIT_FILE_READ and CBL_AUDIT_FILE_CLOSE APIs.

Return Codes:

78-AUD-RET-SUCCESS

78-AUD-RET-NOT-ENOUGH-MEMORY

78-AUD-RET-FILE-NOT-EXIST

78-AUD-RET-FILE-NOT-AVAILABLE

78-AUD-RET-FILE-INVALID-FORMAT

78-AUD-RET-FILE-INVALID-NAME

Comments:

CBL_AUDIT_FILE_OPEN() is used to open an audit file, or audit file collection. Only files that are available for dumping will be opened by this API (i.e. files in a collection which are marked as 'dumped' or 'active' will not be opened).

Examples:

copy "mfaudit.cpy ".

01 auditfile-handle  pic x(4) comp-5.
01 auditfile-name    pic x(32)
                     value "mfaudit.nwb-cpjdell.aud_1" & x"00".
01 flags             pic x(4) comp-5.
...
compute flags = 78-AUDITFILE-FLAG-OPEN-COLLECTION b-or
                78-AUDITFILE-FLAG-OPEN-NAME-NULL-TERM

call "CBL_AUDIT_FILE_OPEN" using by value flags
                                 by reference auditfile-handle
                                 by reference auditfile-name
      ...