Skip to main content

IAcpHal::PopMessage

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

Syntax

Parameters

message
Type: ACP_MESSAGE*
A copy of the oldest message in the queue.

Return value

Type: bool If a message is available and was returned, the method returns true; otherwise, the method returns false.

Remarks

The message is copied to the memory pointed to by the message parameter. The message uses the ACP_MESSAGE structure. To determine the number of messages in the message queue, use the GetNumMessages method.

Requirements

Header: acphal.h Supported platforms: XBOX One family consoles and XBOX Series consoles

See also

ACP_MESSAGE
GetNumMessages
AcpHal
Last modified on August 20, 2026