Función PdhParseInstanceNameA (pdh.h)

  • Artículo

Analiza los elementos de una cadena de instancia.

Sintaxis

PDH_FUNCTION PdhParseInstanceNameA(
  [in]      LPCSTR  szInstanceString,
  [out]     LPSTR   szInstanceName,
  [in, out] LPDWORD pcchInstanceNameLength,
  [out]     LPSTR   szParentName,
  [in, out] LPDWORD pcchParentNameLength,
  [out]     LPDWORD lpIndex
);

Parámetros

[in] szInstanceString

Cadena terminada en NULL que especifica la cadena de instancia que se va a analizar en componentes individuales. Esta cadena puede contener los siguientes formatos y tiene menos de MAX_PATH caracteres de longitud:

  • instance
  • instance#index
  • primario/instancia
  • parent/instance#index

[out] szInstanceName

Búfer asignado por el autor de la llamada que recibe el nombre de instancia terminada en NULL. Se establece en NULL si pcchInstanceNameLength es cero.

[in, out] pcchInstanceNameLength

Tamaño del búfer szInstanceName , en TCHAR. Si es cero en la entrada, la función devuelve PDH_MORE_DATA y establece este parámetro en el tamaño de búfer necesario. Si el búfer es mayor que el tamaño necesario, la función establece este parámetro en el tamaño real del búfer que se usó. Si el tamaño especificado en la entrada es mayor que cero pero menor que el tamaño necesario, no debe confiar en el tamaño devuelto para reasignar el búfer.

[out] szParentName

Búfer asignado por el autor de la llamada que recibe el nombre terminado en null de la instancia primaria, si se especifica uno. Se establece en NULL si pcchParentNameLength es cero.

[in, out] pcchParentNameLength

Tamaño del búfer szParentName , en TCHAR. Si es cero en la entrada, la función devuelve PDH_MORE_DATA y establece este parámetro en el tamaño de búfer necesario. Si el búfer es mayor que el tamaño necesario, la función establece este parámetro en el tamaño real del búfer que se usó. Si el tamaño especificado en la entrada es mayor que cero pero menor que el tamaño necesario, no debe confiar en el tamaño devuelto para reasignar el búfer.

[out] lpIndex

Valor de índice de la instancia. Si una entrada de índice no está presente en la cadena, este valor es cero. Este parámetro puede ser NULL.

Valor devuelto

Si la función se realiza correctamente, devuelve ERROR_SUCCESS.

Si se produce un error en la función, el valor devuelto es un código de error del sistema o un código de error PDH. A continuación se muestran los valores posibles.

Código devuelto Descripción
PDH_INVALID_ARGUMENT
 Un parámetro no es válido. Por ejemplo, en algunas versiones podría recibir este error si el tamaño especificado en la entrada es mayor que cero pero menor que el tamaño necesario.
PDH_MORE_DATA
 Uno o ambos búferes de cadena son demasiado pequeños para contener los datos. Este valor devuelto se espera si el búfer de tamaño correspondiente es cero en la entrada. Si el tamaño especificado en la entrada es mayor que cero pero menor que el tamaño necesario, no debe confiar en el tamaño devuelto para reasignar el búfer.
PDH_INVALID_INSTANCE
 La cadena de instancia tiene un formato incorrecto, supera MAX_PATH caracteres de longitud o no se puede analizar.

Comentarios

Debe llamar a esta función dos veces, la primera vez que obtenga el tamaño de búfer necesario (establezca los búferes en NULL y tamaños de búfer en 0) y la segunda vez para obtener los datos.

Nota

El encabezado pdh.h define PdhParseInstanceName 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 Convenciones para prototipos de función.

Requisitos

Requisito Value
Cliente mínimo compatible Windows XP [solo aplicaciones de escritorio]
Servidor mínimo compatible Windows Server 2003 [solo aplicaciones de escritorio]
Plataforma de destino Windows
Encabezado pdh.h
Library Pdh.lib
Archivo DLL Pdh.dll

Consulte también

PdhMakeCounterPath