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

# RegisterLampArrayCallback 函式參考

> 註冊在 LampArray 周邊裝置連線或中斷連線時觸發的 LampArrayCallback，並傳回權杖以供稍後取消註冊。

# RegisterLampArrayCallback

註冊每當 LampArray 連線到系統或從系統中斷連線時要叫用的回呼函式。

## 語法

```cpp theme={null}
HRESULT RegisterLampArrayCallback(
    LampArrayCallback lampArrayCallback,
    void* context,
    LampArrayCallbackToken* callbackToken);
```

### 參數

*lampArrayCallback*   \_In\_
類型：[LampArrayCallback](/zh-TW/reference/lighting/lamparray/functions/lamparraycallback)

要註冊的呼叫端定義函式。當 LampArray 連線到系統或從系統中斷連線時，將會叫用此函式。

*context*   \_In\_opt\_\
類型：void\*

指向物件的指標，該物件包含回呼函式的相關資訊。這通常是呼叫物件。

*callbackToken*   \_Out\_ \_Result\_zeroonfailure\_
類型：LampArrayCallbackToken\*

可用於稍後取消註冊回呼函式的權杖值。

### 傳回值

類型：HRESULT

函式結果。

## 備註

如果在註冊回呼時已連接任何 LampArray 裝置，RegisterLampArrayCallback 函式將會封鎖，直到針對每個已連接的裝置叫用該回呼為止 (表示回呼將在呼叫執行緒上叫用)。

註冊第一個回呼時，LampArray API 會啟動背景工作執行緒來處理 ILampArray 裝置連接和移除通知。這些事件並不頻繁，背景工作執行緒在其他時間會維持在等候狀態。註冊呼叫傳回之後，所有後續的 LampArrayCallback 都會在此背景工作執行緒上依序叫用。

下列程式碼是註冊和取消註冊 LampArray 回呼的範例：

```cpp theme={null}
void MyLampArrayCallback(
    _In_opt_ void* context,
    bool isAttached,
    _In_ ILampArray* lampArray)
{
    if (isAttached)
    {
        // Application-specific code to handle LampArray connection
    }
    else
    {
        // Application-specific code to handle LampArray disconnection
    }
}

void MonitorLampArrays(
    _In_ volatile bool & cancelMonitoring) noexcept
{
    LampArrayCallbackToken token = LAMPARRAY_INVALID_CALLBACK_TOKEN_VALUE;
    if (SUCCEEDED(RegisterLampArrayCallback(
        MyLampArrayCallback,
        nullptr /* context */,
        &token)))
    {
        while (!cancelMonitoring)
        {
            Sleep(100);
        }

        UnregisterLampArrayCallback(token, 5000);
    }
}
```

## 需求

**標頭：** LampArray.h

**程式庫：** xgameplatform.lib

**支援的平台：** XBOX One 系列主機和 XBOX Series 主機

## 另請參閱

[照明 API 概觀](/zh-TW/build/core-features/common/lighting/gc-lighting-toc)\
[照明基本概念](/zh-TW/build/core-features/common/lighting/lighting-basics)\
[LampArrayCallback](/zh-TW/reference/lighting/lamparray/functions/lamparraycallback)\
[UnregisterLampArrayCallback](/zh-TW/reference/lighting/lamparray/functions/unregisterlamparraycallback)


## Related topics

- [RegisterLampArrayCallback](/ja-jp/reference/lighting/lamparray/functions/registerlamparraycallback.md)
- [RegisterLampArrayCallback function reference](/reference/lighting/lamparray/functions/registerlamparraycallback.md)
- [Referencia de la función RegisterLampArrayCallback](/es/reference/lighting/lamparray/functions/registerlamparraycallback.md)
- [LampArray](/ko/reference/lighting/lamparray/lamparray_members.md)
- [LampArrayCallback](/zh-CN/reference/lighting/lamparray/functions/lamparraycallback.md)