MarkersSupported Method

Summary

Checks whether the given file format supports markers.

Syntax

Objective-C

C++

Java

public static bool MarkersSupported( 
   RasterImageFormat format 
)

Public Shared Function MarkersSupported( _ 
   ByVal format As RasterImageFormat _ 
) As Boolean

+ (BOOL)markersSupported:(LTRasterImageFormat)format

public static boolean markersSupported(RasterImageFormat format)

public: 
static bool MarkersSupported(  
   RasterImageFormat format 
)

Parameters

format
The RasterImageFormat to check

Return Value

true if the format supports markers; otherwise it is false.

Remarks

This is a helper method that can be used to detect if a certain raster file format supports markers. For example, ReadMarkers can be used to read the markers stored in a file. If the file format supports markers, such as EXIF, then these methods will successfully return the markers stored.

However, if the format does not support markers, such as BMP, an exception will be thrown by the RasterCodecs objects. You can use MarkersSupported to determine whether the file supports markers and only call the read methods if the return value is true.

Note that the RasterCodecs option uses this method internally to determine whether the file supports markers when the CodecsLoadOptions.Markers is set to true and only read the file markers if the file format supports them.

Example

For an example, refer to ReadTags.

Requirements

Target Platforms