FILEINFO$() File Information Function

FILEINFO$ Function Documentation

FILEINFO$ Function

The FILEINFO$ function parses a file specification and returns either a full file specification or specific file specification fields.

Syntax

FILEINFO$(str_expr1 [, str_expr2 [, str_expr3]])

Parameters

• str_expr1 - The file specification to be parsed. If no file specification is given, the device and directory you are currently running from are returned.
• str_expr2 - A list of field names, separated by commas, which are to be returned. The field names are:
  • CONTENTS - File contents
  • DEVICE - Drive name
  • DIRECTORY - Directory name
  • NAME - File name
  • TYPE - Type or extension name
  • LOCATION - Device and directory names
  • BACKUP_DATE - Last file backup date
  • CREATION_DATE - Date file was created
  • EXPIRATION_DATE - File expiration date
  • REVISION_DATE - Date file was last modified
  • REVISION - The number of times a given file has been revised (given that the underlying OS supports this)
  • SIZE - The size of the file in bytes
  • ALL or "" - Full file specification
• str_expr3 - The default file specification. This parameter is optional.

Examples

Basic Usage of FILEINFO$

    print fileinfo$('x.y', 'ALL') 
    print fileinfo$('', 'ALL') 
    print fileinfo$('@config.ini', 'ALL')  // Relative to program directory

    end
    

Output:

    c:\Sheerpower\x.y 
    c:\Sheerpower 
    (The '@' example will output the full path to config.ini in your program's directory)
    

Using Default File Specification

    x$ = 'Sheerpower:samples\client' 
    print fileinfo$(x$, 'ALL', '.ars') 
    end
    

Output:

    c:\Sheerpower\samples\client.ars 
    

Various Field Names

    print fileinfo$('Sheerpower:samples\client', 'all', '.ars') 
    print fileinfo$('Sheerpower:samples\client', 'location') 
    print fileinfo$('Sheerpower:samples\client', 'location, name') 
    print fileinfo$('Sheerpower:samples\client.ars') 
    end
    

Output:

    c:\Sheerpower\samples\client.ars 
    c:\Sheerpower\samples\ 
    c:\Sheerpower\samples\client 
    c:\Sheerpower\samples\client.ars 
    

FILEINFO$ Contents Option

The CONTENTS option of FILEINFO$ returns the entire contents of the file 'some_file.xxx' into all_of_file$. If the file cannot be found, then it returns a null string. A zero-length file will also return a null string.

FORMAT

    all_of_file$ = fileinfo$('some_file.xxx', 'contents') 
    

Using FILEINFO$ to Retrieve File Contents

    all_of_file$ = fileinfo$('Sheerpower:Sheerpower.ini', 'contents') 
    print all_of_file$ 
    
    end
    

Output:

    [license] 
    LicenseKey=xxx-xxx-xxx-xxx
    Username=non-commercial 
    EmailAddress=non-commercial 
    

Copy a File with FILEINFO$ CONTENTS

    sourcefile$ = 'source.xxx' 
    destfile$   = 'destination.xxx' 
    contents$   = fileinfo$(sourcefile$, 'contents') 
    open file dest_ch: name destfile$, access output, unformatted
    print #dest_ch: contents$ 
    close #dest_ch 
    end