Función NetMessageNameEnum (lmmsg.h)

Artículo
08/24/2023

[Esta función no se admite a partir de Windows Vista porque no se admite el servicio messenger.]

La función NetMessageNameEnum enumera los alias de mensaje que reciben mensajes en un equipo especificado. La función requiere que se inicie el servicio messenger.

Sintaxis

NET_API_STATUS NET_API_FUNCTION NetMessageNameEnum(
  [in]      LPCWSTR servername,
  [in]      DWORD   level,
  [out]     LPBYTE  *bufptr,
  [in]      DWORD   prefmaxlen,
  [out]     LPDWORD entriesread,
  [out]     LPDWORD totalentries,
  [in, out] LPDWORD resume_handle
);

Parámetros

[in] servername

Puntero a una cadena constante que especifica el nombre DNS o NetBIOS del servidor remoto en el que se va a ejecutar la función. Si este parámetro es NULL, se usa el equipo local.

[in] level

Especifica el nivel de información de los datos. Este parámetro puede ser uno de los valores siguientes.

Valor	Significado
0	Devuelve alias de mensaje. El parámetro bufptr apunta a una matriz de estructuras de MSG_INFO_0 .
1	Devuelve alias de mensaje. El parámetro bufptr apunta a una matriz de estructuras de MSG_INFO_1 . Este nivel solo existe para la compatibilidad. No se admite el reenvío de mensajes.

[out] bufptr

Puntero al búfer que recibe los datos. El formato de estos datos depende del valor del parámetro level . El sistema asigna este búfer y debe liberarse mediante la función NetApiBufferFree . Tenga en cuenta que debe liberar el búfer incluso si se produce un error en la función con ERROR_MORE_DATA.

[in] prefmaxlen

Especifica la longitud máxima preferida de los datos devueltos, en bytes. Si especifica MAX_PREFERRED_LENGTH, la función asigna la cantidad de memoria necesaria para los datos. Si 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] resume_handle

Puntero a un valor que contiene un identificador de reanudación que se usa para continuar con una búsqueda de alias de mensaje existente. El identificador debe ser cero en la primera llamada y dejar sin cambios para las llamadas posteriores. Si resume_handle 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 puede ser uno de los siguientes códigos de error.

Código devuelto	Descripción
ERROR_ACCESS_DENIED	El autor de la llamada no tiene el acceso adecuado para completar la operación.
ERROR_INVALID_LEVEL	El valor especificado para el parámetro level no es válido.
ERROR_INVALID_PARAMETER	Un parámetro es incorrecto.
ERROR_MORE_DATA	Hay más entradas disponibles. Especifique un búfer suficientemente grande para recibir todas las entradas.
ERROR_NOT_ENOUGH_MEMORY	Memoria insuficiente disponible.
ERROR_NOT_SUPPORTED	Esta solicitud no se admite. Este error se devuelve en Windows Vista y versiones posteriores.
NERR_BufTooSmall	El búfer proporcionado es demasiado pequeño.

Comentarios

Solo los miembros del grupo local Administradores pueden ejecutar correctamente la función NetMessageNameEnum en un servidor remoto.

Para recuperar información sobre un alias de mensaje determinado en la tabla de nombres de mensaje, puede llamar a la función NetMessageNameGetInfo .

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