Función PathIsRootA (shlwapi.h)

Determina si una cadena de ruta de acceso hace referencia a la raíz de un volumen.

Sintaxis

BOOL PathIsRootA(
  [in] LPCSTR pszPath
);

Parámetros

[in] pszPath

Tipo: LPCTSTR de

Puntero a una cadena terminada en null de longitud máxima MAX_PATH que contiene la ruta de acceso que se va a validar.

Valor devuelto

Tipo: BOOL de

Devuelve TRUE si la ruta de acceso especificada es una raíz o FALSE de lo contrario.

Observaciones

Devuelve TRUE para rutas de acceso como "", "X:" o "\\servidor\compartir". Rutas de acceso como ".. \path2" o "\\servidor" devuelven FALSE.

Ejemplos

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

Nota

El encabezado shlwapi.h define PathIsRoot como alias que selecciona automáticamente la versión ANSI o Unicode de esta función en función de la definición de la constante de preprocesador UNICODE. La combinación del uso del alias neutral de codificación con código que no es neutral de codificación puede dar lugar a errores de coincidencia que dan lugar a errores de compilación o tiempo de ejecución. Para obtener más información, vea Conventions for Function Prototypes.

Requisitos

Requisito	Valor
cliente mínimo admitido	Windows 2000 Professional, Windows XP [solo aplicaciones de escritorio]
servidor mínimo admitido	Windows 2000 Server [solo aplicaciones de escritorio]
de la plataforma de destino de	Windows
encabezado de	shlwapi.h
biblioteca de	Shlwapi.lib
DLL de	Shlwapi.dll (versión 4.71 o posterior)