IPropertyNotifySink::OnRequestEdit メソッド (ocidl.h)

  • [アーティクル]

requestedit プロパティが変更されようとしていることをシンクに通知します。

構文

HRESULT OnRequestEdit(
  [in] DISPID dispID
);

パラメーター

[in] dispID

変更しようとしているプロパティのディスパッチ識別子。複数のプロパティが変更されようとしている場合はDISPID_UNKNOWN。

戻り値

このメソッドは、次の値を返すことができます。

リターン コード 説明
S_OK
 指定したプロパティまたはプロパティを変更できます。
S_FALSE
 指定したプロパティまたはプロパティは変更できません。 呼び出し元は、新しいプロパティ値を破棄することで、この戻り値に従う必要があります。 これは、[requestedit] 属性とこのメソッドのコントラクトの一部です。

注釈

シンクは、変更の実行を許可または禁止することを選択できます。 たとえば、シンクでは、 プロパティに読み取り専用状態を適用できます。 DISPID_UNKNOWNは、複数のプロパティが変更されようとしていることを示すために、このメソッドの有効なパラメーターです。 この場合、シンクは、オブジェクト内のすべての [requestedit] プロパティに対してグローバルな読み取り専用状態を適用できます。これには、シンクがそれ以外の場合に認識する特定のプロパティも含まれます。

シンクで変更が許可されている場合、オブジェクトは [requestedit] に加えて [bindable] とマークされているプロパティに対しても IPropertyNotifySink::OnChanged 通知を行う必要があります。

このメソッドを使用して、任意の種類のデータ検証を実装することはできません。 呼び出し時に、 プロパティの必要な新しい値は使用できないため、検証できません。 このメソッドの唯一の目的は、シンクがプロパティに読み取り専用状態を適用できるようにすることです。

要件

要件 値
サポートされている最小のクライアント Windows 2000 Professional [デスクトップ アプリのみ]
サポートされている最小のサーバー Windows 2000 Server [デスクトップ アプリのみ]
対象プラットフォーム Windows
ヘッダー ocidl.h

こちらもご覧ください

IPropertyNotifySink