nca_directory


Ancestor nonvisualobject

Hierarchy
nca_directory
nonvisualobject

Author none

Library pathcreate.pbl

Description A set of useful functions for interacting with the OS directory structure.

Usage Declare this object and use directly. It is autoinstantiate.

Model
nca_directory
none
CreateDirectory (as_directoryname) returns integer
CreatePath (as_path) returns integer
DirectoryExists (as_directoryname) returns boolean
GetCurrentDirectory () returns string
RemoveDirectory (as_directoryname) returns integer
SetCurrentDirectory (as_dir) returns (none)

Functions

CreateDirectory

Description Create the directory name passed in.
Return integer
  • 1, created ok
  • -1, create failed
  • Access public
    Arguments
    Argument DataType Description
    as_directoryname string Directory name to create

    Usage none

    CreatePath

    Description This function will check it the specified path exists and if it does not it will work back through the path until it finds a base directory. Then it will work forward through the rest of the path creating the missing directories.
    Return integer
  • -1, failed
  • 0, directory existed so no operation
  • 1, section of path created ok
  • Access public
    Arguments
    Argument DataType Description
    as_path string Path you want validated/created.

    Usage none

    DirectoryExists

    Description Check if a directory Exists
    Return boolean
  • TRUE, exists
  • FLASE, does not exists
  • Access public
    Arguments
    Argument DataType Description
    as_directoryname string Directory name to check

    Usage none

    GetCurrentDirectory

    Description Get the current directory for this application.
    Return string
  • "", failed
  • else, the current directory
  • Access public
    Arguments none
    Usage none

    RemoveDirectory

    Description Remove a directory
    Return integer
  • 1, removed
  • -1, remove failed
  • Access public
    Arguments
    Argument DataType Description
    as_directoryname string Directory to be removed

    Usage none

    SetCurrentDirectory

    Description Set the current directory for this application
    Return (none)
    Access public
    Arguments
    Argument DataType Description
    as_dir string Directory to be set

    Usage none
    Events none

    References
    UsesUsed By
    nca_directory
    nca_directory


    Document Generated: 10/11/2002 14:29:48