IKsPropertySet::Get (Compact 2013)

3/26/2014

This method retrieves a property identified by a property set GUID and a property ID.

Syntax

HRESULT Get(
  REFGUID guidPropSet,
  DWORD   dwPropID,
  LPVOID  pInstanceData,
  DWORD   cbInstanceData,
  LPVOID  pPropData,
  DWORD   cbPropData,
  DWORD*  pcbReturned
);

Parameters

• guidPropSet
  [in] A REFGUID value that specifies the GUID of the property set.

• dwPropID
  [in] A DWORD value that specifies the identifier of the property within the property set.

• pInstanceData
  [in] An LPVOID value that is a pointer to an array of bytes that contains instance data for the property.

• cbInstanceData
  [in] A DWORD value that specifies the size of the array given in pInstanceData.

• pPropData
  [out] An LPVOID value that is a pointer to an array of bytes that receives the property data.

• cbPropData
  [in] A DWORD value that specifies the size of the array given in pPropData.

• pcbReturned
  [out] A pointer to a DWORD variable that receives the number of bytes the method returned in the pPropData array.

Return Value

Returns an HRESULT value. The following table shows some of the possible return values.

Remarks

To retrieve a property, allocate a buffer for this method to fill in. To determine the necessary buffer size, specify NULL for pPropData and zero (0) for cbPropData. This method returns the necessary buffer size in pcbReturned.

The following code queries a pin for its pin category, by retrieving the AMPROPERTY_PIN_CATEGORY property.

IKsPropertySet *pKs;
GUID guid;
DWORD cbBytes;
/* Query the pin for IKsProperty Set (not shown.) */
pKs->Get(AMPROPSETID_Pin, AMPROPERTY_PIN_CATEGORY, NULL, 0, &guid, 
    sizeof(GUID), &cbBytes);
pKs->Release();

Requirements

See Also

Reference

IKsPropertySet Interface