 |
XMP Toolkit SDK
6.0.0
|
|
class | IConfigurable |
| Interface that allows to attach various key-value parameters to the underlying object. More...
|
|
class | IConfigurationManager_v1 |
| Version1 of the interface that represents configuration settings controllable by the client. More...
|
|
class | IConfigurationManagerProxy |
|
class | IError_v1 |
| Version1 of the interface that represents an error/warning encountered during processing. More...
|
|
class | IErrorNotifier_v1 |
| Version1 of the interface that represents an interface to be implemented by client in case he is interested in getting notifications with respect to errors/warnings encountered by library. More...
|
|
class | IMemoryAllocator_v1 |
| Version1 of the interface that represents an interface to be implemented by client in case he is interested in controlling the memory allocation and deallocation on the heap. More...
|
|
class | IObjectFactory_v1 |
| Version1 of a interface that represents a factory to create various artifacts defined within AdobeXMPCommon namespace. More...
|
|
class | ISharedObject |
| Interface that serves as the base interface of all the externally exposed interfaces. More...
|
|
class | IThreadSafe |
| Interface that serves as the base interface for all the externally exposed interfaces which needs to provide client configurable thread safety. More...
|
|
class | IUTF8String_v1 |
| Version1 of the interface that represents an UTF8String. More...
|
|
class | IVersionable |
| Interface that serves as the base interface for all the externally exposed interfaces which needs to provide evolving versions of the interface. More...
|
|
class | ReportErrorAndContinueFunctor |
| A Function object used by the client to report back and warnings to the library encountered during the serialization operation. More...
|
|
|
enum | eGeneralErrorCode {
kGECNone = 0,
kGECParametersNotAsExpected = 1,
kGECVersionUnavailable = 2,
kGECAssertionFailure = 3,
kGECLogicalError = 4,
kGECIndexOutOfBounds = 5,
kGECInternalFailure = 6,
kGECDeprecatedFunctionCall = 7,
kGECExternalFailure = 8,
kGECUnknownFailure = 9,
kGECUserAbort = 10,
kGECInterfaceUnavailable = 11,
kGECClientThrownExceptionCaught = 100,
kGECStandardException = 101,
kGECUnknownExceptionCaught = 200,
kGECNotImplemented = 10000,
kGECMaxValue = kMaxEnumValue
} |
| Indicates various types of error codes within General Domain. More...
|
|
enum | eMemoryManagementErrorCode { kMMECNone = 0,
kMMECAllocationFailure = 1,
kMMECMaxValue = kMaxEnumValue
} |
| Indicates various types of error codes within Memory Management domain. More...
|
|
enum | eConfigurableErrorCode {
kCECNone = 0,
kCECKeyNotSupported = 1,
kCECValueTypeNotSupported = 2,
kCECPreviousTypeDifferent = 3,
kCECValueTypeMismatch = 4,
kCECValueNotSupported = 5,
kCECodeMaxValue = 0xFFFFFFFF
} |
| Indicates various types of error codes within Configurable domain. More...
|
|
◆ cIUTF8Strings
◆ IConfigurationManager_base
◆ IError_base
◆ IErrorNotifier_base
◆ IMemoryAllocator_base
◆ int32
◆ int64
◆ IObjectFactory_base
◆ IUTF8String_base
◆ IUTF8Strings
◆ MemAllocateProc
typedef void*( * AdobeXMPCommon::MemAllocateProc) (sizet size) |
A function pointer to get the memory allocated from the library.
- Parameters
-
[in] | size | a value indicating the number of bytes to be allocated. |
- Returns
- a pointer to memory allocated by the library.
- Note
- NULL value is returned in case memory allocation fails.
Definition at line 134 of file XMPCommonFwdDeclarations.h.
◆ MemReleaseProc
typedef void( * AdobeXMPCommon::MemReleaseProc) (void *ptr) |
A function pointer to get the memory freed from the library.
- Parameters
-
[in] | ptr | address of the memory location to be freed. |
Definition at line 141 of file XMPCommonFwdDeclarations.h.
◆ pIConfigurable
◆ pIConfigurationManager
◆ pIConfigurationManager_base
◆ pIError
◆ pIError_base
◆ pIErrorNotifier
◆ pIErrorNotifier_base
◆ pIMemoryAllocator
◆ pIMemoryAllocator_base
◆ pIObjectFactory
◆ pIObjectFactory_base
◆ pIUTF8String
◆ pIUTF8String_base
◆ pvoid
◆ ReportErrorAndContinueABISafeProc
A function pointer to report back errors and warnings to the library encountered during the serialization operation.
Based on the error condition library can return 0 or non zero to indicate that a particular warning can be ignored and operation can continue.
- Parameters
-
[in] | errorDomain | An unsigned 32 bit integer indicating the domain of the error. |
[in] | errorCode | An unsigned 32 bit integer indicating the code of the error. |
[in] | errorSeverity | An unsigned 32 bit integer indicating the severity of the error. |
[out] | error | A reference to a pointer to const IError object which will be filled with the error object in case of any error. |
- Returns
- non zero value indicating that process can continue ignoring the warning, otherwise return 0 to indicate it should stop immediately.
Definition at line 345 of file IError.h.
◆ sizet
◆ spcIConfigurationManager
◆ spcIError
◆ spcIErrorNotifier
◆ spcIMemoryAllocator
◆ spcIUTF8String
◆ spcIUTF8Strings
◆ spcIUTF8Strings_const
◆ spcvoid
◆ spIConfigurationManager
◆ spIError
◆ spIErrorNotifier
◆ spIMemoryAllocator
◆ spIUTF8String
◆ spIUTF8Strings
◆ spIUTF8Strings_const
◆ spvoid
◆ uint32
◆ uint64
◆ eConfigurableErrorCode
Indicates various types of error codes within Configurable domain.
Enumerator |
---|
kCECNone | Indicates no error.
|
kCECKeyNotSupported | Indicates that key is not supported by the object.
|
kCECValueTypeNotSupported | Indicates different type of value provided than the one supported for a key.
|
kCECPreviousTypeDifferent | Indicates that different value type is previously stored for a key.
|
kCECValueTypeMismatch | Indicates the type of value stored for a key is different than what client is asking for.
|
kCECValueNotSupported | Indicates an invalid value is provided.
|
kCECodeMaxValue | Maximum value this enum can hold, should be treated as invalid value.
|
Definition at line 92 of file XMPCommonErrorCodes.h.
◆ eGeneralErrorCode
Indicates various types of error codes within General Domain.
Enumerator |
---|
kGECNone | Indicates no error.
|
kGECParametersNotAsExpected | Indicates that parameters passed to function are not as expected.
|
kGECVersionUnavailable | Indicates that version expected by client is not available in the library.
|
kGECAssertionFailure | Indicates that some assertion has failed.
|
kGECLogicalError | Indicates logic failure.
|
kGECIndexOutOfBounds | Indicates index provided is out of bounds.
|
kGECInternalFailure | Indicates an internal failure.
|
kGECDeprecatedFunctionCall | Indicates a call to deprecated function.
|
kGECExternalFailure | Indicates an external failure.
|
kGECUnknownFailure | Indicates an unknown failure.
|
kGECUserAbort | Indicates an error due to User Abort.
|
kGECInterfaceUnavailable | Indicates a particular interface is not available.
|
kGECClientThrownExceptionCaught | Indicates that client code has thrown some exception.
|
kGECStandardException | Indicates that standard exception has occurred.
|
kGECUnknownExceptionCaught | Indicates that some unknown exception has occurred.
|
kGECNotImplemented | Indicates that functionality is not yet implemented.
|
kGECMaxValue | Maximum value this enum can hold, should be treated as invalid value.
|
Definition at line 22 of file XMPCommonErrorCodes.h.
◆ eMemoryManagementErrorCode
Indicates various types of error codes within Memory Management domain.
Enumerator |
---|
kMMECNone | Indicates no error.
|
kMMECAllocationFailure | Indicates that allocation has failed.
|
kMMECMaxValue | Maximum value this enum can hold, should be treated as invalid value.
|
Definition at line 78 of file XMPCommonErrorCodes.h.
◆ BASE_CLASS() [1/6]
◆ BASE_CLASS() [2/6]
◆ BASE_CLASS() [3/6]
◆ BASE_CLASS() [4/6]
◆ BASE_CLASS() [5/6]
◆ BASE_CLASS() [6/6]
◆ kAllBits()
static const uint32 AdobeXMPCommon::kAllBits |
( |
0xFFFFFFFF |
| ) |
|
|
static |
◆ kIConfigurationManagerID()
static const uint64 AdobeXMPCommon::kIConfigurationManagerID |
( |
0x6e436f6e664d6772 |
| ) |
|
|
static |
◆ kIErrorID()
static const uint64 AdobeXMPCommon::kIErrorID |
( |
0x6e4572726f722020 |
| ) |
|
|
static |
◆ kIErrorNotifierID()
static const uint64 AdobeXMPCommon::kIErrorNotifierID |
( |
0x6e4572724e6f7466 |
| ) |
|
|
static |
◆ kIObjectFactoryID()
static const uint64 AdobeXMPCommon::kIObjectFactoryID |
( |
0x6e4f626a46616374 |
| ) |
|
|
static |
◆ kIUTF8StringID()
static const uint64 AdobeXMPCommon::kIUTF8StringID |
( |
0x6e55544638537472 |
| ) |
|
|
static |
◆ kMaxEnumValue()
◆ kMaxSize()
const sizet AdobeXMPCommon::kMaxSize |
( |
(sizet) - |
1 | ) |
|
◆ MemAllocate()
void* AdobeXMPCommon::MemAllocate |
( |
sizet |
size | ) |
|
◆ MemRelease()
void AdobeXMPCommon::MemRelease |
( |
void * |
ptr | ) |
|
◆ npos()
◆ pcIConfigurable
◆ pcIConfigurationManager
const typedef IConfigurationManager* AdobeXMPCommon::pcIConfigurationManager |
◆ pcIConfigurationManager_base
◆ pcIError
const typedef IError* AdobeXMPCommon::pcIError |
◆ pcIError_base
const typedef IError_v1* AdobeXMPCommon::pcIError_base |
◆ pcIErrorNotifier
const typedef IErrorNotifier* AdobeXMPCommon::pcIErrorNotifier |
◆ pcIErrorNotifier_base
◆ pcIMemoryAllocator
const typedef IMemoryAllocator* AdobeXMPCommon::pcIMemoryAllocator |
◆ pcIMemoryAllocator_base
◆ pcIObjectFactory
const typedef IObjectFactory* AdobeXMPCommon::pcIObjectFactory |
◆ pcIObjectFactory_base
◆ pcIUTF8String
const typedef IUTF8String* AdobeXMPCommon::pcIUTF8String |
◆ pcIUTF8String_base
◆ pcvoid
const typedef void* AdobeXMPCommon::pcvoid |
@ kCECValueTypeMismatch
Indicates the type of value stored for a key is different than what client is asking for.
@ kGECNone
Indicates no error.
eGeneralErrorCode
Indicates various types of error codes within General Domain.
@ kCECodeMaxValue
Maximum value this enum can hold, should be treated as invalid value.
@ kGECStandardException
Indicates that standard exception has occurred.
@ kGECUnknownExceptionCaught
Indicates that some unknown exception has occurred.
@ kCECKeyNotSupported
Indicates that key is not supported by the object.
@ kGECExternalFailure
Indicates an external failure.
@ kGECLogicalError
Indicates logic failure.
eMemoryManagementErrorCode
Indicates various types of error codes within Memory Management domain.
@ kGECMaxValue
Maximum value this enum can hold, should be treated as invalid value.
static const uint32 kMaxEnumValue(Max_XMP_Uns32)
@ kGECClientThrownExceptionCaught
Indicates that client code has thrown some exception.
@ kCECValueNotSupported
Indicates an invalid value is provided.
@ kGECIndexOutOfBounds
Indicates index provided is out of bounds.
@ kGECInternalFailure
Indicates an internal failure.
@ kGECDeprecatedFunctionCall
Indicates a call to deprecated function.
@ kCECNone
Indicates no error.
@ kCECValueTypeNotSupported
Indicates different type of value provided than the one supported for a key.
@ kGECUserAbort
Indicates an error due to User Abort.
eConfigurableErrorCode
Indicates various types of error codes within Configurable domain.
@ kGECUnknownFailure
Indicates an unknown failure.
@ kMMECMaxValue
Maximum value this enum can hold, should be treated as invalid value.
@ kGECParametersNotAsExpected
Indicates that parameters passed to function are not as expected.
@ kMMECAllocationFailure
Indicates that allocation has failed.
@ kGECVersionUnavailable
Indicates that version expected by client is not available in the library.
@ kGECAssertionFailure
Indicates that some assertion has failed.
@ kMMECNone
Indicates no error.
@ kCECPreviousTypeDifferent
Indicates that different value type is previously stored for a key.
@ kGECInterfaceUnavailable
Indicates a particular interface is not available.
@ kGECNotImplemented
Indicates that functionality is not yet implemented.