Edit

IPicture::get_Handle method (ocidl.h)

  • Article

Retrieves the handle to the picture managed within this picture object to a specified location.

Syntax

HRESULT get_Handle(
  [out] OLE_HANDLE *pHandle
);

Parameters

[out] pHandle

A pointer to a variable that receives the handle. The caller is responsible for this handle upon successful return. The variable is set to NULL on failure.

Return value

This method supports the standard return values E_FAIL and E_OUTOFMEMORY, as well as the following values.

Return code Description
S_OK
 The handle was returned successfully.
E_POINTER
 The value of phandle is not valid. For example, it may be NULL.

Remarks

Notes to Callers

The picture object may retain ownership of the picture. However, the caller can be assured that the picture will remain valid until either the caller specifically destroys the picture or the picture object is itself destroyed. The fOwn parameter to OleCreatePictureIndirect determines ownership when the picture object is created. OleLoadPicture forces fOwn to TRUE.

Requirements

Requirement Value
Minimum supported client Windows 2000 Professional [desktop apps only]
Minimum supported server Windows 2000 Server [desktop apps only]
Target Platform Windows
Header ocidl.h

See also

IPicture