|
|||||
|
||||||
Other Library Functions |
function |
vfsDescribe |
Library: File system utilities (OMVFS legacy)
Include: omvfs.xin |
define external function vfsDescribe value stream path into modifiable stream attributes or define external function vfsDescribe value stream filename-URL on value vfsDir dir into modifiable stream attributes
Argument definitions
Use vfsDescribe to obtain a description of a file or a directory.
You must include the following line at the beginning of your OmniMark program:
include "omvfs.xin"
path must:
filename-URL must:
The vfsDir object dir must:
The attributes shelf returned by this function contains the following keyed items.
If the drive containing the file or directory being described is a read-only drive (for example, a CD-ROM), the atime may be zero.
The attributes shelf is initially cleared of all contents.
If a particular attribute item is not supported by a virtual file system protocol , it is returned as an empty string.
External exception VFS300 is thrown for any general OS operation failure. The text accompanying the exception will contain details on the reason for the failure.
External exception VFS111 is thrown if an URL supplied as a parameter to this function contains invalid encoding.
External exception VFS004 is thrown if the URL exceeds system length limits.
For complete details on absolute URLs and valid encoding, see Internet Standards RFC 1738: Uniform Resource Locators.
For complete details on relative URLs, see Internet Standards RFC 1808: Relative Uniform Resource Locators.
Obtaining the size of a file
include "omvfs.xin" process local stream attrs variable . vfsDescribe "/programs/myscript.xom" into attrs output attrs {"size"} || "%n"
Copyright © Stilo International plc, 1988-2010.