Home
Manual
Packages
Global Index
Keywords
Quick Reference
|
functions in yeti_yhdf.i - y
yhd_check
|
yhd_check(file);
-or- yhd_check(file, version, date, encoding, comment);
Return 1 (true) if FILE is a valid YHD file; otherwise return 0
(false). The nature of FILE is guessed by reading its header. Input
argument FILE can be a file name (scalar string) of a binary file
stream opened for reading; all other arguments are pure outputs and
may be omitted (if result is false, the contents of these outputs is
undetermined).
interpreted function, defined at contrib/yeti_yhdf.i line 273
|
SEE
|
ALSO,
yhd_info,,
yhd_save,,
yhd_restore.
|
yhd_info
|
yhd_info, file;
Print out some information about YHD file. FILE can be a file
name (scalar string) of a binary file stream opened for reading.
interpreted function, defined at contrib/yeti_yhdf.i line 315
|
SEE
|
ALSO,
yhd_check,,
yhd_restore,,
yhd_save.
|
yhd_restore
|
yhd_restore(filename);
-or- yhd_restore(filename, keylist, ...);
Restore and return hash table object saved in YHD file FILENAME. If
additional arguments are provided, they are the names of members to
restore. The default is to restore every member.
interpreted function, defined at contrib/yeti_yhdf.i line 331
|
SEE
|
ALSO,
yhd_check,,
yhd_info,,
yhd_save.
|
yhd_save
|
yhd_save, filename, obj;
-or- yhd_save, filename, obj, keylist, ...;
Save contents of hash object OBJ into the Yeti Hierarchical Data (YHD)
file FILENAME. If additional arguments are provided, they are the
names of members to save. The default is to save every member.
Keyword COMMENT can be used to store a (short) string comment in the
file header. The comment is truncated if it is too long (more than
about 130 bytes) to fit into the header. COMMENT must not contain
any DEL (octal 177) character.
Keyword ENCODING can be used to specify a particular binary data
format for the file; ENCODING can be the name of some known data
format (see get_encoding) or an array of 32 integers (see
set_primitives). The default is to use the native data format.
If keyword OVERWRITE is true and file FILENAME already exists, the new
file will (silently) overwrite the old one; othwerwise, file FILENAME
must not already exists (defalut behaviour).
interpreted function, defined at contrib/yeti_yhdf.i line 34
|
SEE
|
ALSO
|
|