PathIsRootA-Funktion (shlwapi.h)

Artikel
11/20/2024

Bestimmt, ob eine Pfadzeichenfolge auf den Stamm eines Volumes verweist.

Syntax

BOOL PathIsRootA(
  [in] LPCSTR pszPath
);

Parameter

[in] pszPath

Typ: LPCTSTR-

Ein Zeiger auf eine mit Null beendete Zeichenfolge mit maximaler Länge MAX_PATH, die den zu überprüfenden Pfad enthält.

Rückgabewert

Typ: BOOL-

Gibt TRUE- zurück, wenn der angegebene Pfad ein Stamm ist, oder FALSE andernfalls.

Bemerkungen

Gibt TRUE- für Pfade wie "", "X-:" oder "\\Server\Freigeben" zurück. Pfade wie ".. \path2" oder "\\Server" FALSEzurückgeben.

Beispiele

#include <windows.h>
#include <iostream.h>
#include "Shlwapi.h"

void main( void )
{
// String path name 1.
char buffer_1[ ] = "C:\\";
char *lpStr1;
lpStr1 = buffer_1;

// String path name 2.
char buffer_2[ ] = "path\\file";
char *lpStr2;
lpStr2 = buffer_2;

// Variable to get the return from "PathIsRoot".
int retval;

// Test case with path not absolute.
retval = PathIsRoot(lpStr1);
cout << "The return from function is       :" << retval << endl;
cout << "The path does contain a root part :" << lpStr1 << endl;

// Test case with path absolute.
retval = PathIsRoot(lpStr2);
cout << "The return from function is       :" << retval << endl;
cout << "The path does not contain part    :" << lpStr2 << endl;
}

OUTPUT:
============
The return from function is       :1
The path does contain a root part :C:\
The return from function is       :0
The path does not contain part    :path\file
============

Anmerkung

Der Header "shlwapi.h" definiert PathIsRoot als Alias, der die ANSI- oder Unicode-Version dieser Funktion basierend auf der Definition der UNICODE-Präprozessorkonstante automatisch auswählt. Das Mischen der Verwendung des codierungsneutralen Alias mit Code, der nicht codierungsneutral ist, kann zu Nichtübereinstimmungen führen, die zu Kompilierungs- oder Laufzeitfehlern führen. Weitere Informationen finden Sie unter Konventionen für Funktionsprototypen.

Anforderungen

Anforderung	Wert
mindestens unterstützte Client-	Windows 2000 Professional, Windows XP [nur Desktop-Apps]
mindestens unterstützte Server-	Windows 2000 Server [nur Desktop-Apps]
Zielplattform-	Fenster
Header-	shlwapi.h
Library	Shlwapi.lib
DLL-	Shlwapi.dll (Version 4.71 oder höher)

Freigeben über