PathIsUNC function
Applies to: desktop apps only
Determines if the string is a valid Universal Naming Convention (UNC) for a server and share path.
Syntax
BOOL PathIsUNC( __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 validate.
Return value
Type: BOOL
Returns TRUE if the string is a valid UNC path, 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 "PathIsUNC".
int retval;
// Test path name 1.
retval = PathIsUNC(lpStr1);
cout << "The contents of String 1: " << lpStr1
<< "\nThe return value from the function is " << retval << " = TRUE" << endl;
// Test path name 2.
retval = PathIsUNC(lpStr2);
cout << "The contents of String 2: " << lpStr2
<< "\nThe return value from the function is " << retval << " = TRUE" << endl;
// Test path name 3.
retval = PathIsUNC(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 1 = TRUE
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 |
|---|---|
|
Minimum supported server | Windows 2000 Server |
|
Header |
|
|
Library |
|
|
DLL |
|
|
Unicode and ANSI names | PathIsUNCW (Unicode) and PathIsUNCA (ANSI) |
Send comments about this topic to Microsoft
Build date: 3/7/2012
