nf-shobjidl_core-shloadlibraryfromknownfolder.md

UID	title	description	helpviewer_keywords	old-location	tech.root	ms.assetid	ms.date	ms.keywords	req.header	req.include-header	req.target-type	req.target-min-winverclnt	req.target-min-winversvr	req.kmdf-ver	req.umdf-ver	req.ddi-compliance	req.unicode-ansi	req.idl	req.max-support	req.namespace	req.assembly	req.type-library	req.lib	req.dll	req.irql	targetos	req.typenames	req.redist	ms.custom	f1_keywords	dev_langs	topic_type	api_type	api_location	api_name
NF:shobjidl_core.SHLoadLibraryFromKnownFolder	SHLoadLibraryFromKnownFolder function (shobjidl_core.h)	Creates and loads an IShellLibrary object for a specified known folder ID.	SHLoadLibraryFromKnownFolder SHLoadLibraryFromKnownFolder function [Windows Shell] _shell_SHLoadLibraryFromKnownFolder shell.SHLoadLibraryFromKnownFolder shobjidl_core/SHLoadLibraryFromKnownFolder	shell\SHLoadLibraryFromKnownFolder.htm	shell	9486252b-9aaf-4daf-b307-5a5adddfaa99	12/05/2018	SHLoadLibraryFromKnownFolder, SHLoadLibraryFromKnownFolder function [Windows Shell], _shell_SHLoadLibraryFromKnownFolder, shell.SHLoadLibraryFromKnownFolder, shobjidl_core/SHLoadLibraryFromKnownFolder	shobjidl_core.h	Shobjidl.h	Windows	Windows 7 [desktop apps only]	Windows Server 2008 R2 [desktop apps only]													Windows			19H1	SHLoadLibraryFromKnownFolder shobjidl_core/SHLoadLibraryFromKnownFolder	c++	APIRef kbSyntax	HeaderDef	shobjidl_core.h	SHLoadLibraryFromKnownFolder

SHLoadLibraryFromKnownFolder function

-description

Creates and loads an IShellLibrary object for a specified known folder ID.

-parameters

-param kfidLibrary [in]

Type: REFKNOWNFOLDERID

The KNOWNFOLDERID value that identifies the known folder to load into the IShellLibrary object.

-param grfMode [in]

Type: DWORD

One or more storage medium flags that specify access and sharing modes for the library object. Commonly specified flags are STGM_READ or STGM_READWRITE. For more information, see STGM.

-param riid [in]

Type: REFIID

The IID for IShellLibrary. (See Remarks for more information.)

-param ppv [out]

Type: void**

When this function returns successfully, receives the loaded IShellLibrary object. (See Remarks for more information.)

-returns

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::LoadLibraryFromKnownFolder method.

Usage

The IID_PPV_ARGS macro is generally used to generate the riid and ppv parameters for this function. For an example, see SHCreateLibrary.

-see-also

IShellLibrary

IShellLibrary::LoadLibraryFromItem

IShellLibrary::LoadLibraryFromKnownFolder

Known Folders Sample

SHCreateLibrary

SHLoadLibraryFromItem

SHLoadLibraryFromParsingName