[Contents] [Index] [Help] [Retrace] [Browse <] [Browse >]


    NAME
        Examine -- Examine a directory or file associated with a lock

    SYNOPSIS
        success = Examine( lock, fileinfoblock )
        D0                  D1        D2

        bool examine(bptr,struct fileinfoblock *)

    FUNCTION
        Examine() fills in information in the fileinfoblock concerning the
        file or directory associated with the lock. This information
        includes the name, size, creation date and whether it is a file or
        directory.  fileinfoblock must be longword aligned.  examine() gives
        a return code of zero if it fails.

        You may make a local copy of the fileinfoblock, as long as it is
        never passed to exnext().

    INPUTS
        lock      - BCPL pointer to a lock
        infoBlock - pointer to a fileinfoblock (must be longword aligned)

    RESULTS
        success - boolean

    SPECIAL NOTE
        fileinfoblock must be longword-aligned.  allocdosobject() will
        allocate them correctly for you.

    SEE ALSO
        lock(), unlock(), exnext(), examinefh(), <dos/dos.h>, allocdosobject(),
        exall()