Freigeben über


CWiauPropertyList::D efineProperty-Methode (wiautil.h)

Die CWiauPropertyList::D efineProperty-Methode fügt einem Eigenschaftenlistenobjekt eine Eigenschaftendefinition hinzu.

Syntax

HRESULT DefineProperty(
  int      *pIdx,
  PROPID   PropId,
  LPOLESTR PropName,
  ULONG    Access,
  ULONG    SubType
);

Parameter

pIdx

Zeiger auf einen Speicherspeicherort, der den Index für die neu hinzugefügte Eigenschaft empfängt. Viele andere Methoden in dieser Klasse verwenden den Index einer Eigenschaft, um die Eigenschaft zu identifizieren.

PropId

Gibt eine Eigenschafts-ID-Konstante an.

PropName

Zeiger auf eine Namenszeichenfolge für die Eigenschaft.

Access

Gibt den Zugriffstyp für die Eigenschaft an, in der Regel entweder WIA_PROP_READ (schreibgeschützt) oder WIA_PROP_RW (Lese-/Schreibzugriff).

SubType

Gibt den Eigenschaftsuntertyp an, einer von WIA_PROP_FLAG, WIA_PROP_LIST, WIA_PROP_RANGE oder WIA_PROP_NONE. Die ersten drei Konstanten geben an, dass eine Eigenschaft ein Satz von Flagwerten, eine Liste von Werten oder ein Bereich von Werten ist. Die vierte Konstante gibt an, dass eine Eigenschaft keine dieser Eigenschaften ist.

Rückgabewert

Diese Methode gibt S_OK zurück, wenn eine Eigenschaft erfolgreich definiert werden kann. Wenn die Eigenschaftsliste nicht genügend Platz für eine zusätzliche Eigenschaft hat, gibt die Methode E_FAIL zurück.

Hinweise

Bevor eine Eigenschaft einer Eigenschaftsliste hinzugefügt werden kann, muss die Eigenschaftenliste initialisiert werden. Rufen Sie hierzu die CWiauPropertyList::Init-Methode auf.

Anforderungen

Anforderung Wert
Zielplattform Desktop
Kopfzeile wiautil.h (include Wiautil.h, Wiamindr.h)

Weitere Informationen

CWiauPropertyList

CWiauPropertyList::Init