共用方式為


PropVariantToUInt32WithDefault 函式 (propvarutil.h)

PROPVARIANT 結構擷取 ULONG 值。 如果沒有值存在,則會傳回指定的預設值。

語法

PSSTDAPI_(ULONG) PropVariantToUInt32WithDefault(
  [in] REFPROPVARIANT propvarIn,
  [in] ULONG          ulDefault
);

參數

[in] propvarIn

類型: REFPROPVARIANT

來源 PROPVARIANT 結構的參考。

[in] ulDefault

類型: ULONG

指定預設屬性值,用於目前不存在任何值的位置。

傳回值

類型: ULONG

傳回擷取的 ULONG 值或預設值。

備註

此協助程式函式用於呼叫端應用程式預期 PROPVARIANT 保留 ULONG 值的位置,而且如果不是,則會使用預設值。 例如,從屬性存放區取得值的應用程式可以使用這個來安全地擷取 UInt32 屬性的 ULONG 值。

如果來源 PROPVARIANT 的類型 VT_UI4,這個協助程式函式會擷取 ULONG 值。 否則,它會嘗試將 PROPVARIANT 結構中的值轉換成 ULONG。 如果來源 PROPVARIANT 有類型VT_EMPTY或無法轉換,則 PropVariantToUInt32WithDefault 會傳回 ulDefault 所提供的預設值。 如需可能轉換的清單 ,請參閱 PropVariantChangeType

範例

下列範例要包含在較大的程式中,示範如何使用 PropVariantToUInt32WithDefault 來存取 PROPVARIANT 中的 ULONG 值。

// IPropertyStore *ppropstore;
// Assume variable ppropstore is initialized and valid
PROPVARIANT propvar = {0};
HRESULT hr = ppropstore->GetValue(PKEY_Rating, &propvar);
if (SUCCEEDED(hr))
{
     // PKEY_Rating is expected to produce a VT_UI4 or VT_EMPTY value.
     // The application developer decided to treat VT_EMPTY or invalid values as 0
     ULONG uRating = PropVariantToUInt32WithDefault(propvar, 0);
     // uRating is now valid.
     PropVariantClear(&propvar);
}

規格需求

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

另請參閱

InitPropVariantFromUInt32

PropVariantChangeType

PropVariantToUInt32

VariantToUInt32