Export (0) Print
Expand All
This topic has not yet been rated - Rate this topic

OleLoadPictureEx function

Creates a new picture object and initializes it from the contents of a stream. This is equivalent to calling OleCreatePictureIndirect with NULL as the first parameter, followed by a call to IPersistStream::Load.

Syntax


HRESULT OleLoadPictureEx(
  _In_   LPSTREAM lpstream,
  _In_   LONG lSize,
  _In_   BOOL fRunmode,
  _In_   REFIID riid,
  _In_   DWORD xSizeDesired,
  _In_   DWORD ySizeDesired,
  _In_   DWORD dwFlags,
  _Out_  LPVOID *lplpvObj
);

Parameters

lpstream [in]

Pointer to the stream that contains the picture's data.

lSize [in]

The number of bytes that should be read from the stream, or zero if the entire stream should be read.

fRunmode [in]

The opposite of the initial value of the KeepOriginalFormat property. If TRUE, KeepOriginalFormat is set to FALSE and vice versa.

riid [in]

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

xSizeDesired [in]

Desired width of icon or cursor. Valid values are 16, 32, and 48. Pass LP_DEFAULT to both size parameters to use system default size.

ySizeDesired [in]

Desired height of icon or cursor. Valid values are 16, 32, and 48. Pass LP_DEFAULT to both size parameters to use system default size.

dwFlags [in]

Desired color depth for icon or cursor. Values are LP_MONOCHROME (monochrome), LP_VGACOLOR (16 colors), LP_COLOR (256 colors), or LP_DEFAULT (selects best depth for current display).

lplpvObj [out]

Address of pointer variable that receives the interface pointer requested in riid. Upon successful return, *ppvObj contains the requested interface pointer on the storage of the object identified by the moniker. If *ppvObj 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, *ppvObj is set to NULL.

Return value

This function returns S_OK on success. Other possible values include the following.

Return codeDescription
E_NOINTERFACE

The object does not support the interface specified in riid.

E_POINTER

The address in pPictDesc or ppvObj is not valid. For example, it may be NULL.

 

Remarks

The stream must be in BMP (bitmap), WMF (metafile), or ICO (icon) format. A picture object created using OleLoadPictureEx always has ownership of its internal resources (fOwn==TRUE is implied).

In addition to allowing specification of icon or cursor size, OleLoadPictureEx supports loading of color cursors.

Requirements

Minimum supported client

Windows 2000 Professional [desktop apps only]

Minimum supported server

Windows 2000 Server [desktop apps only]

Header

OleCtl.h

Library

OleAut32.lib

DLL

OleAut32.dll

See also

OleCreatePictureIndirect
PICTDESC

 

 

Did you find this helpful?
(1500 characters remaining)
Thank you for your feedback

Community Additions

ADD
Show:
© 2014 Microsoft. All rights reserved.