IFileSaveDialog::SetProperties method (shobjidl_core.h)

Article
10/13/2021

Provides a property store that defines the default values to be used for the item being saved.

Syntax

HRESULT SetProperties(
  [in] IPropertyStore *pStore
);

Parameters

[in] pStore

Type: IPropertyStore*

Pointer to the interface that represents the property store that contains the associated metadata.

Return value

Type: HRESULT

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

Remarks

This method can be called at any time before the dialog is opened or while the dialog is showing. If an item has inherent properties, this method should be called with those properties before showing the dialog.

When using Save As, the application should provide the properties of the item being saved to the Save dialog. Those properties should be retreived from the original item by calling GetPropertyStore with the GPS_HANDLERPROPERTIESONLY flag.

To retrieve the properties of the saved item (which may have been modified by the user) after the dialog closes, call IFileSaveDialog::GetProperties.

To turn on property collection and indicate which properties should be displayed in the Save dialog, use IFileSaveDialog::SetCollectedProperties.

Requirements

Requirement	Value
Minimum supported client	Windows Vista [desktop apps only]
Minimum supported server	Windows Server 2008 [desktop apps only]
Target Platform	Windows
Header	shobjidl_core.h