nf-ocidl-iperpropertybrowsing-getpredefinedvalue.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.IPerPropertyBrowsing.GetPredefinedValue	IPerPropertyBrowsing::GetPredefinedValue (ocidl.h)	Retrieves the value of the specified property that is associated with a predefined string name.	GetPredefinedValue GetPredefinedValue method [COM] GetPredefinedValue method [COM] IPerPropertyBrowsing interface IPerPropertyBrowsing interface [COM] GetPredefinedValue method IPerPropertyBrowsing.GetPredefinedValue IPerPropertyBrowsing::GetPredefinedValue _ctrl_iperpropertybrowsing_getpredefinedvalue com.iperpropertybrowsing_getpredefinedvalue ocidl/IPerPropertyBrowsing::GetPredefinedValue	com\iperpropertybrowsing_getpredefinedvalue.htm	com	a532ebed-3ed8-4b49-a17f-f542fdbd74ff	12/05/2018	GetPredefinedValue, GetPredefinedValue method [COM], GetPredefinedValue method [COM],IPerPropertyBrowsing interface, IPerPropertyBrowsing interface [COM],GetPredefinedValue method, IPerPropertyBrowsing.GetPredefinedValue, IPerPropertyBrowsing::GetPredefinedValue, _ctrl_iperpropertybrowsing_getpredefinedvalue, com.iperpropertybrowsing_getpredefinedvalue, ocidl/IPerPropertyBrowsing::GetPredefinedValue	ocidl.h		Windows	Windows 2000 Professional [desktop apps only]	Windows 2000 Server [desktop apps only]					OCIdl.idl								Windows			19H1	IPerPropertyBrowsing::GetPredefinedValue ocidl/IPerPropertyBrowsing::GetPredefinedValue	c++	APIRef kbSyntax	COM	OCIdl.h	IPerPropertyBrowsing.GetPredefinedValue

IPerPropertyBrowsing::GetPredefinedValue

-description

Retrieves the value of the specified property that is associated with a predefined string name. This property is associated with a predefined string name as returned from IPerPropertyBrowsing::GetPredefinedStrings. The predefined string is identified by a token returned from GetPredefinedStrings.

-parameters

-param dispID [in]

The dispatch identifier of the property for which a predefined value is requested.

-param dwCookie [in]

A token identifying which value to return. The token was previously returned in the pCaCookiesOut array filled by GetPredefinedStrings.

-param pVarOut [out]

A pointer to the VARIANT value for the property.

-returns

This method can return the standard return values E_INVALIDARG, E_OUTOFMEMORY, and E_UNEXPECTED, as well as the following values.

Return code	Description
S_OK	The method completed successfully.
E_NOTIMPL	This object does not support predefined strings or predefined values.
E_POINTER	The address in pVarOut is not valid. For example, it may be NULL.

-remarks

Notes to Callers

The caller is responsible for freeing any allocations contained in the VARIANT. Unless the vt member of VARIANT is VT_VARIANT, the caller can free memory using a single call to VariantClear. Otherwise, the caller must recursively free the contained VARIANT values before freeing the outer VARIANT.

Notes to Implementers

Support for predefined names and values is not required. If your object does not support these names, return E_NOTIMPL from this method. If this method is not implemented, IPerPropertyBrowsing::GetPredefinedStrings must not be implemented either.

This method allocates any memory needed inside the VARIANT.

-see-also

IPerPropertyBrowsing