PathIsUNCServerShare function
Determines if a string is a valid Universal Naming Convention (UNC) share path, \\server\share.
Syntax
BOOL PathIsUNCServerShare( _In_ LPCTSTR pszPath );
Parameters
- pszPath [in]
-
Type: LPCTSTR
A pointer to a null-terminated string of maximum length MAX_PATH that contains the path to be validated.
Return value
Type: BOOL
Returns TRUE if the string is in the form \\server\share, or FALSE otherwise.
Examples
#include <windows.h> #include <iostream.h> #include "Shlwapi.h" void main( void ) { // String path name 1. char buffer_1[ ] = "\\\\path1\\path2"; char *lpStr1; lpStr1 = buffer_1; // String path name 2. char buffer_2[ ] = "\\\\path3"; char *lpStr2; lpStr2 = buffer_2; // String path name 3. char buffer_3[ ] = "acme\\path4\\path5"; char *lpStr3; lpStr3 = buffer_3; // Variable to get the return // from "PathIsUNCServerShare". int retval; // Test path name 1. retval = PathIsUNCServerShare(lpStr1); cout << "The contents of String 1: " << lpStr1 << "\nThe return value from the function is " << retval << " = TRUE" << endl; // Test path name 2. retval = PathIsUNCServerShare(lpStr2); cout << "The contents of String 2: " << lpStr2 << "\nThe return value from the function is " << retval << " = FALSE" << endl; // Test path name 3. retval = PathIsUNCServerShare(lpStr3); cout << "The contents of String 3: " << lpStr3 << "\nThe return value from the function is " << retval << " = FALSE"<< endl; } OUTPUT: ================= The contents of String 1: \\path1\path2 The return value from the function is 1 = TRUE The contents of String 2: \\path3 The return value from the function is 0 = FALSE The contents of String 3: acme\path4\path5 The return value from the function is 0 = FALSE
Requirements
|
Minimum supported client |
Windows 2000 Professional, Windows XP [desktop apps only] |
|---|---|
|
Minimum supported server |
Windows 2000 Server [desktop apps only] |
|
Header |
|
|
Library |
|
|
DLL |
|
|
Unicode and ANSI names |
PathIsUNCServerShareW (Unicode) and PathIsUNCServerShareA (ANSI) |