C API

Contents

C API#

Class Hierarchy#

- Struct AccessorOptionsInterop
- Struct AddAttachmentInfoInterop
- Struct AddSubBlockInfoInterop
- Struct AttachmentInfoInterop
- Struct BitmapInfoInterop
- Struct BitmapLockInfoInterop
- Struct BoundingBoxesInterop
- Struct CompositionChannelInfoInterop
- Struct CoordinateInterop
- Struct DimBoundsInterop
- Struct ExternalInputStreamStructInterop
- Struct ExternalOutputStreamStructInterop
- Struct ExternalStreamErrorInfoInterop
- Struct FileHeaderInfoInterop
- Struct InputStreamClassInfoInterop
- Struct IntRectInterop
- Struct IntSizeInterop
- Struct LibCZIBuildInformationInterop
- Struct LibCZIVersionInfoInterop
- Struct MetadataAsXmlInterop
- Struct ReaderOpenInfoInterop
- Struct ScalingInfoInterop
- Struct SubBlockInfoInterop
- Struct SubBlockStatisticsInterop
- Struct SubBlockStatisticsInteropEx
- Struct WriteMetadataInfoInterop

File Hierarchy#

- Directory inc
  - File accessor_options_interop.h
  - File add_attachment_info_interop.h
  - File add_subblock_info_interop.h
  - File attachment_info_interop.h
  - File bitmap_structs.h
  - File composition_channel_info_interop.h
  - File errorcodes.h
  - File external_input_stream_struct.h
  - File external_output_stream_struct.h
  - File external_stream_error_information_struct.h
  - File fileheader_info_interop.h
  - File inputstream_class_info_struct.h
  - File libCZIApi.h
  - File MetadataAsXml_struct.h
  - File misc_types.h
  - File ObjectHandles.h
  - File reader_open_info_struct.h
  - File scaling_info_interop.h
  - File subblock_info_interop.h
  - File subblock_statistics_struct.h
  - File versioninfo_structs.h
  - File write_metadata_info_interop.h

Full API#

Classes and Structs#

Struct AccessorOptionsInterop
- Struct Documentation
  - AccessorOptionsInterop

Struct AddAttachmentInfoInterop
- Struct Documentation
  - AddAttachmentInfoInterop

Struct AttachmentInfoInterop
- Struct Documentation
  - AttachmentInfoInterop

Struct BitmapInfoInterop
- Struct Documentation
  - BitmapInfoInterop

Struct BitmapLockInfoInterop
- Struct Documentation
  - BitmapLockInfoInterop

Struct BoundingBoxesInterop
- Struct Documentation
  - BoundingBoxesInterop

Struct CompositionChannelInfoInterop
- Struct Documentation
  - CompositionChannelInfoInterop

Struct CoordinateInterop
- Struct Documentation
  - CoordinateInterop
    - dimensions_valid
    - value

Struct DimBoundsInterop
- Struct Documentation
  - DimBoundsInterop

Struct ExternalInputStreamStructInterop
- Struct Documentation
  - ExternalInputStreamStructInterop

Struct ExternalOutputStreamStructInterop
- Struct Documentation
  - ExternalOutputStreamStructInterop

Struct ExternalStreamErrorInfoInterop
- Struct Documentation
  - ExternalStreamErrorInfoInterop
    - error_code
    - error_message

Struct FileHeaderInfoInterop
- Struct Documentation
  - FileHeaderInfoInterop

Struct InputStreamClassInfoInterop
- Struct Documentation
  - InputStreamClassInfoInterop
    - name
    - description

Struct IntRectInterop
- Struct Documentation
  - IntRectInterop
    - x
    - y
    - w
    - h

Struct IntSizeInterop
- Struct Documentation
  - IntSizeInterop
    - w
    - h

Struct LibCZIBuildInformationInterop
- Struct Documentation
  - LibCZIBuildInformationInterop

Struct LibCZIVersionInfoInterop
- Struct Documentation
  - LibCZIVersionInfoInterop
    - major
    - minor
    - patch
    - tweak

Struct MetadataAsXmlInterop
- Struct Documentation
  - MetadataAsXmlInterop
    - data
    - size

Struct ReaderOpenInfoInterop
- Struct Documentation
  - ReaderOpenInfoInterop
    - streamObject

Struct ScalingInfoInterop
- Struct Documentation
  - ScalingInfoInterop

Struct SubBlockInfoInterop
- Struct Documentation
  - SubBlockInfoInterop

Struct SubBlockStatisticsInterop
- Struct Documentation
  - SubBlockStatisticsInterop

Struct SubBlockStatisticsInteropEx
- Struct Documentation
  - SubBlockStatisticsInteropEx

Struct WriteMetadataInfoInterop
- Struct Documentation
  - WriteMetadataInfoInterop
    - size_metadata
    - metadata

Functions#

Function libCZI_AttachmentGetInfo
- Function Documentation
  - libCZI_AttachmentGetInfo()

Function libCZI_AttachmentGetRawData
- Function Documentation
  - libCZI_AttachmentGetRawData()

Function libCZI_BitmapCopyTo
- Function Documentation
  - libCZI_BitmapCopyTo()

Function libCZI_BitmapGetInfo
- Function Documentation
  - libCZI_BitmapGetInfo()

Function libCZI_BitmapLock
- Function Documentation
  - libCZI_BitmapLock()

Function libCZI_BitmapUnlock
- Function Documentation
  - libCZI_BitmapUnlock()

Function libCZI_CompositorDoMultiChannelComposition
- Function Documentation
  - libCZI_CompositorDoMultiChannelComposition()

Function libCZI_CompositorFillOutCompositionChannelInfoInterop
- Function Documentation
  - libCZI_CompositorFillOutCompositionChannelInfoInterop()

Function libCZI_CreateInputStream
- Function Documentation
  - libCZI_CreateInputStream()

Function libCZI_CreateInputStreamFromExternal
- Function Documentation
  - libCZI_CreateInputStreamFromExternal()

Function libCZI_CreateInputStreamFromFileUTF8
- Function Documentation
  - libCZI_CreateInputStreamFromFileUTF8()

Function libCZI_CreateInputStreamFromFileWide
- Function Documentation
  - libCZI_CreateInputStreamFromFileWide()

Function libCZI_CreateOutputStreamForFileUTF8
- Function Documentation
  - libCZI_CreateOutputStreamForFileUTF8()

Function libCZI_CreateOutputStreamForFileWide
- Function Documentation
  - libCZI_CreateOutputStreamForFileWide()

Function libCZI_CreateOutputStreamFromExternal
- Function Documentation
  - libCZI_CreateOutputStreamFromExternal()

Function libCZI_CreateReader
- Function Documentation
  - libCZI_CreateReader()

Function libCZI_CreateSingleChannelTileAccessor
- Function Documentation
  - libCZI_CreateSingleChannelTileAccessor()

Function libCZI_CreateWriter
- Function Documentation
  - libCZI_CreateWriter()

Function libCZI_CziDocumentInfoGetAvailableDimension
- Function Documentation
  - libCZI_CziDocumentInfoGetAvailableDimension()

Function libCZI_CziDocumentInfoGetDimensionInfo
- Function Documentation
  - libCZI_CziDocumentInfoGetDimensionInfo()

Function libCZI_CziDocumentInfoGetDisplaySettings
- Function Documentation
  - libCZI_CziDocumentInfoGetDisplaySettings()

Function libCZI_CziDocumentInfoGetGeneralDocumentInfo
- Function Documentation
  - libCZI_CziDocumentInfoGetGeneralDocumentInfo()

Function libCZI_CziDocumentInfoGetScalingInfo
- Function Documentation
  - libCZI_CziDocumentInfoGetScalingInfo()

Function libCZI_DisplaySettingsGetChannelDisplaySettings
- Function Documentation
  - libCZI_DisplaySettingsGetChannelDisplaySettings()

Function libCZI_Free
- Function Documentation
  - libCZI_Free()

Function libCZI_GetLibCZIBuildInformation
- Function Documentation
  - libCZI_GetLibCZIBuildInformation()

Function libCZI_GetLibCZIVersionInfo
- Function Documentation
  - libCZI_GetLibCZIVersionInfo()

Function libCZI_GetStreamClassesCount
- Function Documentation
  - libCZI_GetStreamClassesCount()

Function libCZI_GetStreamClassInfo
- Function Documentation
  - libCZI_GetStreamClassInfo()

Function libCZI_MetadataSegmentGetCziDocumentInfo
- Function Documentation
  - libCZI_MetadataSegmentGetCziDocumentInfo()

Function libCZI_MetadataSegmentGetMetadataAsXml
- Function Documentation
  - libCZI_MetadataSegmentGetMetadataAsXml()

Function libCZI_ReaderGetAttachmentCount
- Function Documentation
  - libCZI_ReaderGetAttachmentCount()

Function libCZI_ReaderGetAttachmentInfoFromDirectory
- Function Documentation
  - libCZI_ReaderGetAttachmentInfoFromDirectory()

Function libCZI_ReaderGetFileHeaderInfo
- Function Documentation
  - libCZI_ReaderGetFileHeaderInfo()

Function libCZI_ReaderGetMetadataSegment
- Function Documentation
  - libCZI_ReaderGetMetadataSegment()

Function libCZI_ReaderGetPyramidStatistics
- Function Documentation
  - libCZI_ReaderGetPyramidStatistics()

Function libCZI_ReaderGetStatisticsEx
- Function Documentation
  - libCZI_ReaderGetStatisticsEx()

Function libCZI_ReaderGetStatisticsSimple
- Function Documentation
  - libCZI_ReaderGetStatisticsSimple()

Function libCZI_ReaderOpen
- Function Documentation
  - libCZI_ReaderOpen()

Function libCZI_ReaderReadAttachment
- Function Documentation
  - libCZI_ReaderReadAttachment()

Function libCZI_ReaderReadSubBlock
- Function Documentation
  - libCZI_ReaderReadSubBlock()

Function libCZI_ReleaseAttachment
- Function Documentation
  - libCZI_ReleaseAttachment()

Function libCZI_ReleaseBitmap
- Function Documentation
  - libCZI_ReleaseBitmap()

Function libCZI_ReleaseChannelDisplaySettings
- Function Documentation
  - libCZI_ReleaseChannelDisplaySettings()

Function libCZI_ReleaseCreateSingleChannelTileAccessor
- Function Documentation
  - libCZI_ReleaseCreateSingleChannelTileAccessor()

Function libCZI_ReleaseCziDocumentInfo
- Function Documentation
  - libCZI_ReleaseCziDocumentInfo()

Function libCZI_ReleaseDisplaySettings
- Function Documentation
  - libCZI_ReleaseDisplaySettings()

Function libCZI_ReleaseInputStream
- Function Documentation
  - libCZI_ReleaseInputStream()

Function libCZI_ReleaseMetadataSegment
- Function Documentation
  - libCZI_ReleaseMetadataSegment()

Function libCZI_ReleaseOutputStream
- Function Documentation
  - libCZI_ReleaseOutputStream()

Function libCZI_ReleaseReader
- Function Documentation
  - libCZI_ReleaseReader()

Function libCZI_ReleaseSubBlock
- Function Documentation
  - libCZI_ReleaseSubBlock()

Function libCZI_ReleaseWriter
- Function Documentation
  - libCZI_ReleaseWriter()

Function libCZI_SingleChannelTileAccessorCalcSize
- Function Documentation
  - libCZI_SingleChannelTileAccessorCalcSize()

Function libCZI_SingleChannelTileAccessorGet
- Function Documentation
  - libCZI_SingleChannelTileAccessorGet()

Function libCZI_SubBlockCreateBitmap
- Function Documentation
  - libCZI_SubBlockCreateBitmap()

Function libCZI_SubBlockGetInfo
- Function Documentation
  - libCZI_SubBlockGetInfo()

Function libCZI_SubBlockGetRawData
- Function Documentation
  - libCZI_SubBlockGetRawData()

Function libCZI_WriterAddAttachment
- Function Documentation
  - libCZI_WriterAddAttachment()

Function libCZI_WriterAddSubBlock
- Function Documentation
  - libCZI_WriterAddSubBlock()

Function libCZI_WriterClose
- Function Documentation
  - libCZI_WriterClose()

Function libCZI_WriterCreate
- Function Documentation
  - libCZI_WriterCreate()

Function libCZI_WriterWriteMetadata
- Function Documentation
  - libCZI_WriterWriteMetadata()

Variables#

Variable kDimensionB
- Variable Documentation
  - kDimensionB

Variable kDimensionC
- Variable Documentation
  - kDimensionC

Variable kDimensionH
- Variable Documentation
  - kDimensionH

Variable kDimensionI
- Variable Documentation
  - kDimensionI

Variable kDimensionInvalid
- Variable Documentation
  - kDimensionInvalid

Variable kDimensionMaxValue
- Variable Documentation
  - kDimensionMaxValue

Variable kDimensionMinValue
- Variable Documentation
  - kDimensionMinValue

Variable kDimensionR
- Variable Documentation
  - kDimensionR

Variable kDimensionS
- Variable Documentation
  - kDimensionS

Variable kDimensionT
- Variable Documentation
  - kDimensionT

Variable kDimensionV
- Variable Documentation
  - kDimensionV

Variable kDimensionZ
- Variable Documentation
  - kDimensionZ

Variable kInvalidObjectHandle
- Variable Documentation
  - kInvalidObjectHandle

Variable kMaxDimensionCount
- Variable Documentation
  - kMaxDimensionCount

Variable kStreamErrorCode_UnspecifiedError
- Variable Documentation
  - kStreamErrorCode_UnspecifiedError

Variable LibCZIApi_ErrorCode_IndexOutOfRange
- Variable Documentation
  - LibCZIApi_ErrorCode_IndexOutOfRange

Variable LibCZIApi_ErrorCode_InvalidArgument
- Variable Documentation
  - LibCZIApi_ErrorCode_InvalidArgument

Variable LibCZIApi_ErrorCode_InvalidHandle
- Variable Documentation
  - LibCZIApi_ErrorCode_InvalidHandle

Variable LibCZIApi_ErrorCode_LockUnlockSemanticViolated
- Variable Documentation
  - LibCZIApi_ErrorCode_LockUnlockSemanticViolated

Variable LibCZIApi_ErrorCode_OK
- Variable Documentation
  - LibCZIApi_ErrorCode_OK

Variable LibCZIApi_ErrorCode_OutOfMemory
- Variable Documentation
  - LibCZIApi_ErrorCode_OutOfMemory

Variable LibCZIApi_ErrorCode_UnspecifiedError
- Variable Documentation
  - LibCZIApi_ErrorCode_UnspecifiedError

Typedefs#

Typedef AttachmentObjectHandle
- Typedef Documentation
  - AttachmentObjectHandle

Typedef BitmapObjectHandle
- Typedef Documentation
  - BitmapObjectHandle

Typedef ChannelDisplaySettingsHandle
- Typedef Documentation
  - ChannelDisplaySettingsHandle

Typedef CziDocumentInfoHandle
- Typedef Documentation
  - CziDocumentInfoHandle

Typedef CziReaderObjectHandle
- Typedef Documentation
  - CziReaderObjectHandle

Typedef CziWriterObjectHandle
- Typedef Documentation
  - CziWriterObjectHandle

Typedef DisplaySettingsHandle
- Typedef Documentation
  - DisplaySettingsHandle

Typedef InputStreamObjectHandle
- Typedef Documentation
  - InputStreamObjectHandle

Typedef LibCZIApiErrorCode
- Typedef Documentation
  - LibCZIApiErrorCode

Typedef MemoryAllocationObjectHandle
- Typedef Documentation
  - MemoryAllocationObjectHandle

Typedef MetadataSegmentObjectHandle
- Typedef Documentation
  - MetadataSegmentObjectHandle

Typedef ObjectHandle
- Typedef Documentation
  - ObjectHandle

Typedef OutputStreamObjectHandle
- Typedef Documentation
  - OutputStreamObjectHandle

Typedef SingleChannelScalingTileAccessorObjectHandle
- Typedef Documentation
  - SingleChannelScalingTileAccessorObjectHandle

Typedef SubBlockObjectHandle
- Typedef Documentation
  - SubBlockObjectHandle