IAcpHal::PopMessage Method

Returns the oldest message in the message queue, and then removes the message from the queue.

Syntax

public:
bool PopMessage(
         ACP_MESSAGE *message
)  

Parameters

message
Type: ACP_MESSAGE *

[out] A copy of the oldest message in the queue. Refer to the ACP_MESSAGE structure.

Return value

Type: bool 

This method returns true if a message is available and was returned, and false otherwise.

Remarks

The message is copied to the memory pointed to by the message parameter.

Requirements

Header: Declared in acphal.h.

Library: Use acphal.lib.