Compartir a través de

Función PdhEnumLogSetNamesA (pdh.h)

  • Artículo

Enumera los nombres de los conjuntos de registros dentro del DSN.

Sintaxis

PDH_FUNCTION PdhEnumLogSetNamesA(
  [in]      LPCSTR  szDataSource,
  [out]     PZZSTR  mszDataSetNameList,
  [in, out] LPDWORD pcchBufferLength
);

Parámetros

[in] szDataSource

cadena terminada en Nullque especifica el DSN.

[out] mszDataSetNameList

Búfer asignado por el autor de la llamada que recibe la lista de nombres de conjunto de registros terminadosnull. La lista finaliza con un carácter nulo-terminador. Establézcalo en null si el parámetro pcchBufferLength es cero.

[in, out] pcchBufferLength

Tamaño del búfer de mszLogSetNameList, 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.

Valor devuelto

Si la función se ejecuta 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_MORE_DATA
 El tamaño del mszLogSetNameList búfer es demasiado pequeño para contener todos los datos. Este valor devuelto se espera si pcchBufferLength 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_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.

Observaciones

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

Nota

El encabezado pdh.h define PdhEnumLogSetNames 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 XP [solo aplicaciones de escritorio]
servidor mínimo admitido Windows Server 2003 [solo aplicaciones de escritorio]
de la plataforma de destino de Windows
encabezado de pdh.h
biblioteca de Pdh.lib
DLL de Pdh.dll