FTPIO

Section: C Library Functions (3)
索引 jman

BSD mandoc
 

索引

名称

ftpLogin ftpChdir ftpErrno ftpGetModtime ftpGetSize ftpGet ftpPut ftpBinary ftpPassive ftpVerbose ftpGetURL ftpPutURL ftpLoginAf , ftpGetURLAf , ftpPutURLAf - FTPIO ユーザライブラリ  

索引

書式

In ftpio.h Ft FILE * Fn ftpLogin char *host char *user char *passwd int ftp_port int verbose int *retcode Ft int Fn ftpChdir FILE *stream char *dirname Ft int Fn ftpErrno FILE *stream Ft const char * Fn ftpErrString int errno Ft time_t Fn ftpGetModtime FILE *stream char *file Ft off_t Fn ftpGetSize FILE *stream char *file Ft FILE * Fn ftpGet FILE *stream char *file off_t *seekto Ft FILE * Fn ftpPut FILE *stream char *file Ft int Fn ftpAscii FILE *stream Ft int Fn ftpBinary FILE *stream Ft int Fn ftpPassive FILE *stream int status Ft void Fn ftpVerbose FILE *stream int status Ft FILE * Fn ftpGetURL char *url char *user char *passwd int *retcode Ft FILE * Fn ftpPutURL char *url char *user char *passwd int *retcode Ft FILE * Fn ftpLoginAf char *host int af char *user char *passwd int ftp_port int verbose int *retcode Ft FILE * Fn ftpGetURLAf char *url int af char *user char *passwd int *retcode Ft FILE * Fn ftpPutURLAf char *url int af char *user char *passwd int *retcode  

索引

解説

この関数は、FTP コネクションを管理するための 高レベルなライブラリを実装します。

Fn ftpLogin は、指定された Fa user , Fa passwd , Fa ftp_port (0 を渡した場合、標準 FTP ポートの 21 がデフォルトで Fa ftp_port になる), Fa verbose フィールドを 使用してログインしようとします。ログインに成功すれば、標準的な ストリーム記述子が返されます。この記述子は、後の FTP オペレーションに 渡してください。エラーが発生した場合は NULL が返され、 Fa retcode には、外部サーバが返すエラーコードが入ります。

Fn ftpChdir は、サーバの CD コマンドを出し、 Fa dir で指定された ディレクトリに変更しようとします。問題がなければ 0 が返されます。 問題がある場合は、サーバのエラーコードが返されます。

Fn ftpErrno は、最後のオペレーションのサーバエラーコードを返します。 FTP のエラーコードに精通している場合は、エラーの原因の確認に有益です。 Fn ftpErrString は、人間が判読できるサーバエラーコードを返します。

Fn ftpGet は、 Fa file 引数が指定するファイルを取り出し (FTP サーバのカレントディレクトリ からの相対パスと想定される。 Fn ftpChdir 参照)、そのファイルのための新しい FILE* ポインタを返します。 エラーが発生した場合は NULL を返します。 Fa seekto が NULL ではない場合、これが指す整数の内容は、ファイルの再開ポイント として使用されます。つまり、返されたストリームは、ファイルの Fa *seekto バイトを指しているということです。これは、エラーで失敗した転送を 効率的に再開する際に便利です。シーク操作がエラーになった場合、 Fa *seekto の値は 0 になります。

Fn ftpGetModtime は、 Fa file 引数が指定するファイルの最終修正時刻を 返します。ファイルをオープンできない場合は 0 が返されます。

Fn ftpGetSize は、 Fa file 引数が指定するファイルのサイズをバイト単位で 返します。ファイルをオープンできない場合は -1 が返されます。

Fn ftpPut は、 Fa file 引数が指定する新しいファイルを作成し (FTP サーバのカレントディレクトリからの相対パスと想定される。 Fn ftpChdir 参照)、ファイルの新しい Fa stream ポインタを返します。エラーが発生した場合は NULL を返します。

Fn ftpAscii は、 Fa stream が指定する現行サーバのコネクションに ASCII モードを設定します。

Fn ftpBinary は、 Fa stream が指定する現行サーバのコネクションに バイナリモードを設定します。

Fn ftpPassive は、 Fa stream が指定する現在のサーバのコネクションのパッシブモード (ファイアウォール用)を論理値 Fa status に設定します。

Fn ftpVerbose は、 Fa stream が指定する現在のサーバのコネクションの冗長モードを論理値 Fa status に設定します。

Fn ftpGetURL は、 Fa URL が指定するファイルを取り出します。これは、 サーバの Fa stream が返されないこと除けば、 Fn ftpLogin , Fn ftpChdir , Fn ftpGet を組み合わせた操作と同じとみなすことができます。 サーバとのコネクションは、ファイルが完全に読み込まれた時点で クローズされます。複数のファイルを取り出す場合は、低レベルのルーチン を使用してください。この方がはるかに効率的です。

Fn ftpPutURL は、 Fa URL が指定するファイルを作成します。これは、 サーバの Fa stream が返されないことを除けば、 Fn ftpLogin , Fn ftpChdir , Fn ftpPut を組み合わせた操作と同じとみなすことができます。 サーバとのコネクションは、ファイルが完全に書き込まれた時点で クローズされます。複数のファイルを作成する場合は、低レベルのルーチン を使用してください。この方がはるかに効率的です。

Fn ftpLoginAf , Fn ftpGetURLAf , Fn ftpPutURLAf は、 Fn ftpLogin , Fn ftpGetURL , Fn ftpPutURL と同様ですが、アドレスファミリ except that they are able to specify address family Fa af を指定可能な点が異なります。  

索引

環境変数

FTP_TIMEOUT
FTP 接続を異常終了させる前に、通信相手からの応答を待つ最大時間 (秒単位) です。
FTP_PASSIVE_MODE
定義されている場合、パッシブモード FTP を強制的に使用します。 ただし ``NO'' または ``no'' に定義されている場合は、 アクティブモードを強制的に使用します。 定義されている場合、この変数の設定は、 Fn ftpPassive の呼び出しに優先します。

 

索引

バグ

こいつを徹底的に使い込むと、内部状態マシンを混乱させてしまう可能性が ありますが、私がテストした限りでは、非常に丈夫に作られていることが 確かめてあります。

 

索引

歴史

Poul-Henning Kamp のシステムインストレーションユーティリティ用 ftp ドライバとして始まり、Jordan Hubbard が、stdio の拡張という より一般的な形式に変更しました。 Jean-Marc Zucconi のアイデアと拡張機能もいくつか盛り込まれています。  

索引

作者

An Jordan Hubbard , An Poul-Henning Kamp , An Jean-Marc Zucconi


 

索引

Index

名称
書式
解説
環境変数
バグ
歴史
作者

jman



Time: 07:06:51 GMT, January 12, 2009