Compartilhar via


Função GetMailslotInfo (winbase.h)

Recupera informações sobre o maillot especificado.

Sintaxe

BOOL GetMailslotInfo(
  [in]            HANDLE  hMailslot,
  [out, optional] LPDWORD lpMaxMessageSize,
  [out, optional] LPDWORD lpNextSize,
  [out, optional] LPDWORD lpMessageCount,
  [out, optional] LPDWORD lpReadTimeout
);

Parâmetros

[in] hMailslot

Um identificador para um maillot. A função CreateMailslot deve criar esse identificador.

[out, optional] lpMaxMessageSize

O tamanho máximo da mensagem, em bytes, permitido para este emaillot. Esse valor pode ser maior ou igual ao valor especificado no parâmetro cbMaxMsg da função CreateMailslot que criou o maillot. Este parâmetro pode ser NULL.

[out, optional] lpNextSize

O tamanho da próxima mensagem, em bytes. O valor a seguir tem um significado especial.

Valor Significado
MAILSLOT_NO_MESSAGE
((DWORD)-1)
Não há nenhuma próxima mensagem.
 

Este parâmetro pode ser NULL.

[out, optional] lpMessageCount

O número total de mensagens aguardando para serem lidas, quando a função retorna. Este parâmetro pode ser NULL.

[out, optional] lpReadTimeout

A quantidade de tempo, em milissegundos, uma operação de leitura pode esperar que uma mensagem seja gravada no maillot antes que ocorra um tempo limite. Esse parâmetro é preenchido quando a função retorna. Este parâmetro pode ser NULL.

Valor retornado

Se a função for bem-sucedida, o valor retornado será diferente de zero.

Se a função falhar, o valor retornado será zero. Para obter informações de erro estendidas, chame GetLastError.

Requisitos

Requisito Valor
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 winbase.h (inclua Windows.h)
Biblioteca Kernel32.lib
DLL Kernel32.dll

Confira também

CreateMailslot

Funções do Maillot

Visão geral do Maillots

SetMailslotInfo