The IDL_Savefile::Contents function method returns a structure variable of type IDL_SAVEFILE_CONTENTS containing information about the associated SAVE file and its contents.
Syntax
Result = Obj->[IDL_Savefile::]Contents()
Return Value
Returns a structure variable of type IDL_SAVEFILE_CONTENTS containing information about the associated SAVE file and its contents. The structure contains the following fields:
|
Field |
Type |
Description |
|
FILENAME |
String
|
The file path to the open SAVE file.
|
|
DESCRIPTION |
String
|
A user-supplied description string for the SAVE file, as specified using the DESCRIPTION keyword to the SAVE procedure. If the SAVE file lacks a user supplied description, this field contains an empty string.
|
|
FILETYPE |
String
|
A description of SAVE file type. For a standard SAVE file, this field will contain the string “Portable (XDR)”. For a compressed SAVE file, this field will contain “Portable (XDR) compressed”.
|
|
USER |
String
|
The user name of the user who issued the SAVE command that created the SAVE file.
|
|
HOST |
String
|
The name of the computer on which the SAVE file was created.
|
|
DATE |
String
|
The date on which the SAVE file was created.
|
|
ARCH |
String
|
The value of the !VERSION.ARCH system variable field of the IDL installation that created the SAVE file.
|
|
OS |
String
|
The value of the !VERSION.OS system variable field of the IDL installation that created the SAVE file.
|
|
RELEASE |
String
|
The value of the !VERSION.RELEASE system variable field of the IDL installation that created the SAVE file.
|
|
N_COMMON |
Integer |
The number of main-level common blocks contained in the SAVE file.
|
|
N_VAR |
Integer |
The number of variables contained in the SAVE file.
|
|
N_SYSVAR |
Integer |
The number of system variables contained in the SAVE file.
|
|
N_PROCEDURE |
Integer |
The number of procedures contained in the SAVE file.
|
|
N_FUNCTION |
Integer |
The number of functions contained in the SAVE file.
|
|
N_OBJECT_HEAPVAR
|
Integer |
The number of object heap variables contained in the SAVE file.
|
|
N_POINTER_HEAPVAR
|
Integer |
The number of pointer heap variables contained in the SAVE file.
|
|
N_STRUCTDEF |
Integer |
The number of named structure definitions contained in the SAVE file. Named structure definitions are saved when a variable that references them is saved.
|
Arguments
None.
Keywords
None.
Example
See Example.
Version History