Método CWiauPropertyList::D efineProperty (wiautil.h)

O método CWiauPropertyList::D efineProperty adiciona uma definição de propriedade a um objeto de lista de propriedades.

Sintaxe

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

Parâmetros

pIdx

Ponteiro para um local de memória que recebe o índice da propriedade recém-adicionada. Muitos outros métodos nessa classe usam o índice de uma propriedade para identificar a propriedade.

PropId

Especifica uma constante de ID de propriedade.

PropName

Ponteiro para uma cadeia de caracteres de nome para a propriedade .

Access

Especifica o tipo de acesso para a propriedade, geralmente WIA_PROP_READ (somente leitura) ou WIA_PROP_RW (leitura/gravação).

SubType

Especifica o subtipo de propriedade, um dos WIA_PROP_FLAG, WIA_PROP_LIST, WIA_PROP_RANGE ou WIA_PROP_NONE. As três primeiras constantes indicam, respectivamente, que uma propriedade é um conjunto de valores de sinalizador, uma lista de valores ou um intervalo de valores. A quarta constante indica que uma propriedade não é nenhuma destas.

Retornar valor

Esse método retornará S_OK se for capaz de definir uma propriedade com êxito. Se a lista de propriedades não tiver espaço suficiente para uma propriedade adicional, o método retornará E_FAIL.

Comentários

Antes que uma propriedade possa ser adicionada a uma lista de propriedades, a lista de propriedades deve ser inicializada. Faça isso chamando o método CWiauPropertyList::Init .

Requisitos

Confira também

CWiauPropertyList

CWiauPropertyList::Init