UNLOCK—Unlock a Member in a Development Library

The UNLOCK service makes a locked member available for updates by another user. If an access key was assigned to the member when it was locked, the UNLOCK service resets the access key to blank.

If SAVE or STORE completes successfully for a member and that member has an access key, you can reset the access key by calling the UNLOCK service.

Before you can promote a member, you must call the UNLOCK service to remove its access key. The PROMOTE service does not promote any member that has an access key. For more information about the LOCK service and access keys, see LOCK—Lock a Member or Assign an Access Key.

Command invocation format


>>-FLMCMD--UNLOCK,project--,-+---------+--,group--,type--------->
                             '-prj_def-'                  

>--,member--,-+------------+-----------------------------------><
              '-access_key-'

Call invocation format


>>-lastrc--:=--FLMLNK('UNLOCKbb',sclm_id--,group--,type--------->

>--,member--,-+-access_key-+--,$msg_array);--------------------><
              '-'--'-------'

ISPF interface panel

Figure 1. UNLOCK Service panel

   Menu  SCLM  Utilities  Help
 ──────────────────────────────────────────────────────────────────────────────
                    SCLM FLMCMD UNLOCK Service - Entry Panel

 SCLM Library:
    Project . . . SCLMTEST
    Alternate . .         
    Group . . . . DEV1    
    Type  . . . . SOURCE  
    Member  . . .                  (Blank or pattern for member selection list)

 Access key  . . . . . .                 









 Command ===>                                                                  
  F1=HELP      F2=          F3=END       F4=DATASETS  F5=FIND      F6=CHANGE
  F9=SWAP     F10=LEFT     F11=RIGHT    F12=SUBMIT

Parameters

project: The project name. The maximum parameter length is 8 characters. This parameter is used for FLMCMD only.
prj_def: The project definition name to be used for the unlock. It defaults to project. The maximum parameter length is 8 characters. This parameter is used for FLMCMD only.
sclm_id: An SCLM ID associated with a given project and project definition. The INIT service generates the SCLM ID. The maximum parameter length is 8 characters. This parameter is used for FLMLNK only.
group: The group in which the member is to be unlocked. The specified group must be a development library. The maximum parameter length is 8 characters.
type: The type containing the member to be unlocked. The maximum parameter length is 8 characters.
member: The member to be unlocked. The maximum parameter length is 8 characters.
access_key: The access key assigned (with the LOCK or SAVE service) to the member. If you supply an incorrect access key, the unlock fails. The maximum parameter length is 16 characters.
For the FLMCMD format, the default is blank. For the FLMLNK format, you MUST specify an access key parameter. If you do not want to specify an access key on the FLMLNK, you must pass blanks as the parameter value.
$msg_array: An output parameter pointing to the message array. See Pointer parameter descriptions for more information about $msg_array. This parameter is used for FLMLNK only.

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 FLMCMD or the FLMLNK processor. See SCLM service return codes for more information.

Possible return codes are:

0: Normal completion.
4: Warning condition. The $msg_array parameter determines the location of this message array.
8: Error condition. The $msg_array parameter contains the error message associated with this condition.

Example of command invocation

FLMCMD UNLOCK,PROJ1,,USER1,SOURCE,FLM01MD1,XXX#05

This service command unlocks the FLM01MD1 member of the SOURCE type in the USER1 group. The project name is PROJ1. The access key value for the member is XXX#05.

Example of call invocation

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

lastrc := FLMLNK('UNLOCK  ',             (* service               *)
                   sclm_id,              (* SCLM ID               *)
                   'USER1   ',           (* group                 *)
                   'SOURCE  ',           (* type                  *)
                   'FLM01MD1',           (* member                *)
                   'XXX#05          ',   (* access key            *)
                   $msg_array);          (* message array pointer *)

This service call unlocks the FLM01MD1 member of the SOURCE type in the USER1 group. The sclm_id parameter contains a valid SCLM ID returned from the INIT service. The access key value for the member is XXX#05. SCLM returns all messages in the $msg_array parameter.