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

# XStoreGetUserCollectionsIdAsync

> XStoreGetUserCollectionsIdAsync

# XStoreGetUserCollectionsIdAsync

Obtém uma ID de coleções do cliente. Essa ID pode então ser usada para validar o direito de um usuário a partir do seu próprio serviço com uma chamada B2B. Esta API é usada no fluxo descrito em [Gerenciar produtos de seus serviços](https://learn.microsoft.com/gaming/gdk/docs/store/commerce/service-to-service/service-to-service-nav).

## Sintaxe

```cpp theme={null}
HRESULT XStoreGetUserCollectionsIdAsync(  
         const XStoreContextHandle storeContextHandle,  
         const char* serviceTicket,  
         const char* publisherUserId,  
         XAsyncBlock* async  
)  
```

### Parâmetros

*storeContextHandle*   \_In\_\
Tipo: XStoreContextHandle

O identificador de contexto da loja do usuário retornado por [XStoreCreateContext](https://docs.xbox.com/pt-BR/reference/system/xstore/functions/xstorecreatecontext.md).

*serviceTicket*   \_In\_z\_\
Tipo: char\*

Um tíquete do Azure que pode ser usado pelo serviço de back-end para autorizar o usuário e o serviço. Isso permite obter de volta um tíquete do serviço, que você pode retransmitir para seus próprios servidores. Em seguida, seu servidor pode armazená-lo e usá-lo em chamadas B2B para verificar a propriedade ou conceder acesso.

*publisherUserId*   \_In\_z\_\
Tipo: char\*

Uma cadeia de caracteres gerada pelo desenvolvedor destinada a identificar o usuário atual como membro ou convidado de um serviço que pertence ao jogo, ao desenvolvedor ou ao editor. O conteúdo dessa cadeia de caracteres é determinado pelo desenvolvedor e pode ser deixado em branco.

*async*   \_Inout\_\
Tipo: [XAsyncBlock\*](https://docs.xbox.com/pt-BR/reference/system/xasync/structs/xasyncblock.md)

Um [XAsyncBlock](https://docs.xbox.com/pt-BR/reference/system/xasync/structs/xasyncblock.md) que define o trabalho assíncrono que está sendo feito. O [XAsyncBlock](https://docs.xbox.com/pt-BR/reference/system/xasync/structs/xasyncblock.md) pode ser usado para sondar o status da chamada e recuperar os resultados da chamada. Consulte [XAsyncBlock](https://docs.xbox.com/pt-BR/reference/system/xasync/structs/xasyncblock.md) para obter mais informações.

### Valor retornado

Tipo: HRESULT

Código de êxito ou de erro HRESULT.

## Comentários

No PC, esta API retornará informações do usuário conectado no momento à loja e não necessariamente do usuário que está jogando seu jogo, se os XBOX services estiverem habilitados. Se o seu título estiver no console XBOX ou tiver os XBOX services habilitados no PC, recomendamos fazer chamadas B2B para os pontos de extremidade de coleções e de visualização de licença usando a autorização delegada XSTS, para garantir que você esteja verificando os direitos do usuário que está jogando ativamente.

Para recuperar a ID de coleção do usuário, bem como o resultado da execução desta função, chame [XStoreGetUserCollectionsIdResult](https://docs.xbox.com/pt-BR/reference/system/xstore/functions/xstoregetusercollectionsidresult.md) após chamar esta função. Para recuperar o tamanho da ID de coleção do usuário, chame [XStoreGetUserCollectionsIdResultSize](https://docs.xbox.com/pt-BR/reference/system/xstore/functions/xstoregetusercollectionsidresultsize.md). Saber o tamanho do resultado permitirá que você o recupere com mais eficiência.

O snippet de código a seguir mostra um exemplo de recuperação de uma ID de coleções do cliente.

```cpp theme={null}
void CALLBACK GetUserCollectionsIdCallback(XAsyncBlock* asyncBlock)
{
    size_t size;
    HRESULT hr = XStoreGetUserCollectionsIdResultSize(
        asyncBlock,
        &size);

    if (FAILED(hr))
    {
        printf("Failed retrieve the user collection ID size: 0x%x\r\n", hr);
        return;
    }

    char* result = new char[size];
    hr = XStoreGetUserCollectionsIdResult(
        asyncBlock,
        size,
        result);

    if (FAILED(hr))
    {
        printf("Failed retrieve the user collection ID result: 0x%x\r\n", hr);
        delete[] result;
        return;
    }

    printf("result: %s\r\n", result);

    delete[] result;
}

void GetUserCollectionsId(XStoreContextHandle storeContextHandle, XTaskQueueHandle taskQueueHandle, const char* serviceTicket, const char* publisherUserId)
{
    auto asyncBlock = std::make_unique<XAsyncBlock>();
    ZeroMemory(asyncBlock.get(), sizeof(*asyncBlock));
    asyncBlock->queue = taskQueueHandle;
    asyncBlock->callback = GetUserCollectionsIdCallback;

    HRESULT hr = XStoreGetUserCollectionsIdAsync(
        storeContextHandle,
        serviceTicket,
        publisherUserId,
        asyncBlock.get());

    if (FAILED(hr))
    {
        printf("Failed to get user collections ID: 0x%x\r\n", hr);
        return;
    }
}
```

## Requisitos

**Cabeçalho:** XStore.h (incluído em XGameRuntime.h)

**Biblioteca:** xgameruntime.lib

**Plataformas com suporte:** Windows, consoles da família XBOX One e consoles XBOX Series

## Documentação conceitual

* [Solicitando uma ID da Loja do Usuário para autenticação serviço a serviço](https://docs.xbox.com/pt-BR/publishing/xstore-commerce/xstore-requesting-userstoreid.md)

## Confira também

[XStore](https://docs.xbox.com/pt-BR/reference/system/xstore/xstore_members.md)\
[XStoreGetUserCollectionsIdResult](https://docs.xbox.com/pt-BR/reference/system/xstore/functions/xstoregetusercollectionsidresult.md)\
[Gerenciar produtos de seus serviços](https://learn.microsoft.com/gaming/gdk/docs/store/commerce/service-to-service/service-to-service-nav)


## Related topics

- [XStoreGetUserCollectionsIdResult](https://docs.xbox.com/pt-BR/reference/system/xstore/functions/xstoregetusercollectionsidresult.md)
- [XStoreGetUserCollectionsIdResultSize](https://docs.xbox.com/pt-BR/reference/system/xstore/functions/xstoregetusercollectionsidresultsize.md)
- [Solicitar uma ID da Store do Usuário para autenticação de serviço para serviço](https://docs.xbox.com/pt-BR/publishing/xstore-commerce/xstore-requesting-userstoreid.md)
- [Visão geral dos sistemas de comércio do GDK](https://docs.xbox.com/pt-BR/publishing/xstore-commerce/xstore-commerce-overview.md)
- [XStore (conteúdo da API)](https://docs.xbox.com/pt-BR/reference/system/xstore/xstore_members.md)