> ## 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.

# ApuHeapGetState

> ApuHeapGetState

# ApuHeapGetState

Consulta o estado atual do heap físico da APU.

## Sintaxe

```cpp theme={null}
HRESULT ApuHeapGetState(  
         ApuHeapState* apuHeapState,  
         UINT32 flags = APU_ALLOC_CACHED  
)  
```

### Parâmetros

*apuHeapState*   \_Out\_\
Tipo: [ApuHeapState\*](/pt-BR/reference/audio/apu/structs/apuheapstate)

Estado atual do heap.

*flags*   \
Tipo: UINT32

Heap a ser consultado: `APU_ALLOC_CACHED` para o heap em cache ou `APU_ALLOC_NONCACHED` para o heap sem cache.

### Valor de retorno

Tipo: HRESULT

| Código de retorno | Descrição |
| :- | :- |
| S\_OK | Êxito |
| APU\_E\_HEAP\_NOT\_ALLOCATED | O heap da APU não foi alocado |
| E\_INVALIDARG | Argumento inválido |

## Comentários

Esta função retorna uma estrutura [ApuHeapState](/pt-BR/reference/audio/apu/structs/apuheapstate).

Para criar um heap da APU, chame [ApuCreateHeap](/pt-BR/reference/audio/apu/functions/apucreateheap). Um heap da APU persiste durante todo o tempo de vida do processo.

## Requisitos

**Cabeçalho:** apu.h

**Biblioteca:** acphal.lib

**Plataformas compatíveis:** consoles da família XBOX One e consoles XBOX Series

## Confira também

[ApuHeapState](/pt-BR/reference/audio/apu/structs/apuheapstate)\
[APU](/pt-BR/reference/audio/apu/apu_members)


## Related topics

- [ApuHeapState](/pt-BR/reference/audio/apu/structs/apuheapstate.md)
- [APU (Unidade de Processamento de Áudio)](/pt-BR/reference/audio/apu/apu_members.md)
- [ApuCreateHeap](/pt-BR/reference/audio/apu/functions/apucreateheap.md)
- [XApuStateOptions](/pt-BR/reference/audio/xapu/enums/xapustateoptions.md)
- [XApuProcessType](/pt-BR/reference/audio/xapu/enums/xapuprocesstype.md)