CWiauPropertyList ::D efineProperty, méthode (wiautil.h)
La méthode CWiauPropertyList ::D efineProperty ajoute une définition de propriété à un objet de liste de propriétés.
Syntaxe
HRESULT DefineProperty(
int *pIdx,
PROPID PropId,
LPOLESTR PropName,
ULONG Access,
ULONG SubType
);
Paramètres
pIdx
Pointeur vers un emplacement de mémoire qui reçoit l’index pour la propriété nouvellement ajoutée. De nombreuses autres méthodes de cette classe utilisent l’index d’une propriété pour identifier la propriété.
PropId
Spécifie une constante d’ID de propriété.
PropName
Pointeur vers une chaîne de nom pour la propriété.
Access
Spécifie le type d’accès pour la propriété, généralement WIA_PROP_READ (lecture seule) ou WIA_PROP_RW (lecture/écriture).
SubType
Spécifie le sous-type de propriété, l’un des WIA_PROP_FLAG, WIA_PROP_LIST, WIA_PROP_RANGE ou WIA_PROP_NONE. Les trois premières constantes indiquent, respectivement, qu’une propriété est un ensemble de valeurs d’indicateur, une liste de valeurs ou une plage de valeurs. La quatrième constante indique qu’une propriété n’est pas de celles-ci.
Valeur de retour
Cette méthode retourne S_OK si elle est en mesure de définir une propriété avec succès. Si la liste des propriétés n’a pas suffisamment de place pour une propriété supplémentaire, la méthode retourne E_FAIL.
Remarques
Avant qu’une propriété puisse être ajoutée à une liste de propriétés, la liste des propriétés doit être initialisée. Pour ce faire, appelez la méthode CWiauPropertyList ::Init.
Exigences
| Exigence | Valeur |
|---|---|
| plateforme cible | Bureau |
| d’en-tête | wiautil.h (include Wiautil.h, Wiamindr.h) |