Important:
This is retired content. This content is outdated and is no longer being maintained. It is provided as a courtesy for individuals who are still using these technologies. This content may contain URLs that were valid when originally published, but now link to sites or pages that no longer exist.
A version of this page is also available for
4/8/2010

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 pPropDataarray.

Return Value

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

Value Description

S_OK

Success.

E_PROP_SET_UNSUPPORTED

The property set is not supported.

E_PROP_ID_UNSUPPORTED

The property ID is not supported for the specified property set.

Remarks

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

The following ode queries a pin for its pin category, by retrieving the AMPROPERTY_PIN_CATEGORY property, see Pin Property Set.

Copy Code 
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

Windows Embedded CE Windows CE 5.0 Networked Media Device Feature Pack and later
Windows Mobile Pocket PC for Windows Mobile Version 5.0 and later, Smartphone for Windows Mobile Version 5.0 and later
Note Microsoft DirectShow applications and DirectShow filters have different include file and Library requirements
For more information, see Setting Up the Build Environment

See Also