version 11 (Modified)
ここではマニュアルで使用される主要な引数の意味やフォーマットを説明します。
引数 | タイプ | 説明 | |
hostName | 文字列 | --> | ホスト名 (例: "www.companyname.com") |
IPアドレス (例: "204.118.90.2") | |||
ip_LongInt | 倍長整数 | --> | IPアドレス参照 |
mailAddress | テキスト | --> | 例: "jsmith@4d.com" |
addressList | テキスト | --> | 例: "jsmith@4d.com, jdupont@4d.fr" または |
"jsmith@4d.com"+Char(13)+"jdupont@4d.fr" | |||
localPath | テキスト | --> | - ドキュメント |
Mac: "My Hard Drive:4DDB:SalesDB:Report" | |||
Win: "C:\MyDrive\4DDB\SalesDB\Report.txt" | |||
- Directory | |||
Mac: "My Hard Drive:CoolStuff:" (Note trailing ":") | |||
Win: "C:\MyDrive\CoolStuff\" | |||
hostPath | テキスト | --> | - ドキュメントt |
"/usr/jsmith/reports/salesreport.txt" | |||
- ディレクトリ | |||
"/usr/jsmith/reports/"(最後の"/"に注意) | |||
tcp_ID | 倍長整数 | --> | 開かれたTCPセッションの参照 |
smtp_ID | 倍長整数 | --> | メールメッセージ参照 |
pop3_ID | 倍長整数 | --> | 開かれたPOP3セッション参照 |
imap_ID | 倍長整数 | --> | 開かれたIMAP接続参照 |
ftp_ID | 倍長整数 | --> | 開かれたFTPセッション参照 |
udp_ID | 倍長整数 | --> | UDPソケット参照 |
戻り値 | 整数 | エラーコード |
hostName
hostNameは、"dns.4d.com"や"204.118.90.2"などのホスト名またはIPアドレスです。ホスト名はDomain Name System (DNS) を使用して解決されます。デフォルトおよびセカンダリDNSはたいていTCP/IPコントロールパネルで設定します。引数としてhostNameを必要とするすべての4D?Internet?Commandsは、ホスト名 ("www.4d.com") または IPアドレス ("204.118.90.2") 形式を受け付けます。ホスト名形式を使用すると、リモートサイトのマシン変更などに対応できるため、こちらの利用がが推奨されます。
ip_LongInt
すべてのホスト名はIPアドレスの解決することができます。IPアドレスに数学的な計算を行うことでユニークな倍長整数値に変換できます。NET_NameToAddrやNET_AddrToNameコマンドを使用して、これらの変換処理を行うことができます。この倍長整数値は、ドキュメントを通してip_LongIntとして参照されます。倍長整数値は直接的なTCP接続を行うなどの特別な状況でのみ使用されます。開発者によっては、ディスクスペースを減らす目的で、文字列のIPアドレスよりこの倍長整数値をレコードに保存することを選択するかもしれません。しかしIPV6との互換性の理由から、倍長整数値の利用を避けることをお勧めします。
mailAddress
mailAddressはメールの使用に完全に準拠した"user_name@domain_name"のフォーマットです。このドキュメントでは、mailAddressは一つのメールアドレスを指します。一つ以上のメールアドレスを受け付けるすべての4D Internet Commandsの引数は特にaddressList.と示されます。引数にmailAddressとだけ指定されている場合には、一つのメールアドレスのみが受け付けられます。mailAddressのフォーマットは、ユーザ名とドメイン名を含む完全な参照です。
"Felix Unger" <felix@pristine.com> | |
oscar@slobs.com (Oscar Madison) |
addressList
addressListは一つ以上のメールアドレスを含み、それぞれのアドレスはコンマまたはキャリッジリターンで区切られます。キャリッジリターンによる区切りは、複数ユーザのリストをテキストフィールドへの入力やペーストで提供する際に便利です。以下の三つの例は、$AddressListに有効なメールアドレスのリストを代入します。
$AddressList:="jsmith@4d.com" $AddressList:="jsmith@4d.com,scott@4d.com,marcel@4d.fr" For ($i;1;Size of array(aAddresses)) $AddressList:=$AddressList+aAddresses{$i}+Char(13) End For
localPath
localPathは、 (MacまたはWindowsの) ローカルマシン上のファイルやディレクトリの場所です。Macintoshではディレクトリ区切り文字にコロンを使用します。たとえば"My Hard Drive"ハードディスク内にある"Reports"フォルダ内のファイル"My Report"は、パス名が"My Hard Drive:Reports:My Report"となります。Macintoshではディレクトリを示すためにはコロンで終わります。たとえば同じフォルダにレポートを格納したい場合、ディレクトリは"My Hard Drive:Reports:"で参照できます。 ファイルまたはディレクトリどちらを参照するかは、コマンドが呼び出されたコンテキストにより決定されます。同様のフォーマットをWindowsで使用できますが、ディレクトリ区切り文字は円マークを使用します。
hostPath
hostPathはUnix OSシンタックスで記述されたファイルまたはディレクトリの場所です。Unix環境ではディレクトリはスラッシュで区切られます。たとえば"4D"ディレクトリ内のファイル"report.txt"は"/4D/reports/report.txt"で表現されます。ディレクトリのパス名はスラッシュで終了します。フルパス名はボリュームのルートを示すスラッシュで開始します。
smtp_ID, pop3_ID, imap_ID, ftp_ID, tcp_ID, udp_ID
4D Internet Commandsのそれぞれのセクションを通して、ほとんどのコマンドで数値のIDを参照します。それぞれの通信機能は倍長整数型IDで表現される独自のセッションを確立します。それに続くコマンドはこの値を使用して、適切なチャンネルを通じた通信を行います。
それぞれの節 (SMTP, POP3, IMAP, FTP, TCP, UDP) で取得できる"ID"番号を他の節のコマンドのIDとして渡すことはできません。しかし4D Internet Commandsでは、POP3, IMAP および FTP接続参照を直接低レベルのTCPコマンドに渡すことができます。またその逆も可能です。詳細な情報は低レベルルーチン - 概要の節を参照してください。
セッション参照 | 開くコマンド | 閉じるコマンド |
tcp_ID | TCP_Open または TCP_Listen | TCP_Close |
smtp_ID | SMTP_New | SMTP_Clear |
pop3_ID | POP3_Login | POP3_Logout または POP3_VerifyID |
imap_ID | IMAP_Login | IMAP_Logout または IMAP_VerifyID |
ftp_ID | FTP_Login | FTP_Logout または FTP_VerifyID |
udp_ID | UDP_New | UDP_Delete |
戻り値
すべての4D Internet Commands (IT_ErrorTextとIT_Versionを除く) はコマンドの結果として整数値を返します。この整数値にはコマンド実行時に発生したエラーコードが含まれています。
コマンドが正しく実行されると0が返されます。そうでなければエラーコードが返されます。4D Internet Commandsのエラーコードの詳細は、Appendix C, 4D Internet Commands Error codesを参照してください。