IScanProfile::RemoveProperty method

Removes a specified list of child properties in the <Properties> element of a scan profile.

Syntax

HRESULT RemoveProperty(
  [in] ULONG  num,
  [in] PROPID *pid
);

Parameters

num [in]

Type: ULONG

The number of entries in the array that pid points to.

pid [in]

Type: PROPID*

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

Return value

Type: HRESULT

If this method succeeds, it returns S_OK. Otherwise, it returns an HRESULT error code.

Remarks

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.

Changes to a profile are not saved to disk until the application calls the IScanProfile::Save method.

If two applications create scan profile objects from the same XML file, and each application writes changes to its object, only the changes made by the application that calls IScanProfile::Save last are saved to disk.

Requirements

See also

IScanProfile

Conceptual

Scan Profile Schema

WIA Property Constants

Defining Custom Properties