InDesign SDK  20.5
 All Classes Namespaces Functions Variables Typedefs Enumerations Enumerator Friends Groups Pages
ErrorStateInfo Struct Reference

#include <TaskInfo.h>

Public Member Functions

 ErrorStateInfo ()
 
 ErrorStateInfo (IErrorState *errState)
 
void WriteErrorInfoToBuffer (IPMUnknown *errorInfo)
 
IPMUnknownReadErrorInfoFromBuffer () const
 

Public Attributes

ErrorCode fCode
 
PMString fString
 
PMString fContext
 
boost::shared_ptr< MemXferBytes > fErrorInfoBuffer
 
ClassID fErrorInfoClass
 

Detailed Description

Captures the information about the error state as data that can be moved between execution contexts.

Constructor & Destructor Documentation

ErrorStateInfo::ErrorStateInfo ()
inline

Default constructor

ErrorStateInfo::ErrorStateInfo (IErrorStateerrState)
explicit

Capture the current error state

Parameters
[in]errStatethe global error state to capture.

Member Function Documentation

IPMUnknown* ErrorStateInfo::ReadErrorInfoFromBuffer () const

Read a persistent Interface that was stored earlier

Returns
an IPMUnknown* representing the stored boss
void ErrorStateInfo::WriteErrorInfoToBuffer (IPMUnknownerrorInfo)

Write a persistent Interface as part of the ErrorStateInfo

Parameters
[in]errorInfoan interface on a persistent boss

Member Data Documentation

ErrorCode ErrorStateInfo::fCode

the ErrorCode

PMString ErrorStateInfo::fContext

the Context

boost::shared_ptr<MemXferBytes> ErrorStateInfo::fErrorInfoBuffer

raw storage for the stored interface

ClassID ErrorStateInfo::fErrorInfoClass

the ClassID of the error info

PMString ErrorStateInfo::fString

the ErrorString