Share via

ReadMsgQueue

  • Artigo

Windows Mobile SupportedWindows Embedded CE Supported

9/8/2008

Esta função lê uma única mensagem de um fila de mensagens.

Syntax

BOOL ReadMsgQueue(
  HANDLE hMsgQ,
  LPVOID lpBuffer,
  DWORD cbBufferSize,
  LPDWORD lpNumberOfBytesRead,
  DWORD dwTimeout,
  DWORD* pdwFlags
);

Parameters

  • hMsgQ
    [no] Identificador para um aberto fila de mensagens.
  • lpBuffer
    [out] Ponteiro para uma reserva para armazenar um ler mensagem. Esse parâmetro não pode ser NULL.
  • cbBufferSize
    [no] Tamanho da reserva, em bytes, especificados por lpBuffer. Este parâmetro não pode ser 0 (zero).
  • lpNumberOfBytesRead
    [out] Número de bytes armazenados em lpBuffer. Esse parâmetro não pode ser NULL.
  • dwTimeout
    [no] Tempo em milissegundos (ms) antes de operação de leitura expirar. Se definido como zero, o irá operação de leitura não bloco se não houver nenhum dados para ler. Se definido como infinito, o operação de leitura será bloco até que dados esteja disponível ou o status das alterações de fila.
  • pdwFlags
    [out] Ponteiro para um DWORD Para indicar as propriedades da mensagem. Um valor de MSGQUEUE_MSGALERT especifica que a mensagem é um mensagem de alerta.

Return Value

TRUE indica sucesso. FALSE indica falha. Para obter informações de erro estendidas, chamar GetLastError. A seguinte tabela mostra possíveis valores retornados por GetLastError.

Valor Descrição

ERROR_INSUFFICIENT_BUFFER

A reserva especificada por lpBuffer é muito pequeno para ler uma mensagem. O operação de leitura bem-sucedida, mas somente cbBufferSize bytes de dados foram copiados.

ERROR_PIPE_NOT_CONNECTED

Nenhum gravadores foram anexado a fila de mensagens e MSGQUEUE_ALLOW_BROKEN não foi especificado. Todos os gravadores encerrado enquanto um leitor foi bloqueado e MSGQUEUE_ALLOW_BROKEN não foi especificado. Falha de operação de leitura.

ERROR_TIMEOUT

O dwTimeout parâmetro foi definido para zero, e houve há dados para ler.

Requirements

Header msgqueue.h
Library coredll.lib
Windows Embedded CE Windows CE .NET 4.0 and later
Windows Mobile Windows Mobile Version 5.0 and later

See Also

Reference

Message Queue Point-to-Point Functions
CloseMsgQueue
CreateMsgQueue
GetMsgQueueInfo
MSGQUEUEINFO
MSGQUEUEOPTIONS
OpenMsgQueue
ReadMsgQueue
WriteMsgQueue

Other Resources

Message Queue Point-to-Point