SHSaveLibraryInFolderPath function (shobjidl_core.h)

Saves an IShellLibrary object to disk.

Syntax

HRESULT SHSaveLibraryInFolderPath(
  [in]            IShellLibrary    *plib,
  [in]            PCWSTR           pszFolderPath,
  [in]            PCWSTR           pszLibraryName,
  [in]            LIBRARYSAVEFLAGS lsf,
  [out, optional] PWSTR            *ppszSavedToPath
);

Parameters

[in] plib

Type: IShellLibrary*

A pointer to the IShellLibrary object to save.

[in] pszFolderPath

Type: PCWSTR

A pointer to the path to the folder in which to save the library.

[in] pszLibraryName

Type: PCWSTR

A pointer to a file name under which to save the library. The file name must not include the file name extension. The file name extension is added automatically.

[in] lsf

Type: LIBRARYSAVEFLAGS

A value from the LIBRARYSAVEFLAGS enumeration that specifies how to handle a library name collision.

[out, optional] ppszSavedToPath

Type: PWSTR*

A pointer to a string that, when this function returns successfully, receives the path to the library description file into which the library was saved. If this path is not required, the value of this parameter can be NULL.

Return value

Type: HRESULT

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

Remarks

This is an inline helper function that wraps the IShellLibrary::Save method.

Requirements

See also

IShellLibrary

IShellLibrary::Save

IShellLibrary::SaveInKnownFolder