Función NetUseEnum (lmuse.h)

Artículo
08/24/2023

La función NetUseEnum enumera todas las conexiones actuales entre el equipo local y los recursos en servidores remotos.

También puede usar las funciones WNetOpenEnum y WNetEnumResource para enumerar los recursos de red o las conexiones.

Sintaxis

NET_API_STATUS NET_API_FUNCTION NetUseEnum(
  [in]      LMSTR   UncServerName,
  [in]      DWORD   LevelFlags,
  [out]     LPBYTE  *BufPtr,
  [in]      DWORD   PreferedMaximumSize,
  [out]     LPDWORD EntriesRead,
  [out]     LPDWORD TotalEntries,
  [in, out] LPDWORD ResumeHandle
);

Parámetros

[in] UncServerName

Nombre UNC del equipo en el que se va a ejecutar esta función. Si este parámetro es NULL, se usa el equipo local. Si el parámetro UncServerName especificado es un equipo remoto, el equipo remoto debe admitir llamadas RPC remotas mediante el mecanismo heredado del protocolo de acceso remoto.

Esta cadena es Unicode si se definen _WIN32_WINNT o FORCE_UNICODE .

[in] LevelFlags

Nivel de información de los datos solicitados. Este parámetro puede ser uno de los valores siguientes.

Valor	Significado
0	Especifica un nombre de dispositivo local y el nombre del recurso compartido de un recurso remoto. El parámetro BufPtr apunta a una matriz de estructuras de USE_INFO_0 .
1	Especifica información sobre la conexión entre un dispositivo local y un recurso compartido, incluido el estado y el tipo de conexión. El parámetro BufPtr apunta a una matriz de estructuras de USE_INFO_1 .
2	Especifica información sobre la conexión entre un dispositivo local y un recurso compartido. La información incluye el estado de conexión, el tipo de conexión, el nombre de usuario y el nombre de dominio. El parámetro BufPtr apunta a una matriz de estructuras de USE_INFO_2 .

[out] BufPtr

Puntero al búfer que recibe las estructuras de información. El formato de estos datos depende del valor del parámetro Level . El sistema asigna este búfer y se debe liberar mediante la función NetApiBufferFree cuando ya no se necesita la información. Tenga en cuenta que debe liberar el búfer incluso si se produce un error en la función con ERROR_MORE_DATA.

[in] PreferedMaximumSize

Longitud máxima preferida, en bytes, de los datos que se van a devolver. Si se especifica MAX_PREFERRED_LENGTH , la función asigna la cantidad de memoria necesaria para los datos. Si se especifica otro valor en este parámetro, puede restringir el número de bytes que devuelve la función. Si el tamaño del búfer no es suficiente para contener todas las entradas, la función devuelve ERROR_MORE_DATA. Para obtener más información, consulte Búferes de funciones de administración de red y longitudes de búfer de funciones de administración de red.

[out] EntriesRead

Puntero a un valor que recibe el recuento de elementos enumerados realmente.

[out] TotalEntries

Puntero a un valor que recibe el número total de entradas que se podrían haber enumerado a partir de la posición de reanudación actual. Tenga en cuenta que las aplicaciones solo deben tener en cuenta este valor como sugerencia.

[in, out] ResumeHandle

Puntero a un valor que contiene un identificador de reanudación que se usa para continuar la búsqueda. El identificador debe ser cero en la primera llamada y dejar sin cambios para las llamadas posteriores. Si ResumeHandle es NULL, no se almacena ningún identificador de reanudación.

Valor devuelto

Si la función se ejecuta correctamente, el valor devuelto se NERR_Success.

Si se produce un error en la función, el valor devuelto es un código de error del sistema. Para obtener una lista de códigos de error, consulte Códigos de error del sistema.

Código devuelto	Descripción
ERROR_INVALID_PARAMETER	Se pasó un parámetro no válido a la función. Este error se devuelve si se pasa un puntero NULL en los parámetros BufPtr o entriesread .
ERROR_MORE_DATA	Hay más datos que devolver. Este error se devuelve si el tamaño del búfer no es suficiente para contener todas las entradas.
ERROR_NOT_SUPPORTED	No se admite la solicitud. Este error se devuelve si el parámetro UncServerName no era NULL y el servidor remoto no admite llamadas RPC remotas mediante el mecanismo heredado protocolo de acceso remoto.
Otros	Use FormatMessage para obtener la cadena de mensaje para el error devuelto.

Comentarios

No se requiere pertenencia a grupos especiales para llamar a la función NetUseEnum . Esta función no se puede ejecutar en un servidor remoto, excepto en los casos de compatibilidad de nivel inferior mediante el protocolo de acceso remoto heredado.

Para recuperar información sobre una conexión de red, puede llamar a la función NetUseGetInfo .

Esta función solo se aplica al cliente bloque de mensajes del servidor (estación de trabajo de ADMINISTRADOR DE LAN). La función NetUseEnum no admite recursos compartidos del Sistema de archivos distribuidos (DFS). Para enumerar recursos compartidos mediante un proveedor de red diferente (WebDAV o un recurso compartido DFS, por ejemplo), use las funciones WNetOpenEnum, WNetEnumResource y WNetCloseEnum .

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	lmuse.h (include Lm.h, Lmcons.h)
Library	Netapi32.lib
Archivo DLL	Netapi32.dll