IScanProfileMgr::GetProfiles method

Gets all the scan profiles available for the user in the system that your application is running under.

Syntax

HRESULT GetProfiles(
  [in, out] ULONG        *pulNumProfiles,
  [out]     IScanProfile **ppScanProfile
);

Parameters

pulNumProfiles [in, out]

Type: ULONG*

When passed, a pointer to the maximum number of profiles to be returned. When returned, a pointer to the number of profiles returned.

ppScanProfile [out]

Type: IScanProfile**

The address of an array of pointers to profiles.

Return value

Type: HRESULT

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

Remarks

If the total number of profiles available for the user is smaller than the value passed to pulNumProfiles, then pulNumProfiles returns that total. Otherwise, it returns the same value that was passed to it.

Requirements

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

See also

IScanProfileMgr

Scan Profile Schema