IScanProfile::SetName method

Sets the friendly name of the profile.

Syntax


HRESULT SetName(
  [in] BSTR bstrName
);

Parameters

bstrName [in]

Type: BSTR

The friendly name of the profile.

Return value

Type: HRESULT

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

Remarks

This method is required because the GUID of a profile cannot be used to display the scan profile to a user.

A user can change the friendly name of a profile with the ScanProfileDialog method.

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

Minimum supported client

Windows Vista [desktop apps only]

Minimum supported server

Windows Server 2008 [desktop apps only]

Header

Scanprofile.h

IDL

Scanprofiles.idl

 

 

Show: