PathSearchAndQualifyA function (shlwapi.h)

Article
11/20/2024

Determines if a given path is correctly formatted and fully qualified.

Syntax

BOOL PathSearchAndQualifyA(
  [in]  LPCSTR pszPath,
  [out] LPSTR  pszBuf,
  [in]  UINT   cchBuf
);

Parameters

[in] pszPath

Type: LPCTSTR

A pointer to a null-terminated string of maximum length MAX_PATH that contains the path to search.

[out] pszBuf

Type: LPTSTR

A pointer to a null-terminated string of length MAX_PATH that contains the path to be referenced.

[in] cchBuf

Type: UINT

The size of the buffer pointed to by pszFullyQualifiedPath, in characters.

Return value

Type: BOOL

Returns TRUE if the path is qualified, or FALSE otherwise.

Remarks

Note

The shlwapi.h header defines PathSearchAndQualify as an alias that automatically selects the ANSI or Unicode version of this function based on the definition of the UNICODE preprocessor constant. Mixing usage of the encoding-neutral alias with code that is not encoding-neutral can lead to mismatches that result in compilation or runtime errors. For more information, see Conventions for Function Prototypes.

Requirements

Requirement	Value
Minimum supported client	Windows 2000 Professional, Windows XP [desktop apps only]
Minimum supported server	Windows 2000 Server [desktop apps only]
Target Platform	Windows
Header	shlwapi.h
Library	Shlwapi.lib
DLL	Shlwapi.dll (version 4.71 or later)

Share via