OleLoadPicture function

• 12/5/2018
• 2 minutes to read

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

WINOLECTLAPI OleLoadPicture(
  LPSTREAM lpstream,
  LONG     lSize,
  BOOL     fRunmode,
  REFIID   riid,
  LPVOID   *lplpvObj
);

Parameters

lpstream

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

lSize

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

fRunmode

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

riid

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

lplpvObj

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.

Remarks

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

Requirements

See Also

OleCreatePictureIndirect

PICTDESC