URL 要求のフィルタを追加します。

引数

filters:1 つ以上の URL を表すフィルタ（文字列）。複数の URL はセミコロン（;）で区切ります。URL には，0 個以上の文字と一致するワイルドカード（*）を含めることができます。

include:フィルタに一致する URL 要求を含める場合は true，それ以外の場合は false（標準設定）。オプションの引数（ブール値）。

applyTo:（オプションの引数）フィルタが適用される要求のタイプを指定します。

• Xhr:XHR 要求のみをフィルタリングします。

• NonXhr:XHR 以外の要求のみをフィルタリングします。

• All:すべての要求をフィルタリングします（標準設定）。

戻り値（void）

undefined

例:

この API 呼び出しを追加した時点から，フィルタの削除を呼び出すか反復が終了するまで，TruClient は URL に http://www.myco.com/ 接頭辞が含まれていない要求の応答を待機しません。

先頭に戻る

すべての URL 要求フィルタを削除します。

引数

なし

戻り値（void）

undefined

例

なし

先頭に戻る

URL 要求のログ記録を開始します。

引数

なし

戻り値（void）

undefined

例

なし

先頭に戻る

URL 要求のログ記録を停止します。

引数

なし

戻り値（void）

undefined

例

なし

先頭に戻る

指定したパラメータをファイルの次の値に進めます。パラメータのタイプは，ファイルまたは固有番号である必要があります。これは，VuGen で設定された引数タイプです。

引数

name:進めるパラメータの名前（文字列）。

戻り値（void）

undefined

例

先頭に戻る

IP スプーフィングが有効に設定され，スクリプトが Controller の負荷モードで実行されている場合に，IP アドレスを返します。

引数

なし

戻り値（文字列）

IP スプーフィングが有効に設定され，スクリプトが Controller の負荷モードで実行されている場合に，IP アドレスを返します。

例

なし

先頭に戻る

文字列をパラメータに保存し，パラメータが存在しない場合はメモリ内に一時的なパラメータ値を作成します（次回の実行で読み取り可能なパラメータは作成されません）。

引数

name:値の保存先となるパラメータの名前（文字列）。

value:パラメータ値（文字列）。

戻り値（void）

undefined

例

TC.setParam("myparam", "paramVal");

先頭に戻る

仮想ユーザ・スクリプトで，別の仮想ユーザ・スクリプトで終了するトランザクションを開始します。

引数

name:トランザクションの名前（文字列）。

identifier:トランザクションの識別子（文字列）。同じ値が 「TC.crossTransactionEnd(name, identifier, type)」 によってトランザクションを識別するために使用されます。

戻り値（void）

undefined

例

なし

先頭に戻る

TC.log の Standard ログ・レベルと同じですが，メッセージが Controller の［出力］ウィンドウに通知として表示されます。

引数

text:メッセージ・テキスト（文字列）。

戻り値（void）

undefined

例

先頭に戻る

仮想ユーザ・スクリプトで，別の仮想ユーザ・スクリプトで開始したトランザクションを終了します。

引数

name:トランザクションの名前（文字列）。

identifier:トランザクションの識別子（文字列）。このパラメータの値は，トランザクションを開始する仮想ユーザが 「TC.crossTransactionStart(name, identifier)」 で使用した識別子パラメータの値と同じである必要があります。

type:次のいずれか:「Pass」，「Fail」，「Auto」，「Abort」，「Stop」。

戻り値（void）

undefined

例

なし

先頭に戻る

特定のトランザクションの実行時間 (秒) を返します。

引数

name:トランザクションの名前（文字列）。

戻り値（文字列）

特定のトランザクションの実行時間 (秒) を返します。

例

なし

先頭に戻る

指定したパラメータの値を返します。

引数

name:パラメータ名（文字列）。

戻り値（文字列）

指定したパラメータの値を返します。

例

先頭に戻る

C-functions.c ファイルで定義された C 言語の特定の関数を実行します。

引数

funcname:関数名（文字列）。

functimeout:ステップによって呼び出される関数の予想される最大実行時間（秒）（数値）。

戻り値（void）

undefined

例

先頭に戻る

メッセージを Virtual User Generator の対話式/負荷ログ内の 1 行として記録します。

引数

text:メッセージ（文字列）。

level:オプションの引数。次のいずれかになります。

• 「Error」
• 「Warning」
• 「Standard」（標準設定）
• 「Extended」
• 「Status」: Controller のステータス領域に文字列を送ります。仮想ユーザ・ログにも文字列を送ります。VuGen から実行すると，メッセージが output.txt に送信されます。
• 「Status_msg」

戻り値（void）

undefined

例

先頭に戻る

マスクを解除したテキストを返します。

引数

text:マスクされたテキスト（文字列）。

戻り値（文字列）

マスクを解除したテキストを返します。

例

先頭に戻る

分析に使用するユーザ定義データ・ポイントを記録します。

引数

name:データ・ポイントの名前（文字列）。データ・ポイント名の先頭を次の文字列にしないでください。HTTP，NON_HTTP，RETRY，mic_，stream_，mms_

value:数値（数値）。

戻り値（void）

undefined

例

先頭に戻る

引数内の XPath によって定義されるオブジェクトの配列を返します。

引数

xpath:xpath クエリ（文字列）。

戻り値（void）

undefined

例

先頭に戻る

LoadRunner トランザクションを開始します。

引数

name:（文字列）開始するトランザクションの名前。

戻り値（void）

undefined

例

先頭に戻る

LoadRunner トランザクションを終了します。

引数

name:終了するトランザクションの名前（文字列）。

status:次のいずれかの値:「Pass」，「Fail」，「Auto」

status に渡される値が「Auto」の場合，status の実際の値が自動的に割り当てられます。標準設定では，この値は「Pass」で，トランザクションが成功したことを示します。ただし，TC.endTransaction より前に，「TC.setTransactionStatus(status)」 または 「TC.setTransactionStatusByName(status, name)」 を使用して標準設定値を変更した場合，またはシステムがスクリプト実行時にエラーを検出した場合は（この場合，システムは実行中のすべてのトランザクション・ステータスを「Fail」に設定します），その値が TC.endTransaction のstatus として渡されます。

戻り値（void）

undefined

例

先頭に戻る

実行中のトランザクションの標準設定の終了ステータスを設定します。

引数

status:次のトランザクション・ステータス値のいずれか:「Pass」，「Fail」。「Auto」ステータスは適用されません。

TC.setTransactionStatus 関数は，「TC.endTransaction(name, status)」 ステートメントで「Auto」が設定されている現在実行中のトランザクションの標準設定の終了ステータスを設定します。

「Auto」ステータスを変更する複数の関数を呼び出す場合，ステータスを実質的に変更するのは，TC.endTransaction の前にある最後の呼び出しです。

戻り値（void）

undefined

例

TC.setTransactionStatus("Fail")

先頭に戻る

トランザクションの名前を指定して，実行中の 1 つのトランザクションの標準設定の終了ステータスを設定します。

引数

status:次のトランザクション・ステータス値のいずれか:「Pass」，「Fail」。「Auto」ステータスは適用されません。

name:ステータスを設定するトランザクションの名前。

TC.setTransactionStatusByName 関数は，定義した名前を持つトランザクションの標準設定の終了ステータスを設定します。このトランザクションの 「TC.endTransaction(name, status)」ステートメントで「Auto」が設定されている必要があります。

「Auto」ステータスを変更する複数の関数を呼び出す場合，ステータスを実質的に変更するのは，TC.endTransaction の前にある最後の呼び出しです。

戻り値（void）

undefined

例

TC.setTransactionStatusByName("Fail", "T1")

先頭に戻る

特定のスクリプトを処理している仮想ユーザを示します。

引数

text: 任意のテキスト文字列（文字列）。

戻り値（void）

undefined。

例

先頭に戻る

スクリプトの再生中にログ・レベルを変更できます。初期のログ・レベル設定に戻すには，TC.restoreLogLevel を使用します。

引数

level:ログ・レベルを指定します。

• "Disabled":ログ・レベルを無効にします。エラー・レベルを含め，ログがキャプチャされます。
• "Standard":標準ログがキャプチャされます。
• "Extended":拡張ログ・ファイルがキャプチャされます。

log_flags:（オブジェクト）ログ・レベルが拡張に設定されている場合，json_object のプロパティとして Boolean（true/false）フラグを使用して，キャプチャするデータを指定できます。

省略されている任意のフラグは，「false」と見なされます。

• log_http
• log_AUT
• log_parameters

戻り値（void）

undefined

例

• ログ・レベルを無効にする:

  TC.setLogLevel(“Set the log level to “Disabled”);

• 標準ログを有効にする:

  TC.setLogLevel(“Standard”);

• 拡張ログを有効にする:

  TC.setLogLevel(“Extended”);

• 拡張ログを有効にし，キャプチャするログを指定する:

  TC.setLogLevel(“Extended”,{ log_http : true, log_AUT: true, log_parameters: true});

先頭に戻る

ログ・レベルを初期設定に戻します。

引数

なし

戻り値（void）

undefined

例

先頭に戻る

スクリプトでプロキシ・アドレスを手動で設定できます。

引数

option:使用するプロキシのタイプを指定します。

• "PROXY_NONE":プロキシなし
• "PROXY_SYSTEM":システム・プロキシを使用します。settings 文字列は無視されます。
• "PROXY_MANUAL":プロキシを手動で設定します。
• "PROXY_PAC":プロキシ自動設定（PAC）ファイルを使用します。

settings:プロキシ設定の詳細（文字列）。

戻り値（void）

undefined

例

• システム・プロキシ設定を使用:2 番目の引数は無視されるため，任意の文字列値でかまわず，通常空です。

  注:スキーマには 2 つの引数が必要なため，2 番目のスキーマは省略できません。

  TC.setProxy("PROXY_SYSTEM", "");

• 手動でプロキシを設定し，異なるプロトコル（http & https）に別のプロキシを設定します。

  TC.setProxy("PROXY_MANUAL", '{"proxyShare":false,"proxyHttp":" proxy.xxx.com ","proxyHttpPort":8080,"proxySsl":" proxy.yyy.com ","proxySslPort":8080}');

• 手動でプロキシを設定し，すべてのプロトコル（http，https，...）に対してプロキシ設定を共有します。

  注:“proxySsl” にもアドレスを指定する場合，“proxyShare” が true に設定されているため，その指定は無視されます。

  TC.setProxy("PROXY_MANUAL", '{"proxyShare":true,"proxyHttp":"proxy.xxx.com","proxyHttpPort":8080}');

• メモリ内にすでにある手動で設定したプロキシを使用します（以前に設定されているか，何も設定されていないかもしれません）。

  注:メモリ内にどの設定があるか不確かな場合は，毎回使用するプロキシ設定を明示的に指定することをお勧めします。

  TC.setProxy("PROXY_MANUAL ", "");

• プロキシを使用しません。

  注:option セクションで設定されているプロキシ・アドレス/ポートは削除されません。メモリ内の設定は，別の呼び出しでアクティブ化できます（次の例を参照）。

  TC.setProxy("PROXY_NONE", "");

• PAC を使用します。

  TC.setProxy("PROXY_PAC",'{"proxyPAC":"http://autocache.xyzcorp.net/"}')

先頭に戻る

URL の拒否リストまたは許可リストのいずれかのリストにフィルタを追加します。各 HTTP 要求の URL は，まず拒否リストと照合され，次に許可リストと照合されます。このチェックに合格しない HTTP 要求はブロックされます。

引数

url:URL を表す文字列または正規表現（文字列）。

isIncluded:URL を許可リストに追加する場合は true，拒否リストに追加する場合は false（ブール値）。

戻り値（void）

undefined

例

許可するドメインのみを許可リストに設定します。他のすべてのドメインはブロックされます。

文字列の例:

正規表現の例:

先頭に戻る

URL の拒否リストと許可リストの両方のリストからすべてのフィルタを削除します。

引数

なし

戻り値（void）

undefined

例

先頭に戻る

この関数呼び出しに続くすべての連続する HTTP 要求に対して HTTP ヘッダを追加します。

引数

header:追加されるヘッダの名前（文字列）。

value:追加されるヘッダの値（文字列）。

merge:「true」は同じ名前の既存のヘッダに値を結合することを示し，「false」は上書きすることを示します（ブール値）。

注:結合は，次のヘッダの変更をサポートしていません。「content-type」，「content-disposition」，「content-length」，「user-agent」，「referer」，「host」，「authorization」，「proxy-authorization」，「if-modified-since」，「if-unmodified-since」，「from」，「location」，「max-forwards」

戻り値（void）

undefined

例

先頭に戻る

すべての HTTP ヘッダを削除し，この関数の呼び出しに続くすべての連続する HTTP 要求に対する HTTP ヘッダの追加を停止します。

引数

なし

戻り値（void）

undefined

例

先頭に戻る

Utils.addAutoHeader で追加された HTTP ヘッダを削除し，この関数の呼び出しに続くすべての連続する HTTP 要求に対して，この HTTP ヘッダの追加を停止します。

引数

header:追加が停止されるヘッダの名前。

戻り値（void）

undefined

例

先頭に戻る

Utils.addAutoFilter を使用して追加されたフィルタを URL の拒否リストまたは許可リストから削除します。

引数

filter:URL を表す文字列。

isInclude:true の値は許可リストを示し，false はそれ以外を示します。

備考

リストに追加されたものとまったく同じ URL をフィルタの値として使用します。

戻り値（void）

undefined

例

先頭に戻る

仮想ユーザによって現在保存されている Cookie をすべて削除します。

引数

なし

戻り値（void）

undefined

例

なし

先頭に戻る

単一の仮想ユーザのキャッシュをクリアします。キャッシュ・シミュレータ全体の内容は影響を受けません。

引数

なし

戻り値（void）

undefined

例

なし

先頭に戻る

新しいセルをカラムの最後のフィールドとして値に追加します。

LoadRunner の同等のメソッド: lrvtc_send_message

引数

colName:カラムの名前（文字列）。

value:文字列の値（文字列）。

vtsName:VTS サーバのエイリアス（文字列，オプション）

備考

引数で指定されたカラムが存在しない場合，そのカラムが作成され，セルの内容が引数値に設定されます。

戻り値（数値）

正常に完了した場合は 0。エラーの場合は undefined を返します。

例

先頭に戻る

複数のカラム内のデータを設定します。

LoadRunner の同等のメソッド: lrvtc_send_row1

引数

colName:セミコロンで区切られたカラムの名前（文字列）。

values:セミコロンで区切られた文字列の値（文字列）。

option:値がどのように追加されるかを定義します（整数）。

• 0:最大の行数を持つカラムを基準として，すべてのカラムに同じ行として追加します。作成された行はすべてのカラムに対して n+1 行となります。
• 1:スタックとして追加 - 各カラムの最終行になります。
• 2:一意のスタックとして追加 - 値が各カラムにおいて一意である場合のみに最終行として追加されます。

vtsName:VTS サーバのエイリアス（文字列，オプション）

備考

引数で指定されたカラムが存在しない場合，それらのカラムは作成され，セルの内容が引数値に設定されます。

戻り値（数値）

正常に完了した場合は 0。エラーの場合は undefined を返します。

例

先頭に戻る

カラムに値が存在しない場合，カラムの最後のフィールドを値に設定します。

LoadRunner の同等のメソッド: lrvtc_send_if_unique

引数

colName:カラムの名前（文字列）。

value:値（文字列）。

vtsName:VTS サーバのエイリアス（文字列，オプション）

備考

引数で指定されたカラムが存在しない場合，そのカラムが作成され，セルの内容が引数値に設定されます。

戻り値（ブール値）

値がカラムに存在する場合は true，存在しない場合は false。

例

先頭に戻る

カラム内のすべてのデータをクリアします。

LoadRunner の同等のメソッド: lrvtc_clear_column

引数

colName:カラムの名前（文字列）。

vtsName:VTS サーバのエイリアス（文字列，オプション）

備考

引数で指定されたカラムが存在しない場合，ステップはエラーを返すことなく実行され，VTS のデータはまったく変更されません。

戻り値（数値）

正常に完了した場合は 0。エラーの場合は undefined を返します。

例

先頭に戻る

フィールドのデータをクリアします。

LoadRunner の同等のメソッド: lrvtc_clear_message

引数

colName:カラムの名前（文字列）。

rowIndex:フィールドのインデックス番号（整数）。1 はカラムの 1 番目のフィールドです。

vtsName:VTS サーバのエイリアス（文字列，オプション）

備考

引数で指定されたカラムまたは行インデックスが存在しない場合，ステップはエラーを返すことなく実行され，VTS のデータはまったく変更されません。

戻り値（数値）

正常に完了した場合は 0。エラーの場合は undefined を返します。

例

先頭に戻る

行内のすべてのフィールドから値をクリアします。

LoadRunner の同等のメソッド: lrvtc_clear_row

引数

rowIndex:フィールドのインデックス番号（整数）。1 はカラムの 1 番目のフィールドです。

VtsName:VTS サーバのエイリアス（文字列，オプション）

備考

引数で指定された行インデックスが存在しない場合，ステップはエラーを返すことなく実行され，VTS のデータは変更されません。

戻り値（数値）

正常に完了した場合は 0。エラーの場合は undefined を返します。

例

先頭に戻る

カラムにデータを含むフィールドの数を返します。

LoadRunner の同等のメソッド: lrvtc_column_size

引数

colName:カラムの名前（文字列）。

vtsName:VTS サーバのエイリアス（文字列，オプション）

戻り値（数値）

カラム内のフィールドの数を返します。カラムが存在しない場合は 0 を返します。

例

先頭に戻る

サーバへの接続を作成します (HTTP をサポート)。

LoadRunner の同等のメソッド: lrvtc_connect

引数

serverName:IP またはサーバ名のいずれか（文字列）。

port:ポート番号（整数）。

vtsName:VTS サーバのエイリアス（文字列，オプション）

戻り値（数値）

正常に完了した場合は 0。エラーの場合は undefined を返します。

例

先頭に戻る

サーバへの接続を作成します（HTTP，HTTPS バージョンの VTS サーバ，ユーザが入力したユーザ名とパスワードに基づく基本認証，および NTLM 認証をサポートします）。

LoadRunnerの同等のメソッド: lrvtc_connect_ex

引数

serverName:IP またはサーバ・ドメイン名のいずれか（文字列）。プロトコルは省略できます。標準設定のプロトコルは「https://」です。

port:ポート番号（整数）。利用可能な範囲は 1 ～ 65535 です。

userName:基本認証または NTLM 認証のユーザ名（文字列，オプション）。

password:基本認証または NTLM 認証のパスワード（文字列，オプション）。

domain:NTLM 認証のドメイン名（文字列，オプション）。

vtsName:VTS 接続の名前（文字列，オプション）。

戻り値（数値）

正常に完了した場合は 0。エラーの場合は undefined を返します。

例

先頭に戻る

カラムを作成します。

LoadRunner の同等のメソッド: lrvtc_create_column

引数

colName:カラムの名前（文字列）。

VtsName:VTS サーバのエイリアス（文字列，オプション）

備考

同じ名前のカラムがすでに存在する場合，関数は何も実行しません。

戻り値（数値）

正常に完了した場合は 0。エラーの場合は undefined を返します。

例

先頭に戻る

サーバから切断します。

LoadRunner の同等のメソッド: lrvtc_disconnect

引数

vtsName:VTS サーバのエイリアス（文字列，オプション）

戻り値（数値）

正常に完了した場合は 0。エラーの場合は undefined を返します。

例

先頭に戻る

カラムのインデックスを削除します。

LoadRunner の同等のメソッド: lrvtc_drop_index

引数

colName:カラム名（文字列）。

vtsName:VTS サーバのエイリアス（文字列，オプション）

戻り値（数値）

正常に完了した場合は 0。エラーの場合は undefined を返します。

例

先頭に戻る

カラムのインデックスを作成します。

LoadRunner の同等のメソッド: lrvct_ensure_index

引数

colName:カラムの名前（文字列）。

vtsName:VTS サーバのエイリアス（文字列，オプション）

戻り値（数値）

正常に完了した場合は 0。エラーの場合は undefined を返します。

例

先頭に戻る

フィールドのデータを返します。

LoadRunner の同等のメソッド: lrvtc_query_column

引数

colName:カラムの名前（文字列）。

rowIndex:フィールドのインデックス番号（整数）。1 はカラムの 1 番目のフィールドです。

vtsName:VTS サーバのエイリアス（文字列，オプション）

戻り値（文字列，undefined，または null）

指定されたカラムと行にデータが存在する場合は文字列。指定されたインデックスが存在しない場合は undefined。指定されたカラムが存在しない場合は null。

例

先頭に戻る

JavaScript オブジェクトとして行のデータを返します。オブジェクトのプロパティはカラムの名前に設定されます。

LoadRunner の同等のメソッド: lrvtc_query_row

引数

rowIndex:フィールドのインデックス番号（整数）。1 はカラムの 1 番目のフィールドです。

vtsName:VTS サーバのエイリアス（文字列，オプション）

備考

引数で指定されたカラムが存在しない場合，各カラムに対して null 値が返されます。

戻り値（オブジェクト）

すべてのカラムの指定されたインデックスからフィールドを返します。指定されたインデックスにカラムの値がない場合，値は空の文字列になります。例:{col1:”larry”,col2:””}

例

先頭に戻る

フィールド内のカウンタをインクリメントします。

LoadRunner の同等のメソッド: lrvtc_increment

引数

colName:カラムの名前（文字列）。

rowIndex:フィールドのインデックス番号（整数）。1 はカラムの 1 番目のフィールドです。

value:値。

vtsName:VTS サーバのエイリアス（文字列，オプション）

備考

引数で指定されたカラムの名前が存在しない場合，そのカラムが作成され，インデックスによって参照されたセルが引数値に設定されます。

引数で指定されたインデックスがカラムのサイズを超過する場合，指定されたインデックスによってセルが作成され，そのセルの内容が引数値に設定されます。

インデックスによって参照されたカラムに文字列が含まれる場合，セルの内容が引数値で置換されます。

戻り値（数値）

正常に完了した場合は 0。エラーの場合は undefined を返します。

例

先頭に戻る

カラムの最初のフィールドをポップします。

LoadRunner の同等のメソッド: lrvtc_retrieve_message

引数

colName:カラムの名前（文字列）。

vtsName:VTS サーバのエイリアス（文字列，オプション）

戻り値（文字列または null）

カラム行の最初のインデックスの値。カラムが空か存在しない場合は null を返します。

例

先頭に戻る

JavaScript オブジェクトとして行のデータをポップします。

引数

vtsName:VTS サーバのエイリアス（文字列，オプション）

戻り値（オブジェクト）

カラムの最初のフィールドを返します。カラムが空の場合，値は null になります。例:{col1:”larry”,col2:null}

例

先頭に戻る

指定したカラムの最初のフィールドをポップします。JavaScript オブジェクトとして返されます。オブジェクトのプロパティがカラムの名前に設定されます。

LoadRunner の同等のメソッド: lrvtc_retrieve_messages1

引数

colNames:カラムの名前（文字列）。

vtsName:VTS サーバのエイリアス（文字列，オプション）

戻り値（オブジェクト）

指定したカラムの最初のフィールドを返します。カラムが空の場合，値は null になります。例:{col1:”larry”,col2:null}

例

先頭に戻る

指定されたカラムの最初のフィールドを取得し，値を一番下に移動します。

LoadRunner の同等のメソッド: lrvtc_rotate_messages

引数

colName:カラムの名前（文字列）。

option:値を回転する方法を定義します（整数）。

• 1:スタックとして追加 - カラムからデータを取得し，各カラムの最後の有効な行の下に移動します。

• 2:一意のスタックとして追加 - カラムからデータを取得し，データが一意である場合は，それを最後の有効な行の下に移動します。

vtsName:VTS サーバのエイリアス（文字列，オプション）

備考

カラムの名前が存在しない場合，null 値が取得されます。

戻り値（オブジェクト）

指定したカラムの最初のフィールドを返します。カラムが空の場合，値は空の文字列になります。例:{col1:”larry”,col2:””}

例

先頭に戻る

すべてのカラムから最初のフィールドを取得し，値を最後に移動します。

LoadRunner の同等のメソッド: lrvtc_rotate_row

引数

option:値を回転する方法を定義します（整数）。

• 0:同じ行 - すべてのカラムからデータを取得し，行数が最も多いカラムを基準にし，すべてのカラムの下部にデータを移動します。作成された行はすべてのカラムに対して n+1 行となります。
• 1:スタックとして追加 - すべてのカラムからデータを取得し，各カラムの最後の有効な行の下に移動します。
• 2:一意のスタックとして追加 - すべてのカラムからデータを取得し，データが一意である場合にのみ，各カラムの最後の有効な行の下に移動します。

vtsName:VTS サーバのエイリアス（文字列，オプション）

備考

行にデータがない場合は null 値が取得されます。

戻り値（オブジェクト）

カラムの最初のフィールドを返します。カラムが空の場合，値は空の文字列になります。例:{col1:”larry”,col2:””}

例

先頭に戻る

指定されたカラムの最初のフィールドを取得し，値を一番下に移動します。

LoadRunner の同等のメソッド: lrvtc_rotate_messages1

引数

ColNames:セミコロンで区切られたカラムの名前（文字列）。

option:値を回転する方法を定義します（整数）。

• 0:同じ行 - すべてのカラムからデータを取得し，行数が最も多いカラムを基準にし，すべてのカラムの下部にデータを移動します。作成された行はすべてのカラムに対して n+1 行となります。

• 1:スタックとして追加 - すべてのカラムからデータを取得し，各カラムの最後の有効な行の下に移動します。

• 2:一意のスタックとして追加 - すべてのカラムからデータを取得し，データが一意である場合に各カラムの最後の有効な行の下に移動します。

vtsName:VTS サーバのエイリアス（文字列，オプション）

備考

カラムの名前が存在しない場合，null 値が取得されます。

戻り値（オブジェクト）

指定したカラムの最初のフィールドを返します。カラムが空の場合，値は空の文字列になります。例:{col1:”larry”,col2:””}

例

先頭に戻る

特定のカラムで，特定の値を含む行を検索します。

LoadRunnerの同等のメソッド: lrvtc_search_row

引数

columns:検索対象のカラムの名前（文字列）。複数のカラム名は区切り文字で区切られます。

values:カラムから検索する値。複数の値は区切り文字で区切られます。

delimiter:リスト内のカラムの名前と値を区切る文字。単一の文字ではなく文字列が delimiter に渡される場合，その文字列全体が区切り文字になります。

VtsName:VTS サーバのエイリアス。

備考

引数で指定されたカラムが存在しない場合，戻り値は 0 です。複数の行が条件を満たす場合，ランダムな 1 行のデータのみが返されます。

戻り値（数値）

0:API 呼び出しは成功したが行が見つからなかった場合。

1:API 呼び出しが成功し，行が見つかった場合。

呼び出しが失敗すると，エラー・コードが返されます。

例

TC.vtcSearchRow("col1,col2", "a,b", ",", "test");

先頭に戻る

複数のカラム内の特定の値を新しい値に置き換えます。

LoadRunner の同等のメソッド: lrvtc_update_all_message_ifequals

引数

ColNames:セミコロンで区切られたカラムの名前（文字列）。

Message:複数のカラム内の新しい値（文字列）。

Ifmessage:複数のカラム内の元の値（文字列）。

Delimiter:カラムの名前を区切る区切り文字。標準設定では，区切り文字の値はセミコロン（;）です。

戻り値（数値）

正常に完了した場合は 0。エラーの場合は undefined を返します。

例

先頭に戻る

フィールド内のデータを置換します。

LoadRunner の同等のメソッド: lrvtc_update_message

引数

colName:カラムの名前（文字列）。

rowIndex:フィールドのインデックス番号（整数）。1 はカラムの 1 番目のフィールドです。

value:値（文字列）。

vtsName:VTS サーバのエイリアス（文字列，オプション）

備考

カラムの名前またはインデックスが存在しない場合，インデックスによって参照されたカラムやセルが作成され，セルの内容が引数値に設定されます。

戻り値（数値）

正常に完了した場合は 0。エラーの場合は undefined を返します。

例

先頭に戻る

現在のデータが指定された値と同じ場合に，フィールド内のデータを置換します。

LoadRunner の同等のメソッド: lrvtc_update_message_ifequals

引数

colName:カラムの名前（文字列）。

rowIndex:フィールドのインデックス番号（整数）。1 はカラムの 1 番目のフィールドです。

value:置換後の値（文字列）。

comparedValue:現在のセルの内容が comparedValue と同じ場合，セルの内容が value（文字列）に置き換えられます。

vtsName:VTS サーバのエイリアス（文字列，オプション）

戻り値（ブール値）

カラム内に同じ値を持つフィールドがある場合は false，同じ値を持つフィールドがない場合は true。

例

先頭に戻る

複数のフィールドのデータを置換します。

LoadRunnerの同等のメソッド: lrvtc_update_row1

引数

ColNames:セミコロンで区切られたカラムの名前（文字列）。

rowIndex:フィールドのインデックス番号（整数）。1 はカラムの 1 番目のフィールドです。

values:セミコロンで区切られた文字列の値（文字列）。

vtsName:VTS サーバのエイリアス（文字列，オプション）

備考

カラムの名前またはインデックスが存在しない場合，インデックスによって参照されたカラムやセルが作成され，セルの内容が引数値に設定されます。

戻り値（数値）

正常に完了した場合は 0。エラーの場合は undefined を返します。

例

先頭に戻る

テストに渡されたコマンド・ライン・パラメータの値，またはテストに設定された標準設定値を返します。

引数

name:コマンド・ライン・パラメータの名前（文字列）。

コマンド・ライン・パラメータ名は通常，［VuGen］>［実行環境設定］の［追加属性］タブで，または Controller のグループ・コマンド・ライン引数でユーザによって割り当てられます。

テストが実行されると，追加の属性またはグループ・コマンド・ライン引数がコマンド・ラインのパラメータとしてテストに渡されます。テスト実行中に，この関数を使用して値にアクセスできます。

戻り値（文字列）

テストに渡されたコマンド・ライン・パラメータの値，またはテストに設定された標準設定値を返します。

例

Controller のコマンド・ライン引数 -MyServerURL http://myserver.com を取得するには，次のように呼び出します。

TC.getAttr(“MyServerURL”);

先頭に戻る

指定したフォルダを作成します。必要に応じて，パスを完成させるために必要なすべてのフォルダを作成します。

引数

path:フォルダの絶対パス（文字列）。

戻り値（void）

undefined

例

先頭に戻る

指定したフォルダまたはファイルを削除します。フォルダを指定すると，その中のサブディレクトリを含むすべてのファイルが削除されます。

引数

path:フォルダまたはファイルの絶対パス（文字列）。

戻り値（void）

undefined

例

先頭に戻る

指定したファイルのすべてのデータを返します。指定した文字セットのデータを Unicode に変換します。

引数

filename:ファイルの絶対パス（文字列）。

charset:UTF-8 ではない場合のファイルの文字セット（文字列）。

戻り値（文字列）

指定したファイルのすべてのデータ。

例

先頭に戻る

指定したファイルに文字列を書き込みます。ファイルが存在しない場合は作成されます。

引数

filename:ファイルの絶対パス（文字列）。

input:ファイルに書き込む文字列（文字列）。

append: （ブール値）

• true:文字列をファイルの最後に追加します（標準設定）。
• false:文字列でファイルを上書きします。

charset:UTF-8 ではない場合のファイルの文字セット（文字列）。

戻り値（ブール値）

常に true を返します。

例

mylog.txt ファイルの結果内容は次のとおりです。

先頭に戻る

指定した環境変数の値を返します。指定した変数が存在しない場合，空の文字列を返します。

引数

name:環境変数の名前（文字列）。

戻り値（文字列）

指定した環境変数の値。指定した変数が存在しない場合，空の文字列を返します。

例

先頭に戻る

引数のコンテキストで指定した JavaScript ファイルを評価します。

引数

filename:JavaScript ファイルの絶対パス（文字列）。

戻り値（void）

undefined

例

先頭に戻る

指定した環境変数が存在する場合は true を返し，存在しない場合は false を返します。

引数

name:環境変数の名前（文字列）。

戻り値（ブール値）

指定した環境変数が存在する場合は True，存在しない場合は False。

例

先頭に戻る

指定した名前の環境変数を指定の値に設定します。変数に値が格納されている場合は上書きされます。

引数

name:環境変数の名前（文字列）。

value:環境変数に設定する値（文字列）。

戻り値（void）

undefined

例

先頭に戻る