Skip to content

Latest commit

 

History

History
106 lines (86 loc) · 3.86 KB

nf-ocidl-ipropertynotifysink-onrequestedit.md

File metadata and controls

106 lines (86 loc) · 3.86 KB
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.IPropertyNotifySink.OnRequestEdit
IPropertyNotifySink::OnRequestEdit (ocidl.h)
Notifies a sink that a requestedit property is about to change.
IPropertyNotifySink interface [COM]
OnRequestEdit method
IPropertyNotifySink.OnRequestEdit
IPropertyNotifySink::OnRequestEdit
OnRequestEdit
OnRequestEdit method [COM]
OnRequestEdit method [COM]
IPropertyNotifySink interface
_ctrl_ipropertynotifysink_onrequestedit
com.ipropertynotifysink_onrequestedit
ocidl/IPropertyNotifySink::OnRequestEdit
com\ipropertynotifysink_onrequestedit.htm
com
52f4c45d-d658-4de2-a494-2ae164604681
12/05/2018
IPropertyNotifySink interface [COM],OnRequestEdit method, IPropertyNotifySink.OnRequestEdit, IPropertyNotifySink::OnRequestEdit, OnRequestEdit, OnRequestEdit method [COM], OnRequestEdit method [COM],IPropertyNotifySink interface, _ctrl_ipropertynotifysink_onrequestedit, com.ipropertynotifysink_onrequestedit, ocidl/IPropertyNotifySink::OnRequestEdit
ocidl.h
Windows
Windows 2000 Professional [desktop apps only]
Windows 2000 Server [desktop apps only]
OCIdl.idl
Windows
19H1
IPropertyNotifySink::OnRequestEdit
ocidl/IPropertyNotifySink::OnRequestEdit
c++
APIRef
kbSyntax
COM
OCIdl.h
IPropertyNotifySink.OnRequestEdit

IPropertyNotifySink::OnRequestEdit

-description

Notifies a sink that a requestedit property is about to change.

-parameters

-param dispID [in]

The dispatch identifier of the property that is about to change or DISPID_UNKNOWN if multiple properties are about to change.

-returns

This method can return the following values.

Return code Description
S_OK
The specified property or properties are allowed to change.
S_FALSE
The specified property or properties are not allowed to change. The caller must obey this return value by discarding the new property value(s). This is part of the contract of the [requestedit] attribute and this method.

-remarks

The sink may choose to allow or disallow the change to take place. For example, the sink may enforce a read-only state on the property. DISPID_UNKNOWN is a valid parameter to this method to indicate that multiple properties are about to change. In this case, the sink can enforce a global read-only state for all [requestedit] properties in the object, including any specific ones that the sink otherwise recognizes.

If the sink allows changes, the object must also make IPropertyNotifySink::OnChanged notifications for any properties that are marked [bindable] in addition to [requestedit].

This method cannot be used to implement any sort of data validation. At the time of the call, the desired new value of the property is unavailable and thus cannot be validated. This method's only purpose is to allow the sink to enforce a read-only state on a property.

-see-also

IPropertyNotifySink