PropVariantToBooleanVector 函式 (propvarutil.h)
從 PROPVARIANT 結構擷取布林向量。
語法
PSSTDAPI PropVariantToBooleanVector(
[in] REFPROPVARIANT propvar,
[out] BOOL *prgf,
[in] ULONG crgf,
[out] ULONG *pcElem
);
參數
[in] propvar
類型: REFPROPVARIANT
來源 PROPVARIANT 結構的參考。
[out] prgf
類型: BOOL*
指向包含 crgfBOOL 值的緩衝區。 當此函式傳回時,緩衝區已使用從來源PROPVARIANT結構擷取的 pcElem布林值元素初始化。
[in] crgf
類型: ULONG
prgf所指向之緩衝區中的元素數目。
[out] pcElem
類型: ULONG*
當此函式傳回時,包含從來源 PROPVARIANT 結構擷取的布林專案計數。
傳回值
類型: HRESULT
此函式可以傳回下列其中一個值。
傳回碼 | 描述 |
---|---|
|
如果成功,則傳回 S_OK ,否則傳回錯誤值。 |
|
來源 PROPVARIANT 包含超過 crgf 值。 prgf指向的緩衝區。 |
|
PROPVARIANT不是適當的類型。 |
備註
當呼叫的應用程式預期 PROPVARIANT 保留具有固定專案數目的布林向量值時,就會使用這個協助程式函式。
如果來源 PROPVARIANT 的類型VT_VECTOR |VT_BOOL或VT_ARRAY |VT_BOOL,此協助程式函式會擷取最多 crgf 布林值,並將其放入 prgf所指向的緩衝區中。 如果 PROPVARIANT 包含的專案超過將放入 prgf 緩衝區中,此函式會傳回錯誤,並將 pcElem 設定為 0。
範例
下列範例要包含在較大的程式中,示範如何使用 PropVariantToBooleanVector 來存取儲存在 PROPVARIANT中的布林向量。
// PROPVARIANT propvar;
// Assume the variable propvar is initialized and valid.
// The application is expecting the propvar variable to hold 4 Booleans
// in a vector.
BOOL rgFlags[4];
ULONG cFlags;
HRESULT hr = PropVariantToBooleanVector(propvar, rgFlags, ARRAYSIZE(rgFlags), &cFlags);
if (SUCCEEDED(hr))
{
if (cFlags == ARRAYSIZE(rgFlags))
{
// The application received 4 flags which are now stored in rgFlags.
}
else
{
// The application received cFlags flags which are now 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 |