nf-olectl-oleloadpicturepath.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:olectl.OleLoadPicturePath	OleLoadPicturePath function (olectl.h)	Creates a new picture object and initializes it from the contents of a stream. This is equivalent to calling OleCreatePictureIndirect(NULL, ...) followed by IPersistStream::Load.	OleLoadPicturePath OleLoadPicturePath function [COM] _ctrl_OleLoadPicturePath com.oleloadpicturepath olectl/OleLoadPicturePath	com\oleloadpicturepath.htm	com	08bad900-815a-4b6d-b977-92d5fdd7d9e8	12/05/2018	OleLoadPicturePath, OleLoadPicturePath function [COM], _ctrl_OleLoadPicturePath, com.oleloadpicturepath, olectl/OleLoadPicturePath	olectl.h		Windows	Windows 2000 Professional [desktop apps only]	Windows 2000 Server [desktop apps only]										OleAut32.lib	OleAut32.dll		Windows			19H1	OleLoadPicturePath olectl/OleLoadPicturePath	c++	APIRef kbSyntax	DllExport	OleAut32.dll	OleLoadPicturePath

OleLoadPicturePath function

-description

Creates a new picture object and initializes it from the contents of a stream. This is equivalent to calling OleCreatePictureIndirect(NULL, ...) followed by IPersistStream::Load.

-parameters

-param szURLorPath [in]

The path or URL to the file you want to open.

-param punkCaller [in]

Points to IUnknown for COM aggregation.

-param dwReserved [in]

Reserved.

-param clrReserved [in]

The color you want to reserve to be transparent.

-param riid [in]

Reference to the identifier of the interface describing the type of interface pointer to return in ppvRet.

-param ppvRet [out]

Address of pointer variable that receives the interface pointer requested in riid. Upon successful return, *ppvRet contains the requested interface pointer on the storage of the object identified by the moniker. If *ppvRet is non-NULL, this function calls IUnknown::AddRef on the interface; it is the caller's responsibility to call IUnknown::Release. If an error occurs, *ppvRet is set to NULL.

-returns

This function supports the standard return values E_OUTOFMEMORY and E_UNEXPECTED, as well as the following:

Return code	Description
S_OK	The dialog box was created successfully.
E_FAIL	Unable to load picture stream.
E_POINTER	The address in ppvRet is NULL.
E_NOINTERFACE	The object does not support the interface specified in riid.

-remarks

The stream must be in BMP (bitmap), JPEG, WMF (metafile), ICO (icon), or GIF format.

-see-also

OleLoadPicture