libCZI
Reading and Writing CZI documents made easy
libCZI::LibCZIMetadataBuilderException Class Reference

Exception for signaling errors when using the Czi-metadata-builder-object. More...

#include <libCZI_exceptions.h>

Inheritance diagram for libCZI::LibCZIMetadataBuilderException:
libCZI::LibCZIException

Public Types

enum class  ErrorType { InvalidPath , CannotSetValueToNode }
 Values that represent different error conditions. More...
 

Public Member Functions

 LibCZIMetadataBuilderException (const char *szErrMsg, ErrorType code)
 
ErrorType GetErrorType () const
 
- Public Member Functions inherited from libCZI::LibCZIException
 LibCZIException (const char *szErrMsg)
 

Detailed Description

Exception for signaling errors when using the Czi-metadata-builder-object.

Member Enumeration Documentation

◆ ErrorType

Values that represent different error conditions.

Enumerator
InvalidPath 

the path specified in a call to ICziMetadataBuilder::GetOrCreateChildNode was invalid

CannotSetValueToNode 

the node has subnodes, so cannot set a value

Constructor & Destructor Documentation

◆ LibCZIMetadataBuilderException()

libCZI::LibCZIMetadataBuilderException::LibCZIMetadataBuilderException ( const char *  szErrMsg,
ErrorType  code 
)
inline

Constructor for the LibCZIMetadataBuilderException. This type is used to signal errors when using the Czi-metadata-builder-object.

Parameters
szErrMsgMessage describing the error.
codeThe error code.

Member Function Documentation

◆ GetErrorType()

ErrorType libCZI::LibCZIMetadataBuilderException::GetErrorType ( ) const
inline

Gets error code.

Returns
The error code.

The documentation for this class was generated from the following file: