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

Visual Basic (Usage)	Copy Code
Dim format As RasterImageFormat Dim value As Boolean   value = RasterCodecs.CommentsSupported(format)

public static bool CommentsSupported( 
   RasterImageFormat format
)

public:
static bool CommentsSupported( 
   RasterImageFormat format
) 

Parameters

format

The RasterImageFormat to check

Return Value

This is a helper method that can be used to detect if a certain raster file format supports comment fields. For example, ReadComment and RasterCodecs.ReadComments(String,Int32) 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 check if 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 check if the file supports comments when the CodecsLoadOptions.Comments is set to true and only read the file comments if the file format supports them.

Target Platforms: Microsoft .NET Framework 3.0, Windows XP, Windows Server 2003 family, Windows Server 2008 family

Reference