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

# XGameActivationCallback

> XGameActivationCallback

# XGameActivationCallback

A callback an application defines for activation events.

## Syntax

```cpp theme={null}
void CALLBACK XGameActivationCallback(  
         void* context,  
         const XGameActivationInfo* activationInfo  
)  
```

### Parameters

*context*   \_In\_opt\_\
Type: void\*

The context passed to [XGameActivationRegisterForEvent](/reference/system/xgameactivation/functions/xgameactivationregisterforevent).

*activationInfo*   \_In\_\
Type: [XGameActivationInfo](/reference/system/xgameactivation/structs/xgameactivationinfo)\*

A pointer to an [XGameActivationInfo](/reference/system/xgameactivation/structs/xgameactivationinfo) structure that contains the activation information. The `type` field indicates the kind of activation, and the corresponding union field contains the relevant data.

### Return value

Type: void

## Remarks

To register a callback for activation events, call [XGameActivationRegisterForEvent](/reference/system/xgameactivation/functions/xgameactivationregisterforevent). The function uses a pointer to an **XGameActivationCallback** as an argument.

To unregister a callback for activation events, call [XGameActivationUnregisterForEvent](/reference/system/xgameactivation/functions/xgameactivationunregisterforevent).

The callback receives an [XGameActivationInfo](/reference/system/xgameactivation/structs/xgameactivationinfo) structure. Check the `type` field to determine the kind of activation and handle each type appropriately.

<Note>This callback replaces both `XGameProtocolActivationCallback` and `XGameInviteEventCallback`. See [XGameActivation](/reference/system/xgameactivation/xgameactivation_members) for migration guidance.</Note>

The following code sample registers for an activation callback and handles all activation types.

```cpp theme={null}
#include <XTaskQueue.h>
#include <XGameActivation.h>

XTaskQueueHandle g_taskQueue;
XTaskQueueRegistrationToken g_activationToken;

void CALLBACK OnActivation(void* context, const XGameActivationInfo* activationInfo)
{
    switch (activationInfo->type)
    {
    case XGameActivationType::Protocol:
        // Perform your game action based on activationInfo->protocolUri
        HandleProtocolActivation(activationInfo->protocolUri);
        return;

    case XGameActivationType::File:
        // e.g. Load the game file; activationInfo->file
        HandleFileActivation(activationInfo->file);
        return;

    case XGameActivationType::PendingGameInvite:
        // Game has received a game invite. Handle it by giving the user the option to
        // accept or reject the invite via UI.
        {
            bool userAcceptsInvite = HandlePendingGameInviteWithUI(activationInfo->inviteUri);
            if (userAcceptsInvite)
            {
                XGameActivationAcceptPendingInvite(activationInfo->inviteUri);
            }
        }
        return;

    case XGameActivationType::AcceptedGameInvite:
        // e.g. Join the game session that we are invited to
        HandleGameInvite(activationInfo->inviteUri);
        return;

    default:
        // Other unknown activation types. Just ignore.
        return;
    }
}

void InitializeGame()
{
    XGameActivationRegisterForEvent(g_taskQueue, nullptr, OnActivation, &g_activationToken);
}

void ShutdownGame()
{
    XGameActivationUnregisterForEvent(g_activationToken, true);
}
```

## Requirements

**Header:** XGameActivation.h

**Library:** xgameruntime.lib

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

## Conceptual documentation

* [File type activation](https://learn.microsoft.com/gaming/gdk/docs/gdk-dev/overviews/filetypeactivation)
* [Receiving invites](/services/xbox-services/multiplayer/invites/how-to/live-invites-receive)

## See also

[XGameActivation](/reference/system/xgameactivation/xgameactivation_members)

[XGameActivationRegisterForEvent](/reference/system/xgameactivation/functions/xgameactivationregisterforevent)

[XGameActivationUnregisterForEvent](/reference/system/xgameactivation/functions/xgameactivationunregisterforevent)

[XGameActivationInfo](/reference/system/xgameactivation/structs/xgameactivationinfo)

[XGameActivationType](/reference/system/xgameactivation/enums/xgameactivationtype)


## Related topics

- [XGameActivation](/reference/system/xgameactivation/xgameactivation_members.md)
- [XGameActivationUnregisterForEvent](/reference/system/xgameactivation/functions/xgameactivationunregisterforevent.md)
- [XGameActivationRegisterForEvent](/reference/system/xgameactivation/functions/xgameactivationregisterforevent.md)
- [XGameProtocolActivationCallbackXGameProtocol (deprecated)](/reference/system/xgameprotocol/functions/xgameprotocolactivationcallback.md)
- [XGameActivationType](/reference/system/xgameactivation/enums/xgameactivationtype.md)