Edit

Share via

IFileSaveDialog::SetCollectedProperties method (shobjidl_core.h)

  • Article

Specifies which properties will be collected in the save dialog.

Syntax

HRESULT SetCollectedProperties(
  [in] IPropertyDescriptionList *pList,
  [in] BOOL                     fAppendDefault
);

Parameters

[in] pList

Type: IPropertyDescriptionList*

Pointer to the interface that represents the list of properties to collect. This parameter can be NULL.

[in] fAppendDefault

Type: BOOL

TRUE to show default properties for the currently selected filetype in addition to the properties specified by pList. FALSE to show only properties specified by pList.

Return value

Type: HRESULT

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

Remarks

The calling application can use the PSGetPropertyDescriptionListFromString function to construct an IPropertyDescriptionList from a string such as "prop:Comments;Subject;".

For more information about property schemas, see Property Schemas.

IFileSaveDialog::SetCollectedProperties can be called at any time before the dialog is displayed or while it is visible. If different properties are to be collected depending on the chosen filetype, then IFileSaveDialog::SetCollectedProperties can be called in response to OnTypeChange.

Note  By default, no properties are collected in the save dialog.
 

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

See also

IFileSaveDialog

IFileSaveDialog::SetProperties