FREE—Free an SCLM ID

The FREE service frees an SCLM ID generated by the INIT service. Each INIT service invocation needs a matching FREE service invocation. After freeing the SCLM ID, SCLM closes all project data sets and frees the project definition specified on the INIT service.

Command invocation format

You cannot use command procedures to call this service.

Call invocation format


>>-lastrc--:=--FLMLNK('FREEbbbb',sclm_id--,msg_line);----------><

Parameters

sclm_id: The SCLM ID to be freed. The INIT service must generate the SCLM ID. The maximum parameter length is 8 characters.
msg_line: An output parameter that is a buffer containing any FREE service error message. The maximum parameter length is 80 characters.

Return codes

Additional special services messages are written to the FLMMSGS ddname. See SCLM service messages for more information.

Other return codes might be produced by the FLMLNK processor.

Possible return codes are:

0: Normal completion.
8: Error condition. See the msg_line parameter description for more details.

Example of call invocation

This example shows general syntax. Call invocations are language-specific. See Sample programs using SCLM services for specific examples.

lastrc := FLMLNK('FREE    ',        (* service        *)
                  sclm_id,          (* SCLM ID        *)
                  msg_line);        (* error messages *)

This service call frees the SCLM ID identified by the sclm_id parameter. The sclm_id parameter contains a valid SCLM ID returned from the INIT service. SCLM returns messages in the msg_line parameter.