Sets the comment of a JPEG, PNG or GIF image.

Namespace:  FreeImageAPI
Assembly:  FreeImageNET (in FreeImageNET.dll)

Syntax

C#
public static bool SetImageComment(
	FIBITMAP dib,
	string comment
)
Visual Basic (Declaration)
Public Shared Function SetImageComment ( _
	dib As FIBITMAP, _
	comment As String _
) As Boolean
Visual C++
public:
static bool SetImageComment(
	FIBITMAP dib, 
	String^ comment
)

Parameters

dib
Type: FreeImageAPI..::.FIBITMAP
Handle to a FreeImage bitmap.
comment
Type: System..::.String
New comment of the FreeImage bitmap. Use null to remove the comment.

Return Value

Returns true on success, false on failure.

Exceptions

ExceptionCondition
System..::.ArgumentNullException dib is null.

Version Information

FreeImage.NET

Supported in: 3.11.0, 3.12.0, 3.13.0, 3.13.1

See Also