Función WNetEnumResourceA (winnetwk.h)

Artículo
08/27/2023

La función WNetEnumResource continúa una enumeración de los recursos de red iniciados por una llamada a la función WNetOpenEnum .

Sintaxis

DWORD WNetEnumResourceA(
  [in]      HANDLE  hEnum,
  [in, out] LPDWORD lpcCount,
  [out]     LPVOID  lpBuffer,
  [in, out] LPDWORD lpBufferSize
);

Parámetros

[in] hEnum

Identificador que identifica una instancia de enumeración. La función WNetOpenEnum debe devolver este identificador.

[in, out] lpcCount

Puntero a una variable que especifica el número de entradas solicitadas. Si el número solicitado es –1, la función devuelve tantas entradas como sea posible.

Si la función se realiza correctamente, al devolver la variable a la que apunta este parámetro contiene el número de entradas que realmente se leen.

[out] lpBuffer

Puntero al búfer que recibe los resultados de la enumeración. Los resultados se devuelven como una matriz de estructuras NETRESOURCE . Tenga en cuenta que el búfer que asigne debe ser lo suficientemente grande como para contener las estructuras, además de las cadenas a las que apuntan sus miembros. Para obtener más información, vea la sección Comentarios que se muestra más adelante.

El búfer es válido hasta la siguiente llamada mediante el identificador especificado por el parámetro hEnum . El orden de las estructuras NETRESOURCE de la matriz no es predecible.

[in, out] lpBufferSize

Puntero a una variable que especifica el tamaño del parámetro lpBuffer , en bytes. Si el búfer es demasiado pequeño para recibir incluso una entrada, este parámetro recibe el tamaño necesario del búfer.

Valor devuelto

Si la función se ejecuta correctamente, el valor devuelto es uno de los siguientes valores.

Código devuelto	Descripción
NO_ERROR	La enumeración se realizó correctamente y el búfer contiene los datos solicitados. La aplicación que realiza la llamada puede continuar llamando a WNetEnumResource para completar la enumeración.
ERROR_NO_MORE_ITEMS	No hay más entradas. El contenido del búfer no está definido.

Si se produce un error en la función, el valor devuelto es un código de error del sistema, como uno de los siguientes valores.

Código devuelto	Descripción
ERROR_MORE_DATA	Hay más entradas disponibles con llamadas posteriores. Para obtener más información, vea la sección Comentarios que se muestra más adelante.
ERROR_INVALID_HANDLE	El identificador especificado por el parámetro hEnum no es válido.
ERROR_NO_NETWORK	La red no está disponible. (Esta condición se prueba antes de que hEnum se pruebe para su validez).
ERROR_EXTENDED_ERROR	Error específico de la red. Para obtener una descripción del error, llame a la función WNetGetLastError .

Comentarios

La función WNetEnumResource no enumera los usuarios conectados a un recurso compartido; Puede llamar a la función NetConnectionEnum para realizar esta tarea. Para enumerar recursos compartidos ocultos, llame a la función NetShareEnum .

Una aplicación no puede establecer el parámetro lpBuffer en NULL y recuperar el tamaño de búfer necesario del parámetro lpBufferSize . En su lugar, la aplicación debe asignar un búfer de un tamaño razonable (16 kilobytes es típico) y usar el valor de lpBufferSize para la detección de errores.

Ejemplos

Para obtener un ejemplo de código que ilustra una función definida por la aplicación que enumera todos los recursos de una red, consulte Enumerar recursos de red.

Nota:

El encabezado winnetwk.h define WNetEnumResource 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 neutro de codificación con código que no es neutral de codificación puede provocar discrepancias que dan lugar a errores de compilación o en tiempo de ejecución. Para obtener más información, vea Convenciones para prototipos de función.

Requisitos


Cliente mínimo compatible	Windows 2000 Professional [solo aplicaciones de escritorio]
Servidor mínimo compatible	Windows 2000 Server [solo aplicaciones de escritorio]
Plataforma de destino	Windows
Encabezado	winnetwk.h
Library	Mpr.lib
Archivo DLL	Mpr.dll