Jump to content

File Utilities: Difference between revisions

From EDM2
Line 127: Line 127:
; Code:
; Code:
         public BOOL is_file ( const char * location )
         public BOOL is_file ( const char * location )
==function is_root==
Returns TRUE if the specified location is a root directory.
; Source: pm_fileutils.h:160
; Author: Dmitry A.Steklenev
; Version: 1.0
; Code:
        public BOOL is_root ( const char * location )
==function is_url==
Returns TRUE if the specified location is a URL.
; Source: pm_fileutils.h:151
; Author: Dmitry A.Steklenev
; Version: 1.0
; Code:
        public BOOL is_url ( const char * location )
==function scheme==
Returns the scheme followed by a colon (:) of the specified location.
Returns an empty string if specified location does not contain definition of the url scheme.
'''Note:''' Because the result string always less or is equal to a location string all functions can safely use the same storage area for a location and result.
; Source:  pm_fileutils.h:54
; Author:  Dmitry A.Steklenev
; Version: 1.0
; Code:
        public char * scheme ( char * result ,
                        const char * location ,
                                size_t size )
==function sdecode==
Passed any string value, decode from URL transmission.
'''Note:''' Because the result string always less or is equal to a location string all functions can safely use the same storage area for a location and result.
; Source: pm_fileutils.h:133
; Author: Dmitry A.Steklenev
; Version: 1.0
; Code:
        public char * sdecode ( char * result ,
                        const char * location ,
                        size_t size )

Revision as of 22:07, 19 March 2018

File and directory management functions.

Entity Type Scope Short Description
chdrivedir function public Change current default drive and working directory.
is_dir function public Returns TRUE if the specified location is a directory.
is_file function public Returns TRUE if the specified location is a regular file.
is_root function public Returns TRUE if the specified location is a root directory.
is_url function public Returns TRUE if the specified location is a URL.
scheme function public Returns the scheme followed by a colon (:) of the specified location.
sdecode function public Passed any string value, decode from URL transmission.
sdrive function public Returns the drive letter followed by a colon (:) if a drive is specified in the location.
sdrivedir function public Returns the drive letter or scheme and the path of subdirectories, if any, including the trailing slash.
sfext function public Returns the file name extension, if any, including the leading period (.).
sfextrep function public Replaces an extension of the specified file.
sfname function public Returns the base file name without any extensions.
sfnameext function public Returns the base file name with file extension.
smakepath function public Creates a single path name, composed of a base path name and file or directory name.

function chdrivedir

Change current default drive and working directory.

Causes the current default drive and working directory to change to the directory specified by pathname. The pathname must refer to an existing directory.

Returns a value of 0 if the default drive and working directory was successfully changed. A return value of -1 indicates an error.

Source
pm_fileutils.h:195
Author
Dmitry A.Steklenev
Version
1.0
Code
       public int chdrivedir (	const char * pathname )


function is_dir

Returns TRUE if the specified location is a directory.

Source
pm_fileutils.h:169
Author
Dmitry A.Steklenev
Version
1.0
Code
       public BOOL is_dir ( const char * location )

function is_file

Returns TRUE if the specified location is a regular file.

Source
pm_fileutils.h:142
Author
Dmitry A.Steklenev
Version
1.0
Code
       public BOOL is_file ( const char * location )

function is_root

Returns TRUE if the specified location is a root directory.

Source
pm_fileutils.h:160
Author
Dmitry A.Steklenev
Version
1.0
Code
       public BOOL is_root ( const char * location )

function is_url

Returns TRUE if the specified location is a URL.

Source
pm_fileutils.h:151
Author
Dmitry A.Steklenev
Version
1.0
Code
       public BOOL is_url ( const char * location )

function scheme

Returns the scheme followed by a colon (:) of the specified location.

Returns an empty string if specified location does not contain definition of the url scheme.

Note: Because the result string always less or is equal to a location string all functions can safely use the same storage area for a location and result.

Source
pm_fileutils.h:54
Author
Dmitry A.Steklenev
Version
1.0
Code
       public char * scheme (	char * result ,
                       	const char * location ,
                               size_t size )

function sdecode

Passed any string value, decode from URL transmission.

Note: Because the result string always less or is equal to a location string all functions can safely use the same storage area for a location and result.

Source
pm_fileutils.h:133
Author
Dmitry A.Steklenev
Version
1.0
Code
       public char * sdecode (	char * result ,
       	                const char * location ,
       	                size_t size )