HSP command help

netagent

netagent "AgentName" [エージェントの設定]

"AgentName" : 設定するエージェント名

( 拡張プラグイン[hspinet]が必要です )

説明

http接続の際にサーバーに渡されるエージェント情報の文字列を設定します。"AgentName"で指定したエージェント名が設定されます。空の文字列("")を指定した場合には、デフォルトの設定になります。 netagent命令が実行されると、それまでのセッションが解除され、 neturl命令や、netheader命令による設定はリセットされます。

備考

hspinet.asをインクルードすること。

参照

 netproxy命令
 netheader命令

netdlname

netdlname "FileName" [ダウンロード名の設定]

"FileName" : ダウンロードされた時のファイル名

( 拡張プラグイン[hspinet]が必要です )

説明

ファイルを取得する際のファイル名を設定します。 netdlname命令によってファイル名を設定していない場合は、 httpリクエストを行なったファイル名が使用されます。 netdlname命令に、空の文字列("")を指定した場合も、 httpリクエストを行なったファイル名が使用されます。

備考

hspinet.asをインクルードすること。

参照

 netrequest命令
 netload命令

neterror

neterror p1			[ネットエラー文字列の取得]
p1 : エラー文字列が代入される変数
( 拡張プラグイン[hspinet]が必要です )
説明

エラー発生時の詳細を示す文字列を取得します。 p1で指定した変数に、文字列として代入されます。

備考

hspinet.asをインクルードすること。

netexec

netexec p1 [最小単位の処理を実行]

p1 : 処理の結果が代入される変数

( 拡張プラグイン[hspinet]が必要です )
説明

最小単位の処理を実行します。サーバーからの応答待ちや、ダウンロード中など時間のかかる処理を細かい単位で実行します。メインプログラムでは、await命令などで細かく待ち時間(ウェイト)を取りながらnetexec命令を呼び出す必要があります。
例: ; 結果待ちのためのループ repeat netexec res if res : break await 50 loop
実行後、結果がp1で指定された変数に代入されます。内容が0の場合は、処理が継続中であることを意味します。内容が1の場合は、処理が正常に終了していることを意味します。内容がマイナス値の場合は、何らかのエラーが発生したことを示しています。 statが0以外の値になった場合は、それに応じた処理を適宜スクリプト側で処理するようにしてください。

備考

hspinet.asをインクルードすること。

参照

 netmode命令
 netsize命令

netfileinfo

netfileinfo p1,"FileName" [httpファイル情報取得]

p1 : ファイル情報が代入される変数名
"FileName" : リクエストを行なうファイル名

( 拡張プラグイン[hspinet]が必要です )

説明

httpサーバー上にあるファイル情報を取得します。先に、neturl命令によりファイル名を除いたURLを指定しておく必要があります。取得に成功すると、システム変数statの値が0となり、p1で指定した変数に文字列型でサーバーが返した情報文字列が代入されます。取得に失敗した場合は、システム変数statに0以外が代入されます。サーバーが返す情報の種類は、httpサーバーによって異なります。詳しくは、RFCなどhttpプロトコルの解説を参照してください。 netfileinfo命令は、ファイルの取得が終了するまで、処理を中断します。

備考

hspinet.asをインクルードすること。

参照

 neturl命令
 netload命令

netheader

netheader "HeaderString" [ヘッダ文字列の設定]

"HeaderString" : ヘッダに追加される文字列

( 拡張プラグイン[hspinet]が必要です )
説明

http接続の際にサーバーに渡されるヘッダ文字列を設定します。空の文字列("")を指定した場合には、無設定になります。ヘッダ文字列は、通常設定する必要ありませんが、何からの付加情報や動作設定を行なう場合に使用することができます。 netheader命令で設定したヘッダ文字列は、それ以降のリクエストすべてに適用されます。
例: ; リファラーを追加する netheader "Referer:http://www.onionsoft.net/\n\n"

備考

hspinet.asをインクルードすること。

参照

 netagent命令

netinit


[ネット接続の初期化]

( 拡張プラグイン[hspinet]が必要です )

説明

Wininet.dllの初期化を行ないます。 net～で始まる命令を使用する際には、最初に１回だけ必ず実行する必要があります。実行後に結果がシステム変数statに格納されます。 0ならば正常終了、それ以外はエラーが発生したことを示しています。

備考

hspinet.asをインクルードすること。

参照

 netterm命令

netload

netload "FileName" [httpファイル取得]

"FileName" : リクエストを行なうファイル名

( 拡張プラグイン[hspinet]が必要です )

説明

httpリクエストを行ないます。先に、neturl命令によりファイル名を除いたURLを指定しておく必要があります。 netload命令は、ファイルの取得が終了するまで、処理を中断します。手軽にファイルの取得を行なうことが可能ですが、大きなファイルや受信状態の悪い場合などは、そのまま画面が停止したままになる可能性もあるので注意してください。ファイルの受信中に、並行して別な処理を行ないたい場合には、 netrequest命令を使用してhttpリクエストを行なってください。

備考

hspinet.asをインクルードすること。

参照

 neturl命令
 netrequest命令
 netfileinfo命令

netmode

netmode p1 [モードの取得]

p1 : モード値が代入される変数

( 拡張プラグイン[hspinet]が必要です )
説明

現在の処理モードを取得します。 p1で指定された変数にモード値が代入されます。モード値の内容は以下の通りです。 httpリクエストは、INET_MODE_READYの状態で発行するようにしてください。 ftpリクエストは、INET_MODE_FTPREADYの状態で発行するようにしてください。
ラベル | 値状態 ------------------------------------------------------ INET_MODE_NONE | 0 未初期化の状態 INET_MODE_READY | 1 待機状態 INET_MODE_REQUEST | 2 httpリクエスト受付 INET_MODE_REQSEND | 3 httpリクエスト送信中 INET_MODE_DATAWAIT | 4 httpデータ受信中 INET_MODE_DATAEND | 5 httpデータ受信終了処理中 INET_MODE_INFOREQ | 6 http情報リクエスト送信中 INET_MODE_INFORECV | 7 http情報データ受信中 INET_MODE_FTPREADY | 8 ftp待機状態 INET_MODE_FTPDIR | 9 ftpディレクトリ情報取得中 INET_MODE_FTPREAD | 10 ftpファイル受信中 INET_MODE_FTPWRITE | 11 ftpファイル送信中 INET_MODE_FTPCMD | 12 ftpコマンド送信終了処理中 INET_MODE_FTPRESULT| 13 ftpサーバー返信データ受信中 INET_MODE_ERROR | 14 エラー状態

備考

hspinet.asをインクルードすること。

参照

 netexec命令

netproxy

netproxy "ServerName",p1,p2 [プロキシの設定]

"ServerName" : リクエストを行なうファイル名
p1 (0) : ポート番号
p2 (0) : ローカル接続フラグ

( 拡張プラグイン[hspinet]が必要です )
説明

http接続の際に使用されるプロキシ(代理)サーバーを設定します。 "ServerName"で、プロキシサーバー名を設定します。空の文字列("")を指定した場合には、プロキシは設定されません。 p1でhttpが使用するプロキシサーバーのポート番号を指定します。 p2で、ローカルアドレスをプロキシ経由のアクセスから除外するかどうかを設定します。1の場合は、ローカルアドレスのみプロキシから除外されます。0の場合は、ローカルアドレスも含めてプロキシを使用します。 netproxy命令が実行されると、それまでのセッションが解除され、 neturl命令や、netheader命令による設定はリセットされます。
例: netinit if stat : dialog "ネット接続できません。" : end netproxy "proxy_server",8080,1 neturl "http://www.onionsoft.net/hsp/" netload "index.html"

備考

hspinet.asをインクルードすること。

参照

 netagent命令
 netheader命令

netrequest

netrequest "FileName" [httpリクエスト発行]

"FileName" : リクエストを行なうファイル名

( 拡張プラグイン[hspinet]が必要です )

説明

httpリクエストを行ないます。先に、neturl命令によりファイル名を除いたURLを指定しておく必要があります。 netrequest命令でhttpリクエストを発行した後は、netexec命令により受信処理をスクリプト側で行なう必要があります。受信処理を自動で行なうためのnetload命令も別途用意されています。

備考

hspinet.asをインクルードすること。

参照

 neturl命令
 netload命令
 netfileinfo命令

netsize

netsize p1 [ファイル受信サイズの取得]

p1 : ファイル受信サイズが代入される変数

( 拡張プラグイン[hspinet]が必要です )

説明

netrequest命令で発行されたhttpリクエストに対するファイルがどれだけのサイズを受信したかを取得します。 p1で指定された変数にファイル受信サイズが代入されます。ファイル受信サイズは、netexec命令で受信が行なわれた内容を調べるためのものです。あらかじめ、ファイル情報取得でファイルサイズを調べておけば、進行の割合を計ることが可能です。

備考

hspinet.asをインクルードすること。

参照

 netexec命令

netterm


[ネット接続の終了]

( 拡張プラグイン[hspinet]が必要です )

説明

Wininet.dllの終了処理を行ないます。通常、この命令はプログラム終了時に自動的に呼び出されるため、特にスクリプトに記述する必要はありません。

備考

hspinet.asをインクルードすること。

参照

 netinit命令

neturl


neturl "URL"			[URLの設定]

"URL" : URLを示す文字列

( 拡張プラグイン[hspinet]が必要です )

説明

httpリクエストを行なうURLを設定します。 URLは、ファイル名を除いた形でスキーム名を含めて設定する必要があります。「http://www.onionsoft.net/hsp/index.html」の場合は、「http://www.onionsoft.net/hsp/」までを設定してください。 httpリクエストは必ず、neturl命令によるURL設定を先に行なっておいてください。neturl命令実行の時点では、まだhttpリクエストは発行されません。 httpリクエストの発行は、netrequest命令またはnetload命令によって行なわれます。

備考

hspinet.asをインクルードすること。

参照

 netrequest命令
 netload命令
 netfileinfo命令

newcom

newcom p1,p2,p3,p4 [COMオブジェクト型変数の新規作成]

p1 : 変数名
p2 : インターフェース名、またはクラスID
p3(0) : 作成モード(オプション)
p4 : 参照元ポインタ(オプション)
説明

p1で指定した変数をCOMオブジェクト型として初期化を行ないます。 p1の変数がCOMオブジェクト型でない場合は、COMオブジェクト型として初期化されます。^ すでにCOMオブジェクト型の場合、以前のオブジェクトは破棄されます。 p2でクラスIDかまたは、プログラムID(ProgID)を指定することができます。
例: newcom ie, "InternetExplorer.Application" ; ProgID
上の例では、プログラムIDを使用して初期化を行なっています。これにより変数ieは、COMオブジェクト型変数として初期化されます。また、#usecom命令によりすでに定義されているインターフェース名を指定して初期化することが可能です。
例: #define IID_IDirectMusicPerformance8 "{679c4137-c62e-4147-b2b4-9d569acb254c}" #define IID_IDirectMusicLoader8 "{19e7c08c-0a44-4e6a-a116-595a7cd5de8c}" #usecom IDirectMusicLoader8 IID_IDirectMusicLoader8　CLSID_DirectMusicLoader newcom loader, IDirectMusicLoader8
p3で作成モードを指定することができます。p3を省略した場合にはモード0となります。
モード内容 ------------------------------------------------------------------ 0 指定されたクラスのCOMをサーバーとして呼び出す -1 p4で指定されたポインタとするCOMオブジェクト型変数を作成
p3が-1の場合は、COMオブジェクトを新規に作成せずに、p4で指定された値をポインタとするCOMオブジェクト型変数を作成します。

COMオブジェクト型変数は、Windowsが持つCOMの仕組みをHSPから呼び出すための仕組みに使用されます。詳しくは、プログラミングマニュアルを参照してください。

備考

ver3.0標準命令

参照

 #usecom命令
 #comfunc命令
 delcom命令
 axobj命令
 querycom命令
 comres命令
 mcall命令

newevent

newevent p1 [イベントリストを作成]

p1 : イベントIDが代入される変数名

( 拡張プラグイン[hgimg3]が必要です )

説明

新しいイベントIDを取得し、p1で指定した変数に代入します。

新しくイベントを作成する場合には、必ずnewevent命令でイベントIDを取得しておく必要があります。次に、「event_」で始まるイベントリスト追加命令によって多彩な動作を登録しておくことができます。一度取得されたイベントIDは、シーンのリセット(hgreset命令)が行なわれるか、またはdelevent命令によってイベントリストが削除されるまでは保持されます。

こうしてできたイベントは、setevent命令によっていつでもオブジェクトに対して適用することができます。

備考

hgimg3.asをインクルードすること。

参照

 delevent命令
 setevent命令

newmod

newmod p1,p2,p3... [モジュール型変数の作成]

p1 : 変数名
p2 : モジュール名
p3... : 初期化パラメーター
説明

p1で指定した変数をモジュール型として要素の追加を行ないます。 p1の変数がモジュール型でない場合は、モジュール型として初期化されます。すでにモジュール型の場合は、配列変数として新しい要素を追加していきます。 p2ですでに登録されているモジュール名を指定し、p3以降に初期化パラメーターを指定することができます。モジュール変数は、複数の変数やデータをまとめて管理することができる新しいデータ格納方法を提供します。
例 : #module a x,y,z
上の例では、aというモジュールにx,y,zという３つの変数を持たせています。 aというモジュールの型を持つ変数は、x,y,zという変数すべてを内包したものになり、モジュール処理命令(#modfunc)で扱うことが可能になります。
例 : newmod v,a
上の例では、モジュール「a」のための変数vを初期化します。これで変数vには、モジュール「a」が持つモジュール変数x,y,zという内容が丸ごと格納されることになります。モジュールごとに初期化のための命令(#modinit)を用意している場合は、p3以降のパラメーターが初期化命令に渡されます。
例 : #module a x,y,z #modinit int p1,int p2,int p3 x=p1:y=p2:z=p3 return #global newmod v,a,1,2,3
モジュール型の変数は、setmod命令やdelmod命令で要素の操作を行なうことができるほか、 foreach命令などとともに複雑なデータを簡潔に処理することができるようになります。

備考

ver3.0標準命令

参照

 #modfunc命令
 #modinit命令
 #modterm命令
 setmod命令
 delmod命令
 foreach命令


[指定回数繰り返し終了]

説明

forで指定した繰り返し区間の終わりを指定します。詳しくはforマクロの項を参照してください。

備考

ver3.0標準命令

参照

 for命令

nextobj

nextobj val [次のオブジェクト検索]

val : 結果が代入される変数名

( 拡張プラグイン[hgimg3]が必要です )

説明

findobj命令で指定された条件をもとにオブジェクトを検索します。検索されると、変数にオブジェクトIDが代入されます。検索対象がなくなった時には-1が代入されます。

備考

hgimg3.asをインクルードすること。

参照

 setcoli命令
 findobj命令

not


[否定(演算子)]

説明

否定を示す演算子「!」と同様に使用することができるマクロです。

※このシステム変数は、マクロとしてhspdef.as内で定義されています。

備考

ver3.0標準

参照

 and命令
 or命令
 xor命令

noteadd

noteadd p1,p2,p3 [指定行の追加・変更]

p1=文字列 : 追加・変更をする文字列または変数名
p2=0～(-1) : 追加するインデックス
p3=0～1(0) : 上書きモード指定(0=追加・1=上書き)

説明

メモリノートパッドの内容を追加・変更します。

p1に追加・変更するための文字列を指定します。p2で、対象となるインデックスを指定します。 p2パラメータを省略するか、-1を指定すると最終行が対象になります。 p3パラメータで、追加か上書きかを指定します。省略するか、0を指定すると、追加モードとなり、対象となるインデックス以降が１つづつシフトします。 p3が1の場合は、上書きモードとなり、対象となるインデックスの内容は消去され、指定した文字列に置き換えられます。

noteaddは、変数バッファにsdim命令などであらかじめ確保された容量を超えて内容を追加しようとした場合でも、自動的に確保容量を増加させて格納します。つまり、「sdim a,64」で６４文字までしか記憶できないメモリバッファであっても、noteadd命令であれば、追加するサイズに応じて自動的にメモリサイズを調節して安全に記憶させることができます。 (通常の代入命令で行なった場合はバッファオーバーフローのエラーとなります)

メモリノートパッド命令(noteget,noteadd,notedel,noteinfo)を使用するためには、最初にnotesel命令で対象となるバッファを設定しなければなりません。

備考

ver3.0標準命令

参照

 notesel命令

notedel

notedel p1 [行の削除]

p1=0～ : 削除するインデックス

説明

メモリノートパッドの指定したインデックスを削除します。 p1で指定したインデックスの内容は削除され、以降のインデックスが１つづつシフトします。

メモリノートパッド命令(noteget,noteadd,notedel,noteinfo)を使用するためには、最初にnotesel命令で対象となるバッファを設定しなければなりません。

備考

ver3.0標準命令

参照

 notesel命令

noteget

noteget p1,p2 [指定行を読み込み]

p1=変数 : 読み出し先の変数名
p2=0～(0) : 読み出すインデックス

説明

メモリノートパッド内の、p2で指定したインデックスの内容をp1で指定された変数に代入します。メモリノートパッド内の任意の行にある内容を読み出すことができます。

インデックスは0から始まるので注意してください。 p1で指定する変数には、読み出すのに十分なバッファを確保するのを忘れないでください。また、p1の変数は強制的に文字列型に変更されます。

メモリノートパッド命令(noteget,noteadd,notedel,noteinfo)を使用するためには、最初にnotesel命令で対象となるバッファを設定しなければなりません。

備考

ver3.0標準命令

参照

 notesel命令

noteinfo

noteinfo (p1) [メモリノートパッド情報取得]

p1(0) : 情報取得モード
説明

noteinfo関数は、現在対象となっているメモリノートパッドについての情報を取得します。 p1で情報取得モードを指定します。また、それぞれのモードに対応したマクロが定義されています。
モード : マクロ内容 ----------------------------------------------------------- 0 : notemax 全体の行数 1 : notesize 全体の文字数(バイト数)
notemaxマクロは、複数行の文字列ですべての行に対して繰り返し処理を行ないたい場合などに使用します。全体の行数とは、つまりメモリノートパッド内にある要素の数です。「APPLE」「ORANGE」「GRAPE」という行がある場合には、3になります。この場合、インデックスは0～2までになります。

メモリノートパッド命令(noteget,noteadd,notedel,noteinfo)を使用するためには、最初にnotesel命令で対象となるバッファを設定しなければなりません。

備考

ver3.0標準命令

参照

 notesel命令
 noteget命令
 notedel命令
 notemax命令
 notesize命令

noteload

noteload "filename",p1 [対象バッファ読み込み]

"filename" : 読み込みファイル名
p1(0) : 読み込みサイズの上限値

説明

指定したファイルをメモリノートパッド命令のバッファに読み込みます。通常は、テキストファイルを読み込み、メモリノートパッド命令で読み出す対象とします。メモリノートパッド命令のバッファは、自動的にファイルのサイズに従って確保サイズが調節されるため、バッファのサイズをあらかじめ指定しておく必要はありません。 p1で、読み込むファイルの最大サイズを指定することができます。指定を省略または0にした場合は、どんなサイズでも読み込みます。テキストファイル以外のファイルを読み込むことも可能です。必ず最初にnotesel命令で対象となるバッファを設定する必要があるので注意してください。

備考

ver3.0標準命令

参照

 notesel命令
 notesave命令
 noteget命令
 noteadd命令
 notedel命令
 noteinfo命令
 notemax命令
 notesize命令

notemax


[メモリノートパッドの行数]

説明

現在選択されているメモリノートパッド全体の行数を示すシステム変数として使用することができます。 noteinfo関数でも同様の情報を取得することが可能です。

※このシステム変数は、マクロとしてhspdef.as内で定義されています。

備考

ver3.0標準

参照

 noteinfo命令

notesave

notesave "filename" [対象バッファ保存]

"filename" : 書き込みファイル名

説明

メモリノートパッド命令のバッファの内容を指定したファイルにテキストファイルとして保存します。必ず最初にnotesel命令で対象となるバッファを設定する必要があるので注意してください。 notesave命令は、指定バッファに含まれる文字列の長さで保存します。

備考

ver3.0標準命令

参照

 notesel命令
 noteload命令
 noteget命令
 noteadd命令
 notedel命令
 noteinfo命令

notesel

notesel p1 [対象バッファ指定]

p1=変数 : バッファを割り当てた変数名

説明

p1で指定した変数をメモリノートパッド命令のバッファに設定します。

p1で指定した変数は、強制的に文字列型に変更されます。他のメモリノートパッド命令(noteget,noteadd,notedel,noteinfo)を使用するためには、最初に notesel命令で対象となるバッファを設定しなければなりません。

備考

ver3.0標準命令

参照

 noteunsel命令
 noteget命令
 noteadd命令
 notedel命令
 noteinfo命令
 notemax命令
 notesize命令

notesize


[メモリノートパッドの文字数]

説明

現在選択されているメモリノートパッド全体の文字数(byte数)を示すシステム変数として使用することができます。 noteinfo関数でも同様の情報を取得することが可能です。

※このシステム変数は、マクロとしてhspdef.as内で定義されています。

備考

ver3.0標準

参照

 noteinfo命令

noteunsel


[対象バッファの復帰]

説明

noteunsel命令は、notesel命令で対象となるバッファを設定する前に設定されていたバッファ設定に戻します。 noteunsel命令は必ず入れておく必要はありませんが、 notesel命令で設定したバッファを使い終わった後に入れておくことで、 noteselによるバッファ指定が多重に行なわれることを防止します。

備考

ver3.0標準命令

参照

 notesel命令

netagent

"AgentName" : 設定するエージェント名

netdlname

"FileName" : ダウンロードされた時のファイル名

neterror

p1 : エラー文字列が代入される変数

netexec

p1 : 処理の結果が代入される変数

netfileinfo

p1 : ファイル情報が代入される変数名 "FileName" : リクエストを行なうファイル名

netheader

"HeaderString" : ヘッダに追加される文字列

netinit

netload

"FileName" : リクエストを行なうファイル名

netmode

p1 : モード値が代入される変数

netproxy

"ServerName" : リクエストを行なうファイル名 p1 (0) : ポート番号 p2 (0) : ローカル接続フラグ

netrequest

"FileName" : リクエストを行なうファイル名

netsize

p1 : ファイル受信サイズが代入される変数

netterm

neturl

"URL" : URLを示す文字列

newcom

p1 : 変数名 p2 : インターフェース名、またはクラスID p3(0) : 作成モード(オプション) p4 : 参照元ポインタ(オプション)

newevent

p1 : イベントIDが代入される変数名

newmod

p1 : 変数名 p2 : モジュール名 p3... : 初期化パラメーター

next

nextobj

val : 結果が代入される変数名

not

noteadd

p1=文字列 : 追加・変更をする文字列または変数名 p2=0～(-1) : 追加するインデックス p3=0～1(0) : 上書きモード指定(0=追加・1=上書き)

notedel

p1=0～ : 削除するインデックス

noteget

p1=変数 : 読み出し先の変数名 p2=0～(0) : 読み出すインデックス

noteinfo

p1(0) : 情報取得モード

noteload

"filename" : 読み込みファイル名 p1(0) : 読み込みサイズの上限値

notemax

notesave

"filename" : 書き込みファイル名

notesel

p1=変数 : バッファを割り当てた変数名

notesize

noteunsel

p1 : ファイル情報が代入される変数名
"FileName" : リクエストを行なうファイル名

"ServerName" : リクエストを行なうファイル名
p1 (0) : ポート番号
p2 (0) : ローカル接続フラグ

p1 : 変数名
p2 : インターフェース名、またはクラスID
p3(0) : 作成モード(オプション)
p4 : 参照元ポインタ(オプション)

p1 : 変数名
p2 : モジュール名
p3... : 初期化パラメーター

p1=文字列 : 追加・変更をする文字列または変数名
p2=0～(-1) : 追加するインデックス
p3=0～1(0) : 上書きモード指定(0=追加・1=上書き)

p1=変数 : 読み出し先の変数名
p2=0～(0) : 読み出すインデックス

"filename" : 読み込みファイル名
p1(0) : 読み込みサイズの上限値