MAGG IMAGE LOCK

TITLEVALUE
NAMEMAGG IMAGE LOCK
DESCRIPTIONThis remote procedure locks one or more images. If several images are
passed, then either all or none of them are locked.
TAGLOCKIMG
ROUTINEMAGGA04
INPUT PARAMETERSSEQUENCE NUMBER1
INPUT PARAMETERFLAGS
DESCRIPTIONreserved
PARAMETER TYPELITERAL
REQUIRED
MAXIMUM DATA LENGTH
INPUT PARAMETERSSEQUENCE NUMBER2
INPUT PARAMETERIMGLST
DESCRIPTIONList of images that have to be locked. Images are referenced by their
internal entry numbers (IENs) in the IMAGE (#2005) and IMAGE AUDIT
(#2005.1) files.

Example:

with RPCBroker.Param[1] do
begin
PType := list;
Mult[1] := '234';
Mult[2] := '789';
end;
PARAMETER TYPELIST
REQUIREDYES
MAXIMUM DATA LENGTH
RETURN VALUE TYPEARRAY
RETURN PARAMETER DESCRIPTIONZero value of the first '^'-piece of the Results[0] indicates that an
error occurred during the execution of the procedure. In this case, the
errors are returned in the Results array as shown below:

Results[0] Result descriptor
^01: 0
^02: Message

Results[i] Error descriptor
^01: Error code
^02: Message
^03: Error location
^04: Message type

Results[j] Line of the additional info (optional)
^01: ""
^02: Text

If the error descriptor in the Results[1] has the error code -21, this
means that the RPC could not lock the image(s). A message that explains
who/what locked the image(s) and when this happened is attached to this
error as additional information. Example:

Results[0]='0^The image is locked by other user/task.
Please try later.'
Results[1]='-21^The image is locked by other user/task.
Please try later.^LOCKFM+11~MAGGA04^W'
Results[2]='^Locked by IMAGEUSER,ONE about Feb 17, 2009@13:21:54;
Job #5728'

In case of a successful lock, '1^Ok' is returned in the Results[0].
AVAILABILITYRESTRICTED
INACTIVE
CLIENT MANAGER
WORD WRAP ONTRUE
VERSION
SUPPRESS RDV USER SETUP
APP PROXY ALLOWED