OfficeExtension.Error class

Paket:

office

Das von context.sync()zurückgegebene Fehlerobjekt, wenn eine Zusage aufgrund eines Fehlers bei der Verarbeitung der Anforderung abgelehnt wird.

Eigenschaften

code	Fehlercodezeichenfolge, z. B. "InvalidArgument".
debugInfo	Debuginformationen (nützlich für die detaillierte Protokollierung des Fehlers, d. h. über JSON.stringify(...)).
innerError	Innerer Fehler, falls zutreffend.
message	Die von der Office-Anwendung übergebene Fehlermeldung.
name	Fehlername: "OfficeExtension.Error".
stack	Stapelüberwachung, falls zutreffend.
traceMessages	Ablaufverfolgungsmeldungen (falls vorhanden), die über einen context.trace() Aufruf hinzugefügt wurden, bevor aufgerufen context.sync()wird. Wenn ein Fehler aufgetreten ist, enthält diese alle Ablaufverfolgungsmeldungen, die vor dem Auftreten des Fehlers ausgeführt wurden. Diese Meldungen können Ihnen helfen, die Ausführungssequenz des Programms zu überwachen und den Fehlerfall zu erkennen.

Details zur Eigenschaft

code

Fehlercodezeichenfolge, z. B. "InvalidArgument".

code: string;

Eigenschaftswert

string

debugInfo

Debuginformationen (nützlich für die detaillierte Protokollierung des Fehlers, d. h. über JSON.stringify(...)).

debugInfo: DebugInfo;

Eigenschaftswert

OfficeExtension.DebugInfo

innerError

Innerer Fehler, falls zutreffend.

innerError: Error;

Eigenschaftswert

OfficeExtension.Error

message

Die von der Office-Anwendung übergebene Fehlermeldung.

message: string;

Eigenschaftswert

string

name

Fehlername: "OfficeExtension.Error".

name: string;

Eigenschaftswert

string

stack

Stapelüberwachung, falls zutreffend.

stack: string;

Eigenschaftswert

string

traceMessages

Ablaufverfolgungsmeldungen (falls vorhanden), die über einen context.trace() Aufruf hinzugefügt wurden, bevor aufgerufen context.sync()wird. Wenn ein Fehler aufgetreten ist, enthält diese alle Ablaufverfolgungsmeldungen, die vor dem Auftreten des Fehlers ausgeführt wurden. Diese Meldungen können Ihnen helfen, die Ausführungssequenz des Programms zu überwachen und den Fehlerfall zu erkennen.

traceMessages: string[];

Eigenschaftswert

string[]

Beispiele

// The following example shows how you can instrument a batch of commands
// to determine where an error occurred. The first batch successfully
// inserts the first two paragraphs into the document and cause no errors.
// The second batch successfully inserts the third and fourth paragraphs
// but fails in the call to insert the fifth paragraph. All other commands
// after the failed command in the batch are not executed, including the
// command that adds the fifth trace message. In this case, the error
// occurred after the fourth paragraph was inserted, and before adding the
// fifth trace message.

// Run a batch operation against the Word object model.
await Word.run(async (context) => {

    // Create a proxy object for the document body.
    const body = context.document.body;

    // Queue a command to insert the paragraph at the end of the document body.
    // Start a batch of commands.
    body.insertParagraph('1st paragraph', Word.InsertLocation.end);
    // Queue a command for instrumenting this part of the batch.
    context.trace('1st paragraph successful');

    body.insertParagraph('2nd paragraph', Word.InsertLocation.end);
    context.trace('2nd paragraph successful');

    // Synchronize the document state by executing the queued-up commands,
    // and return a promise to indicate task completion.
    await context.sync();

    // Queue a command to insert the paragraph at the end of the document body.
    // Start a new batch of commands.
    body.insertParagraph('3rd paragraph', Word.InsertLocation.end);
    context.trace('3rd paragraph successful');

    body.insertParagraph('4th paragraph', Word.InsertLocation.end);
    context.trace('4th paragraph successful');

    // This command will cause an error. The trace messages in the queue up to
    // this point will be available via Error.traceMessages.
    body.insertParagraph(0, '5th paragraph', Word.InsertLocation.end);
    // Queue a command for instrumenting this part of the batch.
    // This trace message will not be set on Error.traceMessages.
    context.trace('5th paragraph successful');
    await context.sync();
}).catch(function (error) {
    if (error instanceof OfficeExtension.Error) {
        console.log('Trace messages: ' + error.traceMessages);
    }
});

// Output: "Trace messages: 3rd paragraph successful,4th paragraph successful"