Important Notice

The pages on this site contain documentation for very old MS-DOS software, purely for historical purposes. If you're looking for up-to-date documentation, particularly for programming, you should not rely on the information found here, as it will be woefully out of date.

◄Function Group►  ◄Overview►                          ◄Up► ◄Next► ◄Previous►
────────────────────────────────────────────────────────────────────────────
 
#define INCL_DOSFILEMGR
 
USHORT DosQPathInfo(pszPath, usInfoLevel, pInfoBuf, cbInfoBuf,
    ulReserved);
PSZ pszPath;           /* pointer to path                   */
USHORT usInfoLevel;    /* level of information              */
PBYTE pInfoBuf;        /* pointer to buffer for information */
USHORT cbInfoBuf;      /* length of information buffer      */
ULONG ulReserved;      /* must be zero                      */
 
The DosQPathInfo function returns information about a specified file or
directory.
 
The DosQPathInfo function is a family API function.
 
Parameter    Description
────────────────────────────────────────────────────────────────────────────
 
pszPath      Points to the null-terminated string that specifies the path of
             the file or directory. Wildcard characters are valid in the
             path only when the value of the usInfoLevel parameter is
             FIL_QUERYFULLNAME or FIL_NAMEISVALID.
 
usInfoLevel  Specifies the level of information required. This parameter can
             be one of the following values:
 
             Value                 Meaning
             ───────────────────────────────────────────────────────────────
             FIL_STANDARD          Return a FILESTATUS structure.
 
             FIL_QUERYEASIZE       Return a FILESTATUS structure followed by
                                   a 4-byte value that specifies the buffer
                                   size needed to retrieve the entire
                                   extended attribute.
 
             FIL_QUERYEASFROMLIST  Return extended-attribute information,
                                   using an EAOP structure for the pInfoBuf
                                   parameter.
 
             FIL_QUERYFULLNAME     Return the fully qualified path of the
                                   buffer pointed to by the pInfoBuf
                                   parameter. When this value is specified,
                                   the path pointed to by the pszPath
                                   parameter can contain wildcard
                                   characters.
 
             FIL_NAMEISVALID       Verify the correctness (according to MS
                                   OS/2 syntax rules) of the path pointed to
                                   by the pszPath parameter. If the path is
                                   incorrect (for example, a filename is too
                                   long for the current file system), an
                                   error will be returned. The path can
                                   contain wildcard characters.
 
pInfoBuf     Points to the buffer that contains a FILESTATUS or EAOP
             structure. The structure used is determined by the value
             specified for the usInfoLevel parameter.
 
cbInfoBuf    Specifies the length (in bytes) of the buffer pointed to by the
             pInfoBuf parameter.
 
ulReserved   Specifies a reserved value; must be zero.
 
Return Value
 
The return value is zero if the function is successful. Otherwise, it is an
error value, which may be one of the following:
 
     ERROR_BUFFER_OVERFLOW
     ERROR_EA_LIST_INCONSISTENT
     ERROR_FILENAME_EXCED_RANGE
     ERROR_INVALID_EA_NAME
     ERROR_INVALID_LEVEL
     ERROR_PATH_NOT_FOUND
 
Comments
 
If the usInfoLevel parameter is FIL_QUERYEASFROMLIST, a subset of the
extended-attribute information for the file is returned. Prior to the call
to the DosQPathInfo function, the fpGEAList field of the EAOP structure
should point to a list that defines the attribute names for which values
will be returned, and the fpFEAList field should point to a buffer in which
the relevant extended-attribute list will be returned.
 
See Also
 
DosQFileInfo, DosSetPathInfo, EAOP, FILESTATUS
 
                                      ♦