CommentsSupported Method

Summary

Checks whether the given file format supports comment fields.

Syntax

Objective-C

C++

Java

public static bool CommentsSupported( 
   RasterImageFormat format 
)

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

+ (BOOL)commentsSupported:(LTRasterImageFormat)format

public static boolean commentsSupported(RasterImageFormat format)

public: 
static bool CommentsSupported(  
   RasterImageFormat format 
)

Parameters

format
The RasterImageFormat to check

Return Value

true if the format supports comment fields; otherwise it is false.

Remarks

This is a helper method that can be used to detect if a certain raster file format supports comment fields. For example, ReadComment and ReadComments can be used to read the comments stored in a file. If the file format supports comments, such as JPEG or EXIF, then these methods will successfully return the comments stored.

However, if the format does not support comments, such as BMP, an exception will be thrown by the RasterCodecs objects. You can use CommentsSupported to determine whether the file supports comments 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 comments when the CodecsLoadOptions.Comments is set to true and only read the file comments if the file format supports them.

Example

For an example, refer to ReadTags.

Requirements

Target Platforms