SHSaveLibraryInFolderPath function

Saves an IShellLibrary object to disk.

Syntax


HRESULT SHSaveLibraryInFolderPath(
  _In_       IShellLibrary *plib,
  _In_       PCWSTR pszFolderPath,
  _In_       PCWSTR pszLibraryName,
  _In_       LIBRARYSAVEFLAGS lsf,
  _Out_opt_  PWSTR *ppszSavedToPath
);

Parameters

plib [in]

Type: IShellLibrary*

A pointer to the IShellLibrary object to save.

pszFolderPath [in]

Type: PCWSTR

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

pszLibraryName [in]

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.

lsf [in]

Type: LIBRARYSAVEFLAGS

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

ppszSavedToPath [out, optional]

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

Minimum supported client

Windows 7 [desktop apps only]

Minimum supported server

Windows Server 2008 R2 [desktop apps only]

Header

Shobjidl.h

See also

IShellLibrary
IShellLibrary::Save
IShellLibrary::SaveInKnownFolder

 

 

Community Additions

ADD
Show:
© 2014 Microsoft