Guardian Procedure Calls Reference Manual

Syntax for TAL Programmers
! input/output error detail
error := PROCESS_GETPAIRINFO_ ( [ processhandle ] ! i 1
,[ pair:maxlen ] ! i,o:i 2
,[ pair-length ] ! o 3
,[ primary-processhandle ] ! o 4
,[ backup-processhandle ] ! o 5
,[ search-index ] ! i,o 6
,[ ancst-processhandle ] ! o 7
,[ search-nodename:length ] ! i:i 8
,[ options ] ! i 9
,[ ancst:maxlen ] ! i,o:i 10
,[ ancst-length ] ! o 11
,[ error-detail ] ); ! o 12
• The number in the comment after each parameter shows the value assigned to error-detail
when identifying an error on that parameter.
Parameters
processhandle
input
INT .EXT:ref:10
if supplied, is a process handle specifying the process of interest. You can specify either the
primary or backup process when seeking information about a process pair. processhandle
is ignored if the search-index parameter is present.
If processhandle is omitted or null and search-index is not present:
• If pair:maxlen is present, it specifies the process or process pair of interest.
• If pair:maxlen is not present, information is returned for the caller or the process pair
to which the caller belongs.
The null process handle is one which has -1 in each word. For details, see the
PROCESSHANDLE_NULLIT_ Procedure (page 1140). However, [PROCESS_GETPAIRINFO_ also
treats a process handle with -1 in the first word as a null process handle.
pair:maxlen
input, output:input
STRING .EXT:ref:*, INT:value
if present and if maxlen is not 0, supplies or returns the process file name of the process or
process pair of interest.
The presence or absence of the parameters processhandle and search-index determine
whether pair is an output parameter or an input parameter as follows:
If pair is an output parameter:
• maxlen specifies the length of the string variable pair.
• If pair is the name of a named process that is not started, pair is returned as a name
in the form \node.$name (no sequence number is returned)
If pair is an input parameter:
• maxlen specifies the length in bytes of the value supplied in pair.
• If pair is a partially qualified process name, the process name is resolved using the node
name specified in the caller's =_DEFAULTS DEFINE. To resolve the process name using
1046 Guardian Procedure Calls (P)