Edit

IPortableDeviceValues::GetBoolValue method

  • Article

The GetBoolValue method retrieves a Boolean value (type VT_BOOL) specified by a key.

Syntax

HRESULT GetBoolValue(
  [in]  REFPROPERTYKEY key,
  [out] BOOL           *pValue
);

Parameters

key [in]

A REFPROPERTYKEY key that specifies the item to retrieve.

pValue [out]

Pointer to the retrieved BOOL value.

Return value

The method returns an HRESULT. Possible values include, but are not limited to, those in the following table.

Return code Description
S_OK
 The method succeeded.
DISP_E_TYPEMISMATCH
 The property specified by key is not a BOOL type.
HRESULT_FROM_WIN32(ERROR_NOT_FOUND)
 The property specified by key is not in the collection.

Examples

For an example of how to use this method, see Setting Properties for a Single Object.

Requirements

Requirement Value
Header
PortableDeviceTypes.h
Library
PortableDeviceGUIDs.lib

See also

IPortableDeviceValues Interface

IPortableDeviceValues::SetBoolValue

Retrieving Supported Service Events

Setting Properties for a Single Object

Writing Content-Object Properties