PathGetCharTypeA function (shlwapi.h)

Determines the type of character in relation to a path.

Syntax

UINT PathGetCharTypeA(
  [in] UCHAR ch
);

Parameters

[in] ch

Type: TUCHAR

The character for which to determine the type.

Return value

Type: UINT

Returns one or more of the following values that define the type of character.

Return code Description
GCT_INVALID
The character is not valid in a path.
GCT_LFNCHAR
The character is valid in a long file name.
GCT_SEPARATOR
The character is a path separator.
GCT_SHORTCHAR
The character is valid in a short (8.3) file name.
GCT_WILD
The character is a wildcard character.

Remarks

Note

The shlwapi.h header defines PathGetCharType as an alias which 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 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)