IScanProfile::GetProperty method

Gets the value of specified child properties in the <Properties> element of a scan profile.

Syntax

HRESULT GetProperty(
  [in]  ULONG       num,
  [in]  PROPID      *pid,
  [out] PROPVARIANT *pvar
);

Parameters

num [in]

Type: ULONG

The number of entries in the arrays that are pointed to by pid and pvar.

pid [in]

Type: PROPID*

A pointer to an array of the identification numbers of the properties to be set. Each value in the array is a WIA Property Constants.

pvar [out]

Type: PROPVARIANT*

A pointer to an array of values.

Return value

Type: HRESULT

Returns S_FALSE if any of the property values is not available; otherwise, returns S_OK or a standard COM error code.

Remarks

The type of each value must be the same type that was set with the call to IScanProfile::SetProperty.

Each value in the array that pid points to is one of the WIA Property Constants. You can extend this identification system. See Defining Custom Properties.

Requirements

Requirement	Value
Minimum supported client	Windows Vista [desktop apps only]
Minimum supported server	Windows Server 2008 [desktop apps only]
Header	Scanprofile.h
IDL	Scanprofiles.idl

See also

IScanProfile

Conceptual

Scan Profile Schema

WIA Property Constants

Defining Custom Properties