MXOMFERROR

 

MaxOmfSdk error messages

MaxOmfSdk provides 3 methods of error handling -

    1) Most functions return an MXOMFERROR value directly

    2) Each function sets the mxOmfAppIFInfo_t::m_mxOmfErrorStruct

        values on return

    3) mxOmfGetLastErr() returns last error and optionally an error

        message

mxOmfGetOmfErrorAsString() returns the error as a string

See mxOmfGetLastErr()

See mxOmfGetOmfErrorAsString()

See CMaxOmfSdkDemoOmfDoc::OnOpenDocument()

 

 

 

typedef enum

{

  MXOMFERR_NONE = 0,

 

     ====== MaxOmfSdk creation errors

  MXOMFERR_SDKHANDLENOTNULL = 100,

  MXOMFERR_SDKHANDLNULL,

  MXOMFERR_CALLBACKPARAMNULL,

  MXOMFERR_INVALIDPURPOSEPARAM,

  MXOMFERR_INVALIDPREFIXVALUE,

  MXOMFERR_INSETTINGSPARAMNULL,

  MXOMFERR_OUTSETTINGSPARAMNULL,

  MXOMFERR_MISSINGFUNCTIONPOINTER,

  MXOMFERR_BADSDKINIT,

 

     ====== User

  MXOMFERR_DEMOMODE        = 200,

  MXOMFERR_USERABORT,

 

     ====== File

  MXOMFERR_FILEEXISTS      = 300,

  MXOMFERR_CANNOTOPENFILE,

  MXOMFERR_CANNOTCREATEFILE,

  MXOMFERR_FILENOTASCII,  Ale

  MXOMFERR_FILENOTALE,  Ale

 

     ====== Omf file verify

  MXOMFERR_OMFVERS_ONE_W_COMPOSITION_NOTSUPPORTED = 400,

  MXOMFERR_OMFVERS_ONE_MEDIA_ONLY_NOTSUPPORTED,

  MXOMFERR_MULTICOMPOSITION_NOTSUPPORTED,

  MXOMFERR_NEWOMFUIDFAILED,

  MXOMFERR_CONFIRMOMFFAILED,

 

     ====== Logic

  MXOMFERR_LOGICERROR    = 500,

  MXOMFERR_NULLPOINTER,

  MXOMFERR_NULLPARAMETER,

  MXOMFERR_ZEROLEN,

  MXOMFERR_INVALIDVALUE,

  MXOMFERR_INVALIDPARAMETER,

  MXOMFERR_LISTEMPTY,

  MXOMFERR_NOTFOUND,

  MXOMFERR_ENDOFLIST,

 

     ====== Internal module errors

  MXOMFERR_OMFIN           = 600,

  MXOMFERR_OMFOUT,

  MXOMFERR_AUDIOTRANSFER,

  MXOMFERR_OMFIINFO,

  MXOMFERR_OMFIINFO2OMFINFO,

  MXOMFERR_CAXFER,

  MXOMFERR_COMFINFO,

  MXOMFERR_ALEGENERICERROR,

 

     ====== fatal errors

  MXOMFERR_NOMEM           = 700,

  MXOMFERR_SECURITY,

 

     ====== Omf Creation errors

  MXOMFERR_OBJECTFOUNDINLIST = 800,

 

 

  MXOMFERR_LAST            = 1000

} MXOMFERROR;

 

// max length of string from mxOmfGetOmfErrorAsString()

#define MAXERRORMAXSTRINGSIZE 48