IDsAdminNotifyHandler::Begin-Methode (dsadmin.h)

Artikel
08/23/2023

Die IDsAdminNotifyHandler::Begin-Methode wird aufgerufen, wenn ein Ereignis auftritt, das vom Benachrichtigungshandler angefordert wurde. Der Benachrichtigungshandler gibt die Ereignisse an, die beim Aufrufen von IDsAdminNotifyHandler::Initialize Benachrichtigungen empfangen werden sollen.

Syntax

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

Parameter

[in] uEvent

Enthält einen Wert, der den Typ des ereignisses angibt. Dies kann einer der folgenden Werte sein.

DSA_NOTIFY_DEL

Ein Objekt wird gelöscht.

DSA_NOTIFY_REN

Ein Objekt wird umbenannt.

DSA_NOTIFY_MOV

Ein Objekt wird in einen anderen Container verschoben.

DSA_NOTIFY_PROP

Eine oder mehrere Eigenschaften eines Objekts werden geändert.

[in] pArg1

Zeiger auf eine IDataObject-Schnittstelle , die das CFSTR_DSOBJECTNAMES Zwischenablageformat unterstützt. Der Inhalt des Datenobjekts variiert abhängig vom Wert von uEvent. Weitere Informationen finden Sie im Abschnitt mit Hinweisen.

[in] pArg2

Zeiger auf eine IDataObject-Schnittstelle , die das CFSTR_DSOBJECTNAMES Zwischenablageformat unterstützt. Der Wert dieses Parameters und der Inhalt des Datenobjekts variieren je nach Wert von uEvent. Weitere Informationen finden Sie im Abschnitt mit Hinweisen.

[out] puFlags

Zeiger auf einen ULONG-Wert , der eine Reihe von Flags empfängt, die das Verhalten des Benachrichtigungshandlers im Dialogfeld für die Benachrichtigungsbestätigung ändern. Dies kann null oder eine Kombination aus einem oder mehreren der folgenden Werte sein.

DSA_NOTIFY_FLAG_ADDITIONAL_DATA

Wenn dieses Flag festgelegt ist, wird der Eintrag für diesen Benachrichtigungshandler im Bestätigungsdialogfeld ausgewählt. Wenn dieses Flag nicht festgelegt ist, ist der Eintrag für diesen Benachrichtigungshandler im Bestätigungsdialogfeld nicht ausgewählt.

DSA_NOTIFY_FLAG_FORCE_ADDITIONAL_DATA

Wenn dieses Flag festgelegt ist, ist der Eintrag für diesen Benachrichtigungshandler im Bestätigungsdialogfeld deaktiviert, und der Benutzer kann den Auswahlstatus nicht ändern.

[out] pBstr

Zeiger auf einen BSTR , der eine Zeichenfolge empfängt, die den Namen und/oder die Beschreibung des Benachrichtigungshandlers enthält. Diese Zeichenfolge wird im Bestätigungsdialogfeld angezeigt. Diese Zeichenfolge muss durch Aufrufen der SysAllocString-Funktion zugeordnet werden. Der Aufrufer muss diese Zeichenfolge freigeben, wenn sie nicht mehr benötigt wird. Wenn dieser Parameter NULL oder eine leere Zeichenfolge empfängt, wird der Benachrichtigungshandler nicht zum Bestätigungsdialogfeld hinzugefügt, und IDsAdminNotifyHandler::Notify wird nicht aufgerufen.

Rückgabewert

Wenn die Methode erfolgreich ist, wird S_OK zurückgegeben. Wenn die Methode fehlschlägt, wird ein HRESULT-Standardwert zurückgegeben.

Hinweise

Wert und Inhalt von pArg1 und pArg2 variieren je nach verarbeitetem Ereignis, wie von uEvent angegeben. In der folgenden Liste wird erläutert, was pArg1 und pArg2 für jeden verschiedenen Ereignistyp enthalten.

uEvent	pArg1	pArg2
DSA_NOTIFY_DEL	Enthält das gelöschte Objekt.	Wird nicht verwendet. Dies ist NULL.
DSA_NOTIFY_REN	Enthält den vorherigen Namen des -Objekts.	Enthält den neuen Namen des -Objekts.
DSA_NOTIFY_MOV	Enthält den Container, aus dem das Objekt verschoben wird.	Enthält den Container, in den das Objekt verschoben wird.
DSA_NOTIFY_PROP	Enthält das -Objekt, für das sich die Eigenschaften geändert haben.	Wird nicht verwendet. Dies ist NULL.

Anforderungen


Unterstützte Mindestversion (Client)	Windows Vista
Unterstützte Mindestversion (Server)	Windows Server 2008
Zielplattform	Windows
Kopfzeile	dsadmin.h
DLL	DSAdmin.dll