OfficeExtension.DebugInfo interface

Package:

office

Provides information about an error.

Properties

code	Error code string, such as "InvalidArgument".
errorLocation	The object type and property or method name (or similar information), if available.
fullStatements	All statements in the batch request (including any potentially-sensitive information that was specified in the request), if available. These statements may not match the code exactly as written, but will be a close approximation.
innerError	Inner error, if applicable.
message	The error message passed through from the Office application.
statement	The statement that caused the error, if available. This statement will never contain any potentially sensitive data and may not match the code exactly as written, but will be a close approximation.
surroundingStatements	The statements that closely precede and follow the statement that caused the error, if available. These statements will never contain any potentially sensitive data and may not match the code exactly as written, but will be a close approximation.

Property Details

code

Error code string, such as "InvalidArgument".

TypeScript

code: string;

Property Value

string

errorLocation

The object type and property or method name (or similar information), if available.

TypeScript

errorLocation?: string;

Property Value

string

fullStatements

All statements in the batch request (including any potentially-sensitive information that was specified in the request), if available.

These statements may not match the code exactly as written, but will be a close approximation.

TypeScript

fullStatements?: string[];

Property Value

string[]

innerError

Inner error, if applicable.

TypeScript

innerError?: DebugInfo | string;

Property Value

OfficeExtension.DebugInfo | string

message

The error message passed through from the Office application.

TypeScript

message: string;

Property Value

string

statement

The statement that caused the error, if available.

This statement will never contain any potentially sensitive data and may not match the code exactly as written, but will be a close approximation.

TypeScript

statement?: string;

Property Value

string

surroundingStatements

The statements that closely precede and follow the statement that caused the error, if available.

These statements will never contain any potentially sensitive data and may not match the code exactly as written, but will be a close approximation.

TypeScript

surroundingStatements?: string[];

Property Value

string[]