| XMP Toolkit SDK 6.0.0

Classes | Macros | Typedefs
WXMP_Common.hpp File Reference

Go to the source code of this file.

## Classes
struct | WXMP_Result

## Macros
#define | __WXMP_Common_hpp__ 1
#define | XMP_Inline /* not inline */
#define | XMP_CTorDTorIntro(Class) template <class tStringObj> XMP_Inline Class<tStringObj>
#define | XMP_MethodIntro(Class, ResultType) template <class tStringObj> XMP_Inline ResultType Class<tStringObj>
#define | PropagateException(res) if ( res.errMessage != 0 ) throw XMP_Error ( res.int32Result, res.errMessage );
#define | XMP_TraceClientCalls 0
#define | XMP_TraceClientCallsToFile 0
#define | InvokeCheck(WCallProto)
#define | WrapNoCheckVoid(WCallProto) WCallProto;
#define | WrapCheckVoid(WCallProto) InvokeCheck(WCallProto);
#define | WrapCheckMetaRef(result, WCallProto)
#define | WrapCheckIterRef(result, WCallProto)
#define | WrapCheckDocOpsRef(result, WCallProto)
#define | WrapCheckNewMetadata(result, WCallProto)
#define | WrapCheckBool(result, WCallProto)
#define | WrapCheckTriState(result, WCallProto)
#define | WrapCheckOptions(result, WCallProto)
#define | WrapCheckStatus(result, WCallProto)
#define | WrapCheckIndex(result, WCallProto)
#define | WrapCheckInt32(result, WCallProto)
#define | WrapCheckInt64(result, WCallProto)
#define | WrapCheckFloat(result, WCallProto)
#define | WrapCheckFormat(result, WCallProto)

## Typedefs
typedef void(* | SetClientStringProc) (void *clientPtr, XMP_StringPtr valuePtr, XMP_StringLen valueLen)
typedef void(* | SetClientStringVectorProc) (void *clientPtr, XMP_StringPtr *arrayPtr, XMP_Uns32 stringCount)

## Macro Definition Documentation

## ◆ __WXMP_Common_hpp__

#define __WXMP_Common_hpp__ 1

Definition at line 2 of file WXMP_Common.hpp.

## ◆ InvokeCheck

#define InvokeCheck | ( |  | WCallProto | ) |

Value:
WXMP_Result wResult; \
WCallProto; \
PropagateException ( wResult )

Definition at line 50 of file WXMP_Common.hpp.

## ◆ PropagateException

#define PropagateException | ( |  | res | ) | if ( res.errMessage != 0 ) throw XMP_Error ( res.int32Result, res.errMessage );

Definition at line 41 of file WXMP_Common.hpp.

## ◆ WrapCheckBool

#define WrapCheckBool | ( |  | result,
|  |  | WCallProto
| ) |  |

Value:
InvokeCheck(WCallProto); \
bool result = bool(wResult.int32Result)

Definition at line 92 of file WXMP_Common.hpp.

## ◆ WrapCheckDocOpsRef

#define WrapCheckDocOpsRef | ( |  | result,
|  |  | WCallProto
| ) |  |

Value:
InvokeCheck(WCallProto); \
XMPDocOpsRef result = XMPDocOpsRef(wResult.ptrResult)

Definition at line 84 of file WXMP_Common.hpp.

## ◆ WrapCheckFloat

#define WrapCheckFloat | ( |  | result,
|  |  | WCallProto
| ) |  |

Value:
InvokeCheck(WCallProto); \
double result = wResult.floatResult

Definition at line 120 of file WXMP_Common.hpp.

## ◆ WrapCheckFormat

#define WrapCheckFormat | ( |  | result,
|  |  | WCallProto
| ) |  |

Value:
InvokeCheck(WCallProto); \
XMP_FileFormat result = wResult.int32Result

Definition at line 124 of file WXMP_Common.hpp.

## ◆ WrapCheckIndex

#define WrapCheckIndex | ( |  | result,
|  |  | WCallProto
| ) |  |

Value:
InvokeCheck(WCallProto); \
XMP_Index result = XMP_Index(wResult.int32Result)

Definition at line 108 of file WXMP_Common.hpp.

## ◆ WrapCheckInt32

#define WrapCheckInt32 | ( |  | result,
|  |  | WCallProto
| ) |  |

Value:
InvokeCheck(WCallProto); \
XMP_Int32 result = wResult.int32Result

Definition at line 112 of file WXMP_Common.hpp.

## ◆ WrapCheckInt64

#define WrapCheckInt64 | ( |  | result,
|  |  | WCallProto
| ) |  |

Value:
InvokeCheck(WCallProto); \
XMP_Int64 result = wResult.int64Result

Definition at line 116 of file WXMP_Common.hpp.

## ◆ WrapCheckIterRef

#define WrapCheckIterRef | ( |  | result,
|  |  | WCallProto
| ) |  |

Value:
InvokeCheck(WCallProto); \
XMPIteratorRef result = XMPIteratorRef(wResult.ptrResult)

Definition at line 80 of file WXMP_Common.hpp.

## ◆ WrapCheckMetaRef

#define WrapCheckMetaRef | ( |  | result,
|  |  | WCallProto
| ) |  |

Value:
InvokeCheck(WCallProto); \
XMPMetaRef result = XMPMetaRef(wResult.ptrResult)

Definition at line 76 of file WXMP_Common.hpp.

## ◆ WrapCheckNewMetadata

#define WrapCheckNewMetadata | ( |  | result,
|  |  | WCallProto
| ) |  |

Value:
InvokeCheck(WCallProto); \
void * result = wResult.ptrResult

Definition at line 88 of file WXMP_Common.hpp.

## ◆ WrapCheckOptions

#define WrapCheckOptions | ( |  | result,
|  |  | WCallProto
| ) |  |

Value:
InvokeCheck(WCallProto); \
XMP_OptionBits result = XMP_OptionBits(wResult.int32Result)

Definition at line 100 of file WXMP_Common.hpp.

## ◆ WrapCheckStatus

#define WrapCheckStatus | ( |  | result,
|  |  | WCallProto
| ) |  |

Value:
InvokeCheck(WCallProto); \
XMP_Status result = XMP_Status(wResult.int32Result)

Definition at line 104 of file WXMP_Common.hpp.

## ◆ WrapCheckTriState

#define WrapCheckTriState | ( |  | result,
|  |  | WCallProto
| ) |  |

Value:
InvokeCheck(WCallProto); \
XMP_TriState result = XMP_TriState(wResult.int32Result)

Definition at line 96 of file WXMP_Common.hpp.

## ◆ WrapCheckVoid

#define WrapCheckVoid | ( |  | WCallProto | ) | InvokeCheck(WCallProto);

Definition at line 73 of file WXMP_Common.hpp.

## ◆ WrapNoCheckVoid

#define WrapNoCheckVoid | ( |  | WCallProto | ) | WCallProto;

Definition at line 70 of file WXMP_Common.hpp.

## ◆ XMP_CTorDTorIntro

#define XMP_CTorDTorIntro | ( |  | Class | ) | template <class tStringObj> XMP_Inline Class<tStringObj>

Definition at line 22 of file WXMP_Common.hpp.

## ◆ XMP_Inline

#define XMP_Inline /* not inline */

Definition at line 18 of file WXMP_Common.hpp.

## ◆ XMP_MethodIntro

#define XMP_MethodIntro | ( |  | Class,
|  |  | ResultType
| ) |  | template <class tStringObj> XMP_Inline ResultType Class<tStringObj>

Definition at line 23 of file WXMP_Common.hpp.

## ◆ XMP_TraceClientCalls

#define XMP_TraceClientCalls 0

Definition at line 45 of file WXMP_Common.hpp.

## ◆ XMP_TraceClientCallsToFile

#define XMP_TraceClientCallsToFile 0

Definition at line 46 of file WXMP_Common.hpp.

## Typedef Documentation

## ◆ SetClientStringProc

typedef void(* SetClientStringProc) (void *clientPtr, XMP_StringPtr valuePtr, XMP_StringLen valueLen)

Definition at line 25 of file WXMP_Common.hpp.

## ◆ SetClientStringVectorProc

typedef void(* SetClientStringVectorProc) (void *clientPtr, XMP_StringPtr *arrayPtr, XMP_Uns32 stringCount)

Definition at line 26 of file WXMP_Common.hpp.

InvokeCheck
#define InvokeCheck(WCallProto)
Definition: WXMP_Common.hpp:50
XMPDocOpsRef
struct __XMPDocOps__ * XMPDocOpsRef
An "ABI safe" pointer to the internal part of an XMP document operations object. Use to pass an XMP d...
Definition: XMP_Const.h:147
WXMP_Result
Definition: WXMP_Common.hpp:28
XMPMetaRef
struct __XMPMeta__ * XMPMetaRef
An "ABI safe" pointer to the internal part of an XMP object. Use to pass an XMP object across client ...
Definition: XMP_Const.h:139
XMP_Index
XMP_Int32 XMP_Index
The type for offsets and indices. A 32-bit signed integer. It is signed to allow -1 for loop terminat...
Definition: XMP_Const.h:180
XMP_TriState
XMP_Int8 XMP_TriState
Definition: XMP_Const.h:206
XMPIteratorRef
struct __XMPIterator__ * XMPIteratorRef
An "ABI safe" pointer to the internal part of an XMP iteration object. Use to pass an XMP iteration o...
Definition: XMP_Const.h:143
XMP_Status
XMP_Int32 XMP_Status
A signed 32-bit integer used as a status result for the output callback routine, XMP_TextOutputProc....
Definition: XMP_Const.h:1494
XMP_OptionBits
XMP_Uns32 XMP_OptionBits
The type for a collection of 32 flag bits.
Definition: XMP_Const.h:181