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

# RegisterLampArrayStatusCallback 函式

> 註冊在 LampArray 狀態變更時觸發的 LampArrayStatusCallback，並控制初始裝置列舉是要封鎖還是以非同步方式執行。

# RegisterLampArrayStatusCallback

註冊每當 LampArray 狀態變更時要叫用的回呼函式。

## 語法

```cpp theme={null}
STDAPI RegisterLampArrayStatusCallback(
    _In_ LampArrayStatusCallback callbackFunc,
    LampArrayEnumerationKind enumerationKind,
    _In_opt_ void * context,
    _Out_ _Result_zeroonfailure_ LampArrayCallbackToken * callbackToken);
```

### 參數

*callbackFunc*   \_In\_
類型：[LampArrayStatusCallback](/zh-TW/reference/lighting/lamparray/functions/lamparraystatuscallback)

要註冊的呼叫端定義函式。當 LampArray 狀態變更時，將會叫用此函式。

*enumerationKind*\
類型：[LampArrayEnumerationKind](/zh-TW/reference/lighting/lamparray/enums/lamparrayenumerationkind)

指定 [LampArrayStatusCallback](/zh-TW/reference/lighting/lamparray/functions/lamparraystatuscallback) 函式所需的裝置列舉行為。

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

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

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

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

### 傳回值

類型：HRESULT

函式結果。

## 備註

LampArrayEnumerationKind 參數可讓呼叫端指定應如何接收此呼叫時已連接之任何 LampArray 裝置的回呼。如果選取 [LampArrayEnumerationKind::Blocking](/zh-TW/reference/lighting/lamparray/enums/lamparrayenumerationkind)，[RegisterLampArrayStatusCallback](/zh-TW/reference/lighting/lamparray/functions/registerlamparraystatuscallback) 函式將會封鎖，直到針對每個已連接的裝置叫用該回呼為止 (表示回呼將在呼叫執行緒上叫用)。

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

如果指定 [LampArrayEnumerationKind::Async](/zh-TW/reference/lighting/lamparray/enums/lamparrayenumerationkind)，此呼叫將立即傳回，而呼叫時已連線的任何 LampArray 都會在前述的 LampArray 回呼背景工作執行緒上列舉。

下列程式碼是註冊和取消註冊 [LampArrayStatusCallback](/zh-TW/reference/lighting/lamparray/functions/lamparraystatuscallback) 函式的範例：

```c++ theme={null}
void MyLampArrayStatusCallback(
    _In_opt_ void* context,
    LampArrayStatus currentStatus,
    LampArrayStatus previousStatus,
    _In_ ILampArray* lampArray)
{
    // Application-specific code to handle LampArray status changes
}

void MonitorLampArrays(
    _In_ volatile bool & cancelMonitoring) noexcept
{
    LampArrayCallbackToken token = LAMPARRAY_INVALID_CALLBACK_TOKEN_VALUE;
    if (SUCCEEDED(RegisterLampArrayStatusCallback(
        MyLampArrayStatusCallback,
        LampArrayEnumerationKind::Async,
        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)\
[LampArrayStatusCallback](/zh-TW/reference/lighting/lamparray/functions/lamparraystatuscallback)\
[UnregisterLampArrayCallback](/zh-TW/reference/lighting/lamparray/functions/unregisterlamparraycallback)\
[LampArrayEnumerationKind](/zh-TW/reference/lighting/lamparray/enums/lamparrayenumerationkind)


## Related topics

- [LampArray 基本概念](/zh-TW/build/core-features/common/lighting/lighting-basics.md)
- [LampArrayEnumerationKind 列舉參考](/zh-TW/reference/lighting/lamparray/enums/lamparrayenumerationkind.md)
- [LampArrayStatusCallback 函式參考](/zh-TW/reference/lighting/lamparray/functions/lamparraystatuscallback.md)
- [RegisterLampArrayCallback 函式參考](/zh-TW/reference/lighting/lamparray/functions/registerlamparraycallback.md)
- [LampArrayCallback 函式參考](/zh-TW/reference/lighting/lamparray/functions/lamparraycallback.md)