Guardian Procedure Calls Reference Manual

SEGMENT_GETBACKUPINFO_ Procedure
Summary
Syntax for TAL Programmers
Parameters
Returned Value
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
error := SEGMENT_GETBACKUPINFO_ ( segment-id ! i
,[ segment-size ] ! o
,[ filename:maxlen ] ! o:i
,[ filename-len ] ! o
,[ error-detail ] ! o
,[ base-address ] ); ! o
Parameters
segment-id
input
INT:value
specifies the segment ID of the extended segment for which information is to be returned.
segment-size
output
INT(32) .EXT:ref:1
returns the current size in bytes of the specified segment. The size might be rounded up from
what was specified when the segment was allocated.
filename:maxlen
output:input
STRING .EXT:ref:*, INT:value
if present and maxlen is not 0, returns the fully qualified name of the segment's swap file.
If the segment is managed by the Kernel-Managed Swap Facility (KMSF), filename is
undefined. For more information on KMSF, see the Kernel-Managed Swap Facility (KMSF)
Manual.
maxlen specifies the length in bytes of the string variable filename.
filename-len
output
INT .EXT:ref:1
returns the length in bytes of the swap-file name being returned.
If the segment is managed by the Kernel-Managed Swap Facility (KMSF), filename-len is
set to 0. For more information on KMSF see the Kernel-Managed Swap Facility (KMSF) Manual.
error-detail
output
INT .EXT:ref:1
returns additional information associated with some errors. See Returned Value.
SEGMENT_GETBACKUPINFO_ Procedure 1285