Guardian Procedure Calls Reference Manual (G06.25+)

Guardian Procedure Calls (S)
Guardian Procedure Calls Reference Manual—522629-013
14-29
SEGMENT_GETBACKUPINFO_ Procedure
SEGMENT_GETBACKUPINFO_ Procedure
Summary
Syntax for TAL Programmers
Parameters
Summary
The SEGMENT_GETBACKUPINFO_ procedure retrieves information about an
extended segment that is allocated by the backup process in a named process pair.
Syntax for TAL Programmers
Parameters
error returned value
INT
indicates the outcome of the operation. Returns one of the following values:
0 No error
1 Error occurred when attempting to obtain
filename; error-detail
contains the file-system error number.
2 Parameter error;
error-detail contains the number of the first parameter
found to be in error, where 1 designates the first parameter on the left.
3 Bounds error;
error-detail contains the number of the first parameter
found to be in error, where 1 designates the first parameter on the left.
4
segment-id is out of range.
5
segment-id is in range but not allocated by caller.
6 Information not obtained;
error-detail contains the reason for failure.
segment-id input
INT:value
specifies the segment ID of the extended segment for which information is to be
returned.
error := SEGMENT_GETBACKUPINFO_ ( segment-id ! i
,[ segment-size ] ! o
,[ filename:maxlen ] ! o:i
,[ filename-len ] ! o
,[ error-detail ] ! o
,[ base-address ] ); ! o