Benachrichtigungen (Setup-API)

Benachrichtigungen sind Werte, die eine Setupfunktion an eine Rückrufroutine sendet, um einen Zustand oder ein Ereignis anzugeben. Die beiden 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, mit der die Rückrufroutine Informationen speichern kann, die zwischen nachfolgenden Aufrufen der Rückrufroutine beibehalten werden müssen.

Da die Rückrufroutine die Implementierung des Kontexts angibt und nie von den Setupfunktionen 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 bewirkt, 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. Diese Parameter sind ganze Zahlen ohne Vorzeichen. Wenn Param1 oder Param2 Informationen zurückgeben, die keine ganze Zahl ohne Vorzeichen sind, wird sie in eine ganze Zahl ohne Vorzeichen umgeformt und muss in ihren ursprünglichen Datentyp umgeformt 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 Während eines Dateilöschvorgangs ist ein Fehler aufgetreten.
SPFILENOTIFY _ ENDCOPY Ein Dateikopiervorgang wurde beendet.
SPFILENOTIFY _ ENDDELETE Ein Dateilöschvorgang wurde beendet.
SPFILENOTIFY _ ENDQUEUE Der Commit für die Warteschlange wurde abgeschlossen.
SPFILENOTIFY _ ENDREGISTRATION Die Registrierung oder Aufhebung der Registrierung der Datei wurde abgeschlossen.
SPFILENOTIFY _ ENDRENAME Ein Datei-Umbenennungsvorgang wurde beendet.
SPFILENOTIFY _ ENDSUBQUEUE Eine Unterabfrage (kopieren, umbenennen oder löschen) wurde beendet.
SPFILENOTIFY _ FILEEXTRACTED Die Datei wurde aus dem Schränk extrahiert.
SPFILENOTIFY _ FILEINCABINET Eine Datei wird im Schränk 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 im nächsten Schränk fortgesetzt.
SPFILENOTIFY _ QUEUESCAN Ein Knoten in der Dateiwarteschlange wurde überprüft.
SPFILENOTIFY _ QUEUESCAN _ EX Ein Knoten in der Dateiwarteschlange wurde überprüft.
SPFILENOTIFY _ QUEUESCAN _ SIGNERINFO Ein Knoten in der Dateiwarteschlange wurde überprüft.
SPFILENOTIFY _ RENAMEERROR Fehler beim Umbenennen einer Datei.
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 Datei-Umbenennungsvorgang wurde gestartet.
SPFILENOTIFY _ STARTSUBQUEUE Eine Unterabfrage (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.