Função NetMessageNameEnum (lmmsg.h)
[Não há suporte para essa função a partir do Windows Vista porque não há suporte para o serviço de mensagens.]
A função NetMessageNameEnum lista os aliases de mensagem que recebem mensagens em um computador especificado. A função requer que o serviço de mensagens seja iniciado.
Sintaxe
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
Ponteiro para uma cadeia de caracteres constante que especifica o nome DNS ou NetBIOS do servidor remoto no qual a função deve ser executada. Se esse parâmetro for NULL, o computador local será usado.
[in] level
Especifica o nível de informações dos dados. Esse parâmetro pode usar um dos valores a seguir.
| Valor | Significado |
|---|---|
|
Retornar aliases de mensagem. O parâmetro bufptr aponta para uma matriz de estruturas MSG_INFO_0 . |
|
Retornar aliases de mensagem. O parâmetro bufptr aponta para uma matriz de estruturas MSG_INFO_1 . Esse nível existe apenas para compatibilidade. Não há suporte para o encaminhamento de mensagens. |
[out] bufptr
Ponteiro para o buffer que recebe os dados. O formato desses dados depende do valor do parâmetro level . Esse buffer é alocado pelo sistema e deve ser liberado usando a função NetApiBufferFree . Observe que você deve liberar o buffer mesmo que a função falhe com ERROR_MORE_DATA.
[in] prefmaxlen
Especifica o comprimento máximo preferencial dos dados retornados, em bytes. Se você especificar MAX_PREFERRED_LENGTH, a função alocará a quantidade de memória necessária para os dados. Se você especificar outro valor nesse parâmetro, ele poderá restringir o número de bytes retornados pela função. Se o tamanho do buffer for insuficiente para manter todas as entradas, a função retornará ERROR_MORE_DATA. Para obter mais informações, consulte Buffers de função de gerenciamento de rede e Comprimentos de buffer de função de gerenciamento de rede.
[out] entriesread
Ponteiro para um valor que recebe a contagem de elementos realmente enumerados.
[out] totalentries
Ponteiro para um valor que recebe o número total de entradas que poderiam ter sido enumeradas da posição de currículo atual. Observe que os aplicativos devem considerar esse valor apenas como uma dica.
[in, out] resume_handle
Ponteiro para um valor que contém um identificador de retomada que é usado para continuar uma pesquisa de alias de mensagem existente. O identificador deve ser zero na primeira chamada e deixado inalterado para chamadas subsequentes. Se resume_handle for NULL, nenhum identificador de retomada será armazenado.
Valor retornado
Se a função for bem-sucedida, o valor retornado será NERR_Success.
Se a função falhar, o valor retornado poderá ser um dos códigos de erro a seguir.
| Código de retorno | Descrição |
|---|---|
|
O chamador não tem o acesso apropriado para concluir a operação. |
|
O valor especificado para o parâmetro level é inválido. |
|
Um parâmetro está incorreto. |
|
Mais entradas estão disponíveis. Especifique um buffer grande o suficiente para receber todas as entradas. |
|
Memória insuficiente disponível. |
|
Não há suporte para essa solicitação. Esse erro é retornado no Windows Vista e posterior. |
|
O buffer fornecido é muito pequeno. |
Comentários
Somente os membros do grupo local Administradores podem executar com êxito a função NetMessageNameEnum em um servidor remoto.
Para recuperar informações sobre um alias de mensagem específico na tabela de nomes de mensagem, você pode chamar a função NetMessageNameGetInfo .
Requisitos
| Cliente mínimo com suporte | Windows 2000 Professional [somente aplicativos da área de trabalho] |
| Servidor mínimo com suporte | Windows 2000 Server [somente aplicativos da área de trabalho] |
| Plataforma de Destino | Windows |
| Cabeçalho | lmmsg.h (inclua Lm.h) |
| Biblioteca | Netapi32.lib |
| DLL | Netapi32.dll |