Функция PathIsRootW (shlwapi.h)

Определяет, ссылается ли строка пути на корень тома.

Синтаксис

BOOL PathIsRootW(
  [in] LPCWSTR pszPath
);

Параметры

[in] pszPath

Тип: LPCTSTR

Указатель на строку максимальной длины, заканчивающуюся значением NULL, MAX_PATH, содержащую проверяемую путь.

Возвращаемое значение

Тип: BOOL

Возвращает значение TRUE , если указанный путь является корнем, или false в противном случае.

Комментарии

Возвращает значение TRUE для таких путей, как "", "X:" или "\\server\share". Пути, такие как ".. \path2" или "\\server" возвращают значение FALSE.

Примеры

#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
============

Примечание

Заголовок shlwapi.h определяет PathIsRoot в качестве псевдонима, который автоматически выбирает версию ANSI или Юникод этой функции на основе определения константы препроцессора ЮНИКОД. Сочетание использования псевдонима, не зависящий от кодировки, с кодом, не зависящим от кодировки, может привести к несоответствиям, которые приводят к ошибкам компиляции или среды выполнения. Дополнительные сведения см. в разделе Соглашения для прототипов функций.

Требования

Требование	Значение
Минимальная версия клиента	Windows 2000 Professional, Windows XP [только классические приложения]
Минимальная версия сервера	Windows 2000 Server [только классические приложения]
Целевая платформа	Windows
Header	shlwapi.h
Библиотека	Shlwapi.lib
DLL	Shlwapi.dll (версия 4.71 или более поздняя)