Release Profile Handle (QSYRLSPH, QsyReleaseProfileHandle) API

Required Parameter Group for QSYRLSPH:

Profile handle

Input

Char(12)

Optional Parameter for QSYRLSPH:

Error code

I/O

Char(*)

Default Public Authority: *USE

Threadsafe: Yes

Syntax for QsyReleaseProfileHandle:

 #include <qsyphandle.h>

 void QsyReleaseProfileHandle
            (unsigned char * Profile_handle,        
             void          * Error_code);

  Service Program: QSYPHANDLE

  Default Public Authority: *USE

  Threadsafe: Yes

The Release Profile Handle (OPM, QSYRLSPH; ILE, QsyReleaseProfileHandle) API validates a given profile handle and then releases it. To use the user profile represented by the deleted profile handle in the job again, you must call the Get Profile Handle (QSYGETPH, QsyGetProfileHandle) API to generate a new profile handle for the user profile.

Your application must perform any needed cleanup work like closing files and deallocating objects. The Release Profile Handle API only releases the profile handle; it does not perform any cleanup in the job.

Authorities and Locks

None.

Required Parameter

Profile handle: INPUT; CHAR(12)
The profile handle to be released.

Optional Parameter

Error code

I/O; CHAR(*)

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

This parameter is optional for QSYRLSPH API and is omissable for the QsyReleaseProfileHandle API.

Usage Notes

If the profile handle to be released is not valid (for example, the profile handle was not generated in this job or had previously been released), the call to this API will not fail. Message CPF22E7 (ProfileHandle is not valid) will be in the joblog as a diagnostic message.

Error Messages

Message ID	Error Message Text
CPF2225 E	Not able to allocate internal system object.
CPF3C90 E	Literal value cannot be changed.
CPF3CF1 E	Error code parameter not valid.
CPF9872 E	Program or service program &1 in library &2 ended. Reason code &3.

API introduced: V2R1

[ Back to top | Security APIs | APIs by category ]