nf-ocidl-ipicture-get_hpal.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:ocidl.IPicture.get_hPal	IPicture::get_hPal (ocidl.h)	Retrieves a copy of the palette currently used by the picture object.	IPicture interface [COM] get_hPal method IPicture.get_hPal IPicture::get_hPal _ctrl_ipicture_get_hpal com.ipicture_get_hpal get_hPal get_hPal method [COM] get_hPal method [COM] IPicture interface ocidl/IPicture::get_hPal	com\ipicture_get_hpal.htm	com	84887cb7-05b0-44cc-9772-117a598c1b94	12/05/2018	IPicture interface [COM],get_hPal method, IPicture.get_hPal, IPicture::get_hPal, _ctrl_ipicture_get_hpal, com.ipicture_get_hpal, get_hPal, get_hPal method [COM], get_hPal method [COM],IPicture interface, ocidl/IPicture::get_hPal	ocidl.h		Windows	Windows 2000 Professional [desktop apps only]	Windows 2000 Server [desktop apps only]					OCIdl.idl								Windows			19H1	IPicture::get_hPal ocidl/IPicture::get_hPal	c++	APIRef kbSyntax	COM	OCIdl.h	IPicture.get_hPal

IPicture::get_hPal

-description

Retrieves a copy of the palette currently used by the picture object.

-parameters

-param phPal [out]

A pointer to a variable that receives the palette handle. The variable is set to NULL on failure.

-returns

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

Return code	Description
S_OK	The height was returned successfully.
S_FALSE	This picture has no palette. The variable that phpal points to was set to NULL.
E_POINTER	The value of phPal is not valid. For example, it may be NULL.

-remarks

Notes to Callers

If the picture object has ownership of the picture, it also has ownership of the palette and will destroy it when the object is itself destroyed. Otherwise the caller owns the palette. The fOwn parameter to OleCreatePictureIndirect determines ownership. OleLoadPicture sets fOwn to TRUE to indicate that the picture object owns the palette.

-see-also

IPicture