CreateGdPictureImageFromFTP Method (GdPictureImaging)

In This Topic

Creates a new GdPicture image from a file stored on a distant server using FTP protocol according to what you have specified. The newly created image is identified by its unique non-zero image identifier.

Please note that it is your responsibility to release the image resources once you have no use for them.

Syntax

Visual Basic
C#
Delphi
JScript
Managed Extensions for C++
C++/CLI

'Declaration
 
Public Function CreateGdPictureImageFromFTP( _
   ByVal Host As String, _
   ByVal Path As String, _
   ByVal Login As String, _
   ByVal Password As String, _
   ByVal FTPPort As Integer _
) As Integer

public int CreateGdPictureImageFromFTP( 
   string Host,
   string Path,
   string Login,
   string Password,
   int FTPPort
)

public function CreateGdPictureImageFromFTP( 
    Host: String;
    Path: String;
    Login: String;
    Password: String;
    FTPPort: Integer
): Integer;

public function CreateGdPictureImageFromFTP( 
   Host : String,
   Path : String,
   Login : String,
   Password : String,
   FTPPort : int
) : int;

public: int CreateGdPictureImageFromFTP( 
   string* Host,
   string* Path,
   string* Login,
   string* Password,
   int FTPPort
)

public:
int CreateGdPictureImageFromFTP( 
   String^ Host,
   String^ Path,
   String^ Login,
   String^ Password,
   int FTPPort
)

Parameters

Host: The name of the host server, where the file is located, for example ftp.gdpicture.com.
Path: The file path of the image on the host server, for example /demo/image.jpg.
Login: The user's login required to authenticate on the server.
Password: The user's password required to authenticate on the server.
FTPPort: The FTP port number used. It is usually 21.

Return Value

A unique image identifier of the GdPicture image representing the newly created image. The returned value is non-zero if the image is successfully created. Please first of all use the GdPictureImaging.GetStat method to determine if this method has been successful.

Use the GdPictureImaging.GetLastTransferError method to diagnose the error if this method has failed with one of the GdPictureStatus.Internet... errors.

Be aware that you need to release the image with the GdPictureImaging.ReleaseGdPictureImage method after being used.

Remarks

It is recommend to use the GdPictureImaging.GetStat method to identify the specific reason for the method's failure, if any.

All document formats currently supported by the toolkit are listed here.

This class loads multipage images (GIF and TIFF formats) in read-write mode by default. If you want to open multipage images in read-only mode, you need to call the GdPictureImaging.GifOpenMultiFrameForWrite method for GIF format and the GdPictureImaging.TiffOpenMultiPageForWrite method for TIFF format and set the WriteAccess parameter to false before creating an image.

This method requires the Image Documents component to run.

Reference

GdPictureImaging Class
GdPictureImaging Members
GetStat Method
GetLastTransferError Method
ReleaseGdPictureImage Method
GifOpenMultiFrameForWrite Method
TiffOpenMultiPageForWrite Method