PathIsUNCServerA function (shlwapi.h)

Article
02/22/2024

Determines if a string is a valid Universal Naming Convention (UNC) for a server path only.

Syntax

BOOL PathIsUNCServerA(
  [in] LPCSTR pszPath
);

Parameters

[in] pszPath

Type: LPCTSTR

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

Return value

Type: BOOL

Returns TRUE if the string is a valid UNC path for a server only (no share name), or FALSE otherwise.

Remarks

Note

The shlwapi.h header defines PathIsUNCServer 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)

Share via