Benachrichtigungen (Setup-API)
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 nicht signierte ganze Zahl 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 Benachrichtigungen an Rückrufroutinen mithilfe der folgenden Syntax.
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 leerer Zeiger auf eine Kontextvariable oder Struktur, mit der die Rückrufroutine Informationen speichern kann, die zwischen nachfolgenden Aufrufen der Rückrufroutine bestehen müssen.
Da die Rückrufroutine die Implementierung des Kontexts angibt und niemals von den Setupfunktionen referenziert oder geändert wird, wird der Kontext nicht im Referenzmaterial für die folgenden Benachrichtigungen dokumentiert.
Der Parameter Notification gibt einen 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 für die Benachrichtigung relevante Informationen enthalten können. Diese Parameter sind nicht signierte ganze Zahlen. Wenn Param1 oder Param2 Informationen zurückgeben, die keine ganze Zahl ohne Vorzeichen sind, wird sie in eine nicht signierte ganze Zahl umgewandelt und muss in den ursprünglichen Datentyp umgeschrieben werden, bevor sie von der Rückrufroutine verwendet werden kann.
Anmerkung
Die folgenden Benachrichtigungen stellen jede Benachrichtigung dar, die von den Setupfunktionen verwendet wird. Einzelne Funktionen verwenden eine Teilmenge dieser Benachrichtigungen. Mit anderen Worten, nicht jede Benachrichtigung wird von jeder Funktion verwendet.
Die folgenden Benachrichtigungen werden von den Setupfunktionen verwendet.
| Benachrichtigung | Beschreibung |
|---|---|
| SPFILENOTIFY_COPYERROR | Fehler während eines Dateikopievorgangs. |
| SPFILENOTIFY_DELETEERROR | Fehler während eines Dateilöschvorgangs. |
| SPFILENOTIFY_ENDCOPY | Ein Dateikopievorgang wurde beendet. |
| SPFILENOTIFY_ENDDELETE | Ein Dateilöschvorgang wurde beendet. |
| SPFILENOTIFY_ENDQUEUE | Der Commit der Warteschlange wurde abgeschlossen. |
| SPFILENOTIFY_ENDREGISTRATION | Die Registrierung oder Registrierung der Datei wurde abgeschlossen. |
| SPFILENOTIFY_ENDRENAME | Ein Dateibenennungsvorgang wurde beendet. |
| SPFILENOTIFY_ENDSUBQUEUE | Eine Unterabfrage (entweder Kopieren, Umbenennen oder Löschen) wurde beendet. |
| SPFILENOTIFY_FILEEXTRACTED | Die Datei wurde aus der Cab-Datei extrahiert. |
| SPFILENOTIFY_FILEINCABINET | In der Cab-Datei ist eine Datei aufgetreten. |
| SPFILENOTIFY_FILEOPDELAYED | Die Datei wurde verwendet, und der aktuelle Vorgang wurde verzögert, bis das System neu gestartet wird. |
| 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 Cab-Format 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 | Fehler bei einem Dateiumbenennungsvorgang. |
| SPFILENOTIFY_STARTCOPY | Ein Dateikopievorgang wurde gestartet. |
| SPFILENOTIFY_STARTDELETE | Ein Dateilöschvorgang wurde gestartet. |
| SPFILENOTIFY_STARTQUEUE | Die Warteschlange hat mit dem Commit begonnen. |
| SPFILENOTIFY_STARTREGISTRATION | Die Registrierung oder Registrierung der Datei wurde gestartet. |
| SPFILENOTIFY_STARTRENAME | Ein Dateibenennungsvorgang wurde gestartet. |
| SPFILENOTIFY_STARTSUBQUEUE | Eine Unterabfrage (entweder Kopieren, Umbenennen oder Löschen) wurde gestartet. |
| SPFILENOTIFY_TARGETEXISTS | Eine Kopie der angegebenen Datei ist bereits auf dem Ziel vorhanden. |
| SPFILENOTIFY_TARGETNEWER | Für das Ziel ist eine neuere Version der angegebenen Datei vorhanden. |