Sets the comment of a JPEG, PNG or GIF image.
Namespace:
FreeImageAPIAssembly: 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
| Exception | Condition |
|---|---|
| System..::.ArgumentNullException | dib is null. |
