CLOSE_FILE

An application uses this verb to release its handle to the domain configuration file, or to the sna.net file,when it has finished issuing NOF verbs to the file. The file which the application wishes to close is identified by the target_handle parameter on the call.

The application should always issue CLOSE_FILE for any open file handles before it exits. After the verb completes successfully, the target handle identifying the file is no longer valid.

This verb must be issued to the domain configuration fileor to the sna.net file.

VCB Structure

typedef struct close_file { AP_UINT16 opcode; /* verb operation code */ unsigned char reserv2 /* reserved */ unsigned char format; /* reserved */ AP_UINT16 primary_rc; /* primary return code */ AP_UINT32 secondary_rc; /* secondary return code */ } CLOSE_FILE;

Supplied Parameters

The application supplies the following parameters:

opcode

AP_CLOSE_FILE

Returned Parameters: Successful Execution

If the verb executes successfully, SNAplus2 returns the following parameters:

primary_rc

AP_OK

secondary_rc

Not used.

Returned Parameters: State Check

If the verb does not execute because of a state check, SNAplus2 returns the following parameters:

primary_rc

AP_STATE_CHECK

secondary_rc

AP_VERB_IN_PROGRESS

The specified file cannot be released because a previous verb issued for this target handle is still outstanding. All verbs for the target file must be completed before attempting to close the file.

Appendix A “Common Return Codes” lists further secondary return codes associated with AP_STATE_CHECK, which are common to all NOF verbs.

Returned Parameters: Other Conditions

Appendix A “Common Return Codes” lists further combinations of primary and secondary return codes that are common to all NOF verbs.