IDsAdminNotifyHandler::Begin メソッド (dsadmin.h)

[アーティクル]
08/23/2023

通知ハンドラーが要求したイベントが発生すると、 IDsAdminNotifyHandler::Begin メソッドが呼び出されます。通知ハンドラーは、 IDsAdminNotifyHandler::Initialize が呼び出されたときに通知を受信するイベントを指定します。

構文

HRESULT Begin(
  [in]  ULONG       uEvent,
  [in]  IDataObject *pArg1,
  [in]  IDataObject *pArg2,
  [out] ULONG       *puFlags,
  [out] BSTR        *pBstr
);

パラメーター

[in] uEvent

が発生しているイベントの種類を指定する値を格納します。これには、次のいずれかの値を指定できます。

DSA_NOTIFY_DEL

オブジェクトが削除されます。

DSA_NOTIFY_REN

オブジェクトの名前が変更されます。

DSA_NOTIFY_MOV

オブジェクトは別のコンテナーに移動されます。

DSA_NOTIFY_PROP

オブジェクトの 1 つ以上のプロパティが変更されます。

[in] pArg1

CFSTR_DSOBJECTNAMESクリップボード形式をサポートする IDataObject インターフェイスへのポインター。データオブジェクトの内容は、 uEvent の値によって異なります。詳細については、「解説」を参照してください。

[in] pArg2

CFSTR_DSOBJECTNAMESクリップボード形式をサポートする IDataObject インターフェイスへのポインター。このパラメーターの値とデータオブジェクトの内容は、 uEvent の値によって異なります。詳細については、「解説」を参照してください。

[out] puFlags

通知の確認ダイアログボックスで通知ハンドラーの動作を変更するフラグのセットを受け取る ULONG 値へのポインター。これは、0 または次の値の 1 つ以上の組み合わせにすることができます。

DSA_NOTIFY_FLAG_ADDITIONAL_DATA

このフラグが設定されている場合は、確認ダイアログボックスでこの通知ハンドラーのエントリが選択されます。このフラグが設定されていない場合、確認ダイアログボックスのこの通知ハンドラーのエントリは選択されません。

DSA_NOTIFY_FLAG_FORCE_ADDITIONAL_DATA

このフラグが設定されている場合、確認ダイアログボックスのこの通知ハンドラーのエントリは無効になり、ユーザーは選択状態を変更できません。

[out] pBstr

通知ハンドラーの名前や説明を含む文字列を受け取る BSTR へのポインター。この文字列は、確認ダイアログボックスに表示されます。この文字列は、 SysAllocString 関数を呼び出して割り当てる必要があります。呼び出し元は、不要になったときにこの文字列を解放する必要があります。このパラメーターが NULL または空の文字列を受け取った場合、通知ハンドラーは確認ダイアログボックスに追加されず、 IDsAdminNotifyHandler::Notify は呼び出されません。

戻り値

メソッドが成功した場合は、 S_OK が返されます。メソッドが失敗した場合は、標準の HRESULT 値が返されます。

解説

pArg1 と pArg2 の値と内容は、uEvent で示されているように処理されるイベントによって異なります。次の一覧では、異なるイベントの種類ごとに pArg1 と pArg2 に含まれる内容について説明します。

uEvent	pArg1	pArg2
DSA_NOTIFY_DEL	削除されたオブジェクトを格納します。	使用されていません。これは NULL になります。
DSA_NOTIFY_REN	オブジェクトの前の名前を格納します。	オブジェクトの新しい名前を格納します。
DSA_NOTIFY_MOV	オブジェクトの移動元のコンテナーを格納します。	オブジェクトが移動されるコンテナーを格納します。
DSA_NOTIFY_PROP	プロパティが変更されたオブジェクトを格納します。	使用されていません。これは NULL になります。

要件


サポートされている最小のクライアント	Windows Vista
サポートされている最小のサーバー	Windows Server 2008
対象プラットフォーム	Windows
ヘッダー	dsadmin.h
[DLL]	DSAdmin.dll

次の方法で共有