Benachrichtigungen (Setup-API)

  • Artikel

Benachrichtigungen sind Werte, die eine Setupfunktion an eine Rückrufroutine sendet, um einen Zustand oder ein Ereignis anzugeben. Zwei Parameter, Param1 und Param2, werden mit der Benachrichtigung gesendet und enthalten zusätzliche Informationen, die für die Benachrichtigung relevant sind.

Die Rückrufroutine verarbeitet die Benachrichtigung und gibt eine ganze Zahl ohne Vorzeichen an die Setupfunktion zurück. Abhängig von der Setupfunktion können Sie diesen Wert verwenden, um einen Vorgang oder eine Benutzerauswahl anzugeben, oder Sie können ihn ignorieren.

Die Setupfunktionen senden mithilfe der folgenden Syntax Benachrichtigungen an Rückrufroutinen.

MsgHandler(          //the specified callback routine
    Context,         //context used by the callback routine
    Notification,    //notification code
    Param1,          //additional notification information
    Param2           //additional notification information
);

Der Context-Parameter ist ein Void-Zeiger auf eine Kontextvariable oder -struktur, die die Rückrufroutine verwenden kann, um Informationen zu speichern, die zwischen nachfolgenden Aufrufen der Rückrufroutine beibehalten werden müssen.

Da die Rückrufroutine die Implementierung des Kontexts angibt und von den Setupfunktionen nie darauf verwiesen oder geändert wird, wird der Kontext nicht im Referenzmaterial für die folgenden Benachrichtigungsmeldungen dokumentiert.

Der Notification-Parameter gibt einen ganzzahligen Wert ohne Vorzeichen für ein Ereignis oder einen Zustand an, der dazu führt, dass die Setupfunktion die Rückrufroutine aufruft.

Param1 und Param2 sind optionale Parameter, die zusätzliche informationen enthalten können, die für die Benachrichtigung relevant sind. Bei diesen Parametern handelt es sich um ganze Zahlen ohne Vorzeichen. Wenn Param1 oder Param2 Informationen zurückgeben, die keine ganzzahlige Zahl ohne Vorzeichen sind, wird sie in eine ganze Zahl ohne Vorzeichen umgewandelt und muss in den ursprünglichen Datentyp umgewandelt werden, bevor sie von der Rückrufroutine verwendet werden kann.

Hinweis

Die folgenden Benachrichtigungen stellen jede Benachrichtigung dar, die von den Setupfunktionen verwendet wird. Einzelne Funktionen verwenden eine Teilmenge dieser Benachrichtigungen. Anders ausgedrückt: Nicht jede Benachrichtigung wird von jeder Funktion verwendet.

 

Die folgenden Benachrichtigungen werden von den Setupfunktionen verwendet.

Benachrichtigung Beschreibung
SPFILENOTIFY_COPYERROR Während eines Dateikopiervorgangs ist ein Fehler aufgetreten.
SPFILENOTIFY_DELETEERROR Fehler während eines Dateilöschvorgangs.
SPFILENOTIFY_ENDCOPY Ein Dateikopiervorgang wurde beendet.
SPFILENOTIFY_ENDDELETE Ein Dateilöschvorgang wurde beendet.
SPFILENOTIFY_ENDQUEUE Die Warteschlange hat das Commit abgeschlossen.
SPFILENOTIFY_ENDREGISTRATION Die Registrierung oder Aufhebung der Registrierung der Datei wurde abgeschlossen.
SPFILENOTIFY_ENDRENAME Ein Dateibenennungsvorgang wurde beendet.
SPFILENOTIFY_ENDSUBQUEUE Eine Unterqueue (kopieren, umbenennen oder löschen) wurde beendet.
SPFILENOTIFY_FILEEXTRACTED Die Datei wurde aus dem Schrank extrahiert.
SPFILENOTIFY_FILEINCABINET In der Ablage wird eine Datei gefunden.
SPFILENOTIFY_FILEOPDELAYED Die Datei wurde verwendet, und der aktuelle Vorgang wurde verzögert, bis das System neu gestartet wurde.
SPFILENOTIFY_LANGMISMATCH Die Sprache des aktuellen Vorgangs stimmt nicht mit der Systemsprache überein.
SPFILENOTIFY_NEEDMEDIA Neue Quellmedien sind erforderlich.
SPFILENOTIFY_NEEDNEWCABINET Die aktuelle Datei wird in der nächsten Ablage fortgesetzt.
SPFILENOTIFY_QUEUESCAN Ein Knoten in der Dateiwarteschlange wurde gescannt.
SPFILENOTIFY_QUEUESCAN_EX Ein Knoten in der Dateiwarteschlange wurde gescannt.
SPFILENOTIFY_QUEUESCAN_SIGNERINFO Ein Knoten in der Dateiwarteschlange wurde gescannt.
SPFILENOTIFY_RENAMEERROR Während eines Dateibenennungsvorgangs ist ein Fehler aufgetreten.
SPFILENOTIFY_STARTCOPY Ein Dateikopiervorgang wurde gestartet.
SPFILENOTIFY_STARTDELETE Ein Dateilöschvorgang wurde gestartet.
SPFILENOTIFY_STARTQUEUE Die Warteschlange hat mit dem Commit begonnen.
SPFILENOTIFY_STARTREGISTRATION Die Registrierung oder Aufhebung der Registrierung der Datei wurde gestartet.
SPFILENOTIFY_STARTRENAME Ein Dateibenennungsvorgang wurde gestartet.
SPFILENOTIFY_STARTSUBQUEUE Eine Unterqueue (kopieren, umbenennen oder löschen) wurde gestartet.
SPFILENOTIFY_TARGETEXISTS Eine Kopie der angegebenen Datei ist bereits auf dem Ziel vorhanden.
SPFILENOTIFY_TARGETNEWER Eine neuere Version der angegebenen Datei ist auf dem Ziel vorhanden.