VariantToBooleanArray 函式 (propvarutil.h)

發行項
03/05/2024

從 VARIANT 結構擷取布爾值陣列。

語法

PSSTDAPI VariantToBooleanArray(
  [in]  REFVARIANT var,
  [out] BOOL       *prgf,
  [in]  ULONG      crgn,
  [out] ULONG      *pcElem
);

參數

[in] var

類型： REFVARIANT

來源 VARIANT 結構的參考。

[out] prgf

類型： BOOL*

緩衝區的指標，其中包含 crgn 布爾值。當此函式傳回時，緩衝區已使用從來源 VARIANT 結構擷取的 *pcElemBOOL 元素初始化。

[in] crgn

類型： ULONG

prgf 所指向之緩衝區中的元素數目。

[out] pcElem

類型： ULONG*

當此函式傳回時，會包含從來源 VARIANT 結構擷取之 BOOL 元素計數的指標。

傳回值

類型： HRESULT

如果成功，則傳回 S_OK ，否則傳回錯誤值，包括下列專案：

傳回碼	Description
TYPE_E_BUFFERTOOSMALL	來源 VARIANT 包含超過 crgn 值。
E_INVALIDARG	VARIANT 不是適當的類型。

備註

當呼叫的應用程式預期 VARIANT 會保存包含固定數目布爾值的陣列時，就會使用這個協助程式函式。

如果來源 VARIANT 的類型為 VT_ARRAY |VT_BOOL，此函式會擷取最多 crgnBOOL 值，並將其放入 prgf 所指向的緩衝區中。如果 VARIANT 包含的項目超過符合 prgf 緩衝區的專案，此函式會傳回錯誤，並將 *pcElem 設定為 0。

範例

下列範例要包含在較大的程式中，示範如何使用 VariantToBooleanArray 來存取儲存在 VARIANT 結構中的 BOOL 值陣列。

// VARIANT var;
// Assume variable var is initialized and valid
BOOL rgFlags[4]; // The application is expecting var to hold 4 BOOLs in an array.
ULONG cFlags;

HRESULT hr = VariantToBooleanArray(var, rgFlags, ARRAYSIZE(rgFlags), &cFlags);

if (SUCCEEDED(hr))
{
    if (cFlags == ARRAYSIZE(rgFlags))
    {
        // The application got 4 flag values which are now stored in rgFlags.
    }
    else
    {
        // The application got cFlags which are stored in the first cFlags 
        // elements of rgFlags.
    }
}

規格需求

需求	值
最低支援的用戶端	Windows XP 搭配 SP2、Windows Vista [僅限傳統型應用程式]
最低支援的伺服器	Windows Server 2003 SP1 [僅限傳統型應用程式]
目標平台	Windows
標頭	propvarutil.h
程式庫	Propsys.lib
Dll	Propsys.dll (6.0 版或更新版本)
可轉散發套件	Windows 桌面搜尋 (WDS) 3.0