[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()