IKsPropertySet::Get-Methode

Die Get-Methode ruft eine Eigenschaft ab, die durch eine Eigenschaftensatz-GUID und eine Eigenschaften-ID identifiziert wird.

Syntax

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

Parameter

guidPropSet [ In]

Die GUID des Eigenschaftensatzes.

dwPropID [ In]

Der Bezeichner der Eigenschaft innerhalb des Eigenschaftensatzes.

pInstanceData [ In]

Ein Zeiger auf ein Bytearray, das Instanzdaten für die Eigenschaft enthält.

cbInstanceData [ In]

Die Größe des in pInstanceData angegebenen Arrays in Bytes.

pPropData [ out]

Ein Zeiger auf ein Bytearray, das die Eigenschaftsdaten empfängt.

cbPropData [ In]

Die Größe des in pPropData angegebenen Arrays in Bytes.

pwReturned [ out]

Empfängt die Anzahl der Bytes, die die Methode in das pPropData-Array kopiert.

Rückgabewert

Gibt einen HRESULT-Wert zurück. Die folgenden Werte sind möglich.

Rückgabecode Beschreibung
S _ OK
Erfolg.
E _ PROP SET NICHT _ _ UNTERSTÜTZT
Der Eigenschaftensatz wird nicht unterstützt.
E _ PROP _ ID _ UNSUPPORTED
Die Eigenschaften-ID wird für den angegebenen Eigenschaftensatz nicht unterstützt.

Bemerkungen

Hinweis

Eine andere Schnittstelle mit diesem Namen ist in der Headerdatei dsound.h vorhanden. Die beiden Schnittstellen sind nicht kompatibel. Die IKsControl-Schnittstelle, die im DirectShow DDK dokumentiert ist, ist jetzt die empfohlene Schnittstelle zum Übergeben von Eigenschaftensätzen zwischen WDM-Treibern und Benutzermoduskomponenten.

Um eine Eigenschaft abzurufen, ordnen Sie einen Puffer zu, den diese Methode dann ausfüllt. Um die erforderliche Puffergröße zu bestimmen, geben Sie NULL für pPropData und null (0) für cbPropData an. Diese Methode gibt die erforderliche Puffergröße in "pwReturned" zurück.

Sie müssen Ks.h vor Ksproxy.h einschließen.

Beispiele

Im folgenden Beispiel wird ein Pin für seine Pinkategorie abgefragt, indem die EIGENSCHAFT AMPROPERTY _ PIN _ CATEGORY abgerufen wird. (Weitere Informationen finden Sie unter Anheften des Eigenschaftensatzes.)

HRESULT GetPinCategory(IPin *pPin, GUID *pPinCategory)
{
    IKsPropertySet *pKs = NULL;

    HRESULT hr = pPin->QueryInterface(IID_PPV_ARGS(&pKs));
    if (FAILED(hr))
    {
        return hr;
    }

    // Try to retrieve the pin category.
    DWORD cbReturned = 0;
    hr = pKs->Get(AMPROPSETID_Pin, AMPROPERTY_PIN_CATEGORY, NULL, 0, 
        pPinCategory, sizeof(GUID), &cbReturned);
    
    // If this succeeded, pPinCategory now contains the category GUID.

    SafeRelease(&pKs);
    return hr;
}

Requirements (Anforderungen)

Anforderung Wert
Unterstützte Mindestversion (Client)
Windows 2000 Professional [nur Desktop-Apps]
Unterstützte Mindestversion (Server)
Windows 2000 Server [nur Desktop-Apps]
Header
Ksproxy.h
Bibliothek
Strmiids.lib

Weitere Informationen

Fehler- und Erfolgscodes

IKsPropertySet-Schnittstelle

Eigenschaftensätze