Externals Catalog

GetString()

SYNOPSIS
    GetString(fullpathname,stringID)
     
DESCRIPTION
    Retrieves the content of a string ('STR ') resource.

ARGUMENTS
    fullpathname        the complete path (including volume and directory
                        names) identifying the file containing the 'STR '
                        resource you wish to access.

    stringID            the identification number of  the 'STR ' resource.

RETURNS
  >>'STR ' resource content
    "Error:  insufficient parameters"
    "Error:  invalid pathname"
    "Error:  invalid string ID"

NOTES
    Calling GetString with no parameters will return the online help.

SEE ALSO
    WriteString(), GetIndString(), WriteIndString()

DISTRIBUTION
    Select one of the following packages for:

WriteString()

SYNOPSIS
    WriteString(fullpathname,resID,string[,resName])
     
DESCRIPTION
    Writes the content of a string ('STR ') resource.

ARGUMENTS
    fullpathname        the complete path (including volume and directory
                        names) identifying the file containing the 'STR '
                        resource to be written to.

    resID               the identification number of the 'STR ' resource to
                        be written to.

    string              the actual text string to be placed into the 'STR '
                        resource.

    resName             the desired name of the 'STR ' resource to be
                        written to. 

RETURNS
    "Success"
    "Error:  insufficient parameters"
    "Error:  resource not found"
    "Error:  resource file not found"
    "Error:  AddResource failed"
    "Error:  RmveResource failed"
    "Error:  attribute does not permit operation"
    "Error:  error reading resource map"
    "Error:  unspecified error"

NOTES
    Calling WriteString with no parameters will return the online help.

SEE ALSO
    GetString(), GetIndString(), WriteIndString()

DISTRIBUTION
    Select one of the following packages for:

GetIndString()

SYNOPSIS
    GetIndString(fullpathname,strListID,index)
     
DESCRIPTION
    Retrieves the content of an indexed string ('STR#') resource.

ARGUMENTS
    fullpathname        the complete path (including volume and directory
                        names) identifying the file containing the 'STR#'
                        resource you want to access.

    strListID           the identification number of the 'STR#' resource
                        to be used.

    index               the index number of the string (among the strings
                        in strListID) you wish to get.


RETURNS
  >>'STR#' resource content
    "Error:  insufficient parameters"
    "Error:  invalid pathname"
    "Error:  invalid index"
    
NOTES
    Calling GetIndString with no parameters will return the online help.

SEE ALSO
    WriteIndString(), CreateIndString(), GetString(),
    WriteString()

DISTRIBUTION
    Select one of the following packages for:

WriteIndString()

SYNOPSIS
    WriteIndString(fullpathname,strListID,index,string)
     
DESCRIPTION
    Writes the content of an indexed string ('STR#') resource.

ARGUMENTS
    fullpathname    the complete path (including volume and directory names)
                    identifying the file containing the 'STR#' resource to be
                    written to.

    strListID       the identification number of the 'STR#' resource to be
                    written to.

    index           the index number of the string (among the strings in
                    resListID) you wish to write to.

    string          the actual text string to be placed into the 'STR '
                    resource.

RETURNS
    "Success"
    "Error:  insufficient parameters"
    "Error:  resource not found"
    "Error:  resource file not found"
    "Error:  AddResource failed"
    "Error:  RmveResource failed"
    "Error:  attribute does not permit operation"
    "Error:  error reading resource map"
    "Error:  unspecified error"

NOTES
    Calling WriteIndString with no parameters will return the online help.

SEE ALSO
    GetIndString(), CreateIndString(), GetString(),
    WriteString()

DISTRIBUTION
    Select one of the following packages for:

CreateIndString()

SYNOPSIS
    CreateIndString(fullpathname,strListID[,resName])
     
DESCRIPTION
    Creates an empty indexed string ('STR#') resource.
    
ARGUMENTS
    fullpathname        the complete path (including volume and directory
                        names) identifying the file where the 'STR#'
                        resource should be created.

    strListID           the identification number of the 'STR#' resource
                        to be created.

    resName             the name of the 'STR #' resource to be created. 
                        (Optional)

RETURNS
    "Success"
    "Error:  insufficient parameters"
    "Error:  resource not found"
    "Error:  resource file not found"
    "Error:  AddResource failed"
    "Error:  RmveResource failed"
    "Error:  attribute does not permit operation"
    "Error:  error reading resource map"
    "Error:  unspecified error"

NOTES
    Calling CreateIndString with no parameters will return the online help.

SEE ALSO
    GetIndString(), WriteIndString(), GetString(),
    WriteString()

DISTRIBUTION
    Select one of the following packages for:

FolderExists() -- FileExists()

SYNOPSIS
    FolderExists(fullpathname)
     
DESCRIPTION
    Determines the existence of a file or folder.

ARGUMENTS
    fullpathname        the complete path (including volume and directory
                        names) identifying the file or folder you wish to
                        determine the existence of. 

RETURNS
    "TRUE"
    "Error:  directory or file not found"
    "Error:  bad name"
    "Error:  external file system"
    "Error:  I/O error"
    "Error:  no such volume"
    "Error:  no default volume"
    "Error:  server volume disconnected"
    "Error:  unspecified error"

NOTES
    Calling FolderExists with no parameters will return the online help.

SEE ALSO
    FolderMove, FileMove

DISTRIBUTION
    Select one of the following packages for:

FolderMove -- FileMove

SYNOPSIS
    FolderMove <source_fullpathname>,<destination_fullpathname>
     
DESCRIPTION
    Moves or renames a file or folder.

ARGUMENTS
    source_fullpathname         the complete path (including volume and
                                directory names) identifying the file or
                                folder you wish to move.    

    destination_fullpathname    the complete path (including volume and
                                directory names) identifying the location
                                the file/folder should be moved to. 


RETURNS
    "Success"
    "Error:  cannot transfer between different disks (volumes)"
    "Error:  bad file name or attempt to move into file"
    "Error:  duplicate file name (destination file/dir already exists)"
    "Error:  source file not found"
    "Error:  I/O Error"
    "Error:  no such volume"
    "Error:  no default volume"
    "Error:  volume is locked"
    "Error:  diskette is write-protected"
    "Error:  unspecified error"

NOTES
    Calling FolderMove with no parameters will return the online help.

SEE ALSO
    FolerExists(), FileExists()

DISTRIBUTION
    Select one of the following packages for:

FolderCreate

SYNOPSIS
    FolderCreate <fullpathname>
     
DESCRIPTION
    Creates a new folder.

ARGUMENTS
    fullpathname    the complete path (including volume and directory
                    names) identifying the folder to create.

RETURNS
    "Success"
    "Error:  bad name"
    "Error:  directory full"
    "Error:  directory not found"
    "Error:  duplicate filename (rename)"
    "Error:  external file system"
    "Error:  I/O error"
    "Error:  no such volume"
    "Error:  volume is locked"
    "Error:  diskette is write-protected"
    "Error:  unspecified error"

NOTES

SEE ALSO
    FolderMove, FolderExists()

DISTRIBUTION
    Select one of the following packages for:

FileVersion()

SYNOPSIS
    FileVersion(fullpathname[,"l[ong]"])
     
DESCRIPTION
    Retrieves a file version information text as it appears in the Finder's
    "Get Info" window.

ARGUMENTS
    fullpathname        the complete path (including volume and directory
                        names) identifying the file you wish to access.

    long                when this parameter is present the complete (long)
                        file version information is returned. (Optional)

RETURNS
  >>File version number string
  >>File version information string
    "N/A"
    "Error:  invalid pathname"
    
NOTES
    Calling FileVersion with no parameters will return the online help.

SEE ALSO
    FolderExists()

DISTRIBUTION
    Select one of the following packages for:

GetDate()

SYNOPSIS
    GetDate([days[,format]]) 
     
DESCRIPTION
    Returns the number of seconds since Midnight, January 1, 1904 in
    various formats.

ARGUMENTS
        days        when this optional parameter is:

                    a positive number:  GetDate() will return the number
                                        of seconds since 1/1/04 plus the
                                        number of day(s) specified by the
                                        days parameter.
                    a negative number:  GetDate() will return the number
                                        of seconds since 1/1/04 minus the
                                        number of day(s) specified by the
                                        days parameter.

        format      when this optional parameter is:

                    s[hort]:    the short date is returned;
                                (Digits and separators: 1/18/1995)
                    l[ong]:     the long date is returned;
                                (Long text: Wednesday, January 18,1995)
                    a[bbrev]:   the abbreviated date is returned;
                                (Abbreviated text: Wed, Jan 18, 1995)

RETURNS
  >>Number of seconds since 1/1/04
  >>Short date
  >>Long date
  >>Abbreviated date

NOTES
    GetDate("?") will return the online help.

DISTRIBUTION
    Select one of the following packages for:

GetURL

SYNOPSIS
    GetURL <theURL>,<appCreatorID>[,"[b]ackground"]
     
DESCRIPTION
    Open an Universal Resource Locator (URL) with the specified application.

ARGUMENTS
    theURL              the actual Universal Resource Locator text.

    appCreatorID        the creator ID of the application you wish the URL
                        to open with.

    background          when this parameter is present the specified
                        application will stay in the background.

RETURNS
  >>Empty
    "Error:  GetURL requires System 7"
    "Error:  no eligible process with specified descriptor"
    "Error:  not enough room in heap zone"
    "Error:  wrong descriptor type"
    "Error:  not a valid descriptor record"
    "Error:  operation involving a list item failed"
    "Error:  connection is invalid"
    "Error:  event wasn't handled by an Apple Event handler"
    "Error:  user canceled out of wait loop for reply or receipt"
    "Error:  Apple Event timed out"
    "Error:  unknown Apple Event address type"
    "Error:  unspecified Apple Event error"

NOTES
    Calling GetURL with no parameters will return the online help.

DISTRIBUTION
    Select one of the following packages for:

Scramble()

SYNOPSIS
    Scramble(text | scrambled_text)
     
DESCRIPTION
    Performs simple text scrambling/de-scrambling.

ARGUMENTS
    text                    the text to be scrambled.

    scrambled_text          the scrambled text to be de-scrambled.

RETURNS
  >>Scrambled text
  >>Unscrambled text

DISTRIBUTION
    Select one of the following packages for: