A user-safe string that encompasses the Document Service Exception object.
Object.defineProperty(ServiceError.prototype, 'message',
get: function()
)
readonly message: string;
A string that is suitable to return in an application if necessary to alert the user to an error that may require action.
While Detail will contain the actual Exception.Message
property,
Message will be a generic, user-safe string. The string is always
at least method-specific, and sometimes specific to the exact issue (for example, if the wrong
password is passed to Decrypt, the Message
property will be "Incorrect Password
" instead of a more generic "The decryption failed
".
This value, along with the Detail string, are used to understand the Exception from the Document Service.
While Message is always a user-safe string, there may be times where the
Exception.Message property in the Document Service is user-safe; in this case, Message
and Detail will be the same, however ExceptionType
will be DocumentService.ServiceException
.
See ServiceError for more information.
Help Collections
Raster .NET | C API | C++ Class Library | HTML5 JavaScript
Document .NET | C API | C++ Class Library | HTML5 JavaScript
Medical .NET | C API | C++ Class Library | HTML5 JavaScript
Medical Web Viewer .NET
Multimedia
Direct Show .NET | C API | Filters
Media Foundation .NET | C API | Transforms
Supported Platforms
.NET, Java, Android, and iOS/macOS Assemblies
Imaging, Medical, and Document
C API/C++ Class Libraries
Imaging, Medical, and Document
HTML5 JavaScript Libraries
Imaging, Medical, and Document