IKGifFileSave

This function saves raster image data in a GIF file.

[C++Builder/Visual C++] BOOL IKGifFileSave(LPCTSTR FileName, HANDLE Handle, BOOL Interlace, BOOL Trans, BYTE Red, BYTE Green, BYTE Blue, BOOL Anime, int Delay, LPCSTR Comment, IKPROCESSPROC UserProc, LPCTSTR Caption, LPCTSTR Message, LPCTSTR Button);

[Delphi] function IKGifFileSave(FileName: PChar; Handle: THandle; Interlace, Trans: LongBool; Red, Green, Blue: Byte; Anime: LongBool; Delay: Integer; Comment: PChar; UserProc: LONG_PTR; Caption, Message, Button: PChar): LongBool;

[Visual Basic] Function IKGifFileSave(ByVal FileName As String, ByVal Handle As Long, ByVal Interlace As Long, ByVal Trans As Long, ByVal Red As Byte, ByVal Green As Byte, ByVal Blue As Byte, ByVal Anime As Long, ByVal Delay As Long, ByVal Comment As String, ByVal UserProc As Long, ByVal Caption As String, ByVal Message As String, ByVal Button As String) As Long

Parameters

Name	Explanation
FileName	The name of the file where the image data is saved
Handle	The image handle of the raster image
Interlace	Sets whether or not interlace is enabled (False (0): No interlacing, True (nonzero) Interlacing)
Trans	Sets whether or not the transparent color is enabled (False (0): No transparency, True (nonzero): Transparency enabled)
Red	The red component of the transparent color (from 0 to 255) Enabled only when Trans is True
Green	The green component of the transparent color (from 0 to 255) Enabled only when Trans is True
Blue	The blue component of the transparent color (from 0 to 255) Enabled only when Trans is True
Anime	False (0): Single image, True (nonzero): Animation Gif (Multi-page image) When Anime is True (nonzero) the file is appended after the last page in the image file.
Delay	The interval after one image is displayed and before the next image is displayed (in units of 1/100 seconds). *Effective when Anime is set to True(nonzero).
Comment	The comment text to be saved (MAX:1023 bytes)
UserProc	The address of the user function (If not using the user function then set to 0)
Caption	Sets the text displayed in the title bar of the progress dialog box
Message	Sets the message displayed in the progress dialog box
Button	Sets the name of the button displayed in the progress dialog box

Return Value

Returns True (nonzero) if successful. Returns False (0) if unsuccessful.

Explanation

The IKGifFileSave function saves raster image data in a GIF file. Supports 1, 4, and 8 bit color.

If the user function is set or if the Caption, Message, and Button parameters are blank then the Progress dialog box is not displayed. If the Progress dialog box is displayed, it indicates the percentage of the current process completed. For more information about the user function please refer to the Definition of User Function in the Ik9File.dll, Ik9FileA.dll, Ik9File64.dll, Ik9File64A.dll section.

It is possible to save the file directly to FTP server or HTTP(S) server by setting the FTP or HTTP(S) server name in the FileName parameter.

(1) When saving the file to a local drive or network drive:
IKGifFileSave("c:\abc.gif", .....)

(2) When saving the file to FTP server:
IKGifFileSave("FTP://www.newtone.co.jp/image/abc.gif;;;true;user;password", .....)

(*)Parameter order when setting the FileName:
FTP://ServerName/FolderName/FileName;ProxyName;PortNumber;PassiveMode;UserName;Password

When setting or changing the proxy server, the port number, and passive (PASV) mode connection, please be sure to pass in this information seperated by semicolons. Set the FTP server name or IP address, the proxy server name or IP address, the port number, passive mode connection, etc. If the port number is omitted, the defaul port number will be used. Passive mode connection can be either "true" or "false" in upper case or lower case letters. If omitted, passive mode connection will be used.

(3) When saving the file to HTTP(S) server:
IKGifFileSave("http://www.newtone.co.jp/image/abc.gif;;;;user;password", .....)

(*)Parameter order when setting the FileName:
HTTP://ServerName/FolderName/FileName;ProxyName;PortNumber;HTTPS;UserName;Password

When setting or changing the proxy server, the port number, or using HTTPS, please be sure to pass in this information seperated by semicolons. Set the HTTP(S) server name or IP address, the proxy server name or IP address, the port number, HTTPS, etc. If the port number is omitted, the defaul port number will be used. IF HTTPS is omitted then HTTP server will be used.

[Differences from ImageKit7 ActiveX]
The ImageKit7 ActiveX only allowed files from local drives or network drives to be loaded or saved. Files can now be loaded and saved from FTP servers and HTTP(S) servers.