> ## Documentation Index
> Fetch the complete documentation index at: https://devdocs.xbox.com/llms.txt
> Use this file to discover all available pages before exploring further.

# IAcpHal::PopMessage

> IAcpHal::PopMessage

# IAcpHal::PopMessage

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

## Syntax

```cpp theme={null}
bool PopMessage(  
        ACP_MESSAGE * message
)  
```

### Parameters

*message*\
Type: [ACP\_MESSAGE\*](/reference/audio/acphal/structs/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](/reference/audio/acphal/structs/acp_message) structure.

To determine the number of messages in the message queue, use the [GetNumMessages](/reference/audio/acphal/interfaces/IAcpHal/methods/iacphal_getnummessages) method.

## Requirements

**Header:** acphal.h

**Supported platforms:** XBOX One family consoles and XBOX Series consoles

## See also

[ACP\_MESSAGE](/reference/audio/acphal/structs/acp_message)\
[GetNumMessages](/reference/audio/acphal/interfaces/IAcpHal/methods/iacphal_getnummessages)\
[AcpHal](/reference/audio/acphal/acphal_members)


## Related topics

- [IAcpHal](/reference/audio/acphal/interfaces/IAcpHal/iacphal.md)
- [IAcpHal::GetNumMessages](/reference/audio/acphal/interfaces/IAcpHal/methods/iacphal_getnummessages.md)
- [IAcpHal::Disconnect](/reference/audio/acphal/interfaces/IAcpHal/methods/iacphal_disconnect.md)
- [ACP_MESSAGE](/reference/audio/acphal/structs/acp_message.md)
- [IAcpHal::Connect](/reference/audio/acphal/interfaces/IAcpHal/methods/iacphal_connect.md)