公開日: 09/19/2023

ストアドプロセスのメッセージ

stp<<Begin Run(<named arguments>)

説明

このストアドプロセスのバックグラウンドでの実行を開始する。このメッセージはEnd Runと併用します。ストアドプロシージャの完了を待つため、End RunはBegin Runよりいくらか後の時点で呼び出します。

戻り値

-1 = 実行に失敗

1 = 開始前

2 = 実行中

3 = キャンセル済み

10 = 正常に終了

11 = 終了(エラー)

オプションの名前付き引数

Runと同じだが、AutoOpenResultsNoAlertsは使用できない。どちらも、EndRunで使用可能

AutoResume(<filename>)

引数が指定されていない場合、ストアドプロセスの完了時にストアドプロセスの結果が自動的に開く。引用符付きのファイル名が指定されている場合、ストアドプロセスのすべての結果ではなく、指定のファイルだけが開く。

AutoResumeScript(script)

ストアドプロセスの実行後、引用符付きで指定されたスクリプトを評価する。スクリプトが1つ以上の引数を取る関数の場合、最初(かつ唯一)の引数として渡されたストアドプロセスオブジェクトを用いて、その関数は評価される。AutoResumeおよびAutoResumeScriptは両方を一緒に指定することはできない。

stp<<Delete Results(<named arguments>)

説明

このストアドプロセスの実行結果をすべて削除する。

戻り値

正常に削除できたときは1、そうでなければ0(エラーメッセージがJMPログに送られる)

オプションの名前付き引数

NoAlerts(Boolean)

1(真)の場合、ユーザに対して確認のプロンプトが表示されないまま結果が削除される

DeleteDirectory(Boolean)

1(真)の場合は、ストアドプロセスの結果を含んだディレクトリを、結果ファイル自体と共に削除します。デフォルト値は、1(真)。

stp<<Edit Param Values()

説明

パラメータ値をインタラクティブに設定できるよう、ストアドプロセスウィンドウを起動する。

戻り値

ユーザが[OK]をクリックした場合は1、[キャンセル]をクリックした場合は0を戻す。

stp<<End Run(<named arguments>)

説明

Begin Runで開始されたストアドプロセスが終了するまで、指定の時間だけ(または永久に)待機する。その間にストアドプロセスが終了すれば、結果を取得し、開く。

戻り値

-1 = 実行に失敗

1 = 開始前

2 = 実行中

3 = キャンセル済み

10 = 正常に終了

11 = 終了(エラー)

オプションの名前付き引数

AutoOpenResults(Boolean)

(オプション)ブール値。1(真)の場合、ストアドプロセスがMaxWaitで指定された時間内に終了したら、結果を自動的に開く。0(偽)の場合、結果を自動的には開かない(その場合でも、Get Resultsメッセージによって、戻されたオブジェクトを使って手動で開くことはできる)。デフォルト値は、1(真)。

MaxWait(milliseconds)

ストアドプロセスの終了を待機する最大時間(ミリ秒)を整数で指定する。MaxWaitが指定されていない場合、End Runはストアドプロセスが終了するまで永久に待機する。

NoAlerts(Boolean)

1(真)の場合、メッセージボックスではなくJMPログにエラーメッセージが送信される。デフォルト値は0(偽)。

stp<<Get Metadata Id()

説明

ストアドプロセスのメタデータIDを戻す。

戻り値

引用符付き文字列

stp<<Get Metadata Path()

説明

ストアドプロセスの完全メタデータパスを戻す。

戻り値

引用符付き文字列

Stp<<Get Name()

説明

ストアドプロセスの名前を戻す。

戻り値

引用符付き文字列

stp<<Get Param Enum Labels(name)

説明

指定のパラメータ(引用符付きのname)の列挙ラベルを取得する。

戻り値

引用符付き文字列のリスト

引数

name

どのパラメータの列挙ラベルを取得するかを、引用符付きで指定する。

stp<<Get Param Enum Values(name)

説明

パラメータに設定可能な列挙値を取得する。

戻り値

引用符付き文字列のリスト

引数

name

どのパラメータの設定可能な列挙値を取得するかを、引用符付きで指定する。

stp<<Get Param Names(<named arguments>)

説明

このストアドプロセスのパラメータ名のリストを戻す。オプションで種類が指定されている場合は、その種類のパラメータ名のリストを戻します。

戻り値

引用符付き文字列のリスト

オプションの名前付き引数

Visible(Boolean)

1(真)の場合、表示のパラメータのみを取得する。0(偽)の場合、非表示のパラメータのみを取得する。指定されていない場合、表示と非表示の両方のパラメータを取得する。

Modifiable(Boolean)

1(真)の場合、変更可能なパラメータのみを取得する。0(偽)の場合、変更不可なパラメータのみを取得する。指定されていない場合、変更可能と変更不可の両方のパラメータを取得する。

Required(Boolean)

1(真)の場合、必須パラメータのみを取得する。0(偽)の場合、必須でないパラメータのみを取得する。指定されていない場合、必須と必須でないパラメータの両方を取得する。

Expert(Boolean)

1(真)の場合、エキスパートのパラメータのみを取得する。0(偽)の場合、エキスパートでないパラメータのみを取得する。指定されていない場合、エキスパートとエキスパートでないパラメータの両方を取得する。

stp<<Get Param Value(name)

説明

指定したパラメータの現在の値を取得する。

戻り値

引用符付き文字列

必須の引数

name

値を取得するパラメータの名前。

stp<<Get Results()

説明

このストアドプロセスの実行結果をスクリプト可能なオブジェクトとして取得する。

戻り値

スクリプト可能なSAS実行結果オブジェクト

stp<<Get Status()

説明

ストアドプロセスの実行ステータスを取得する。

戻り値

-1 = 実行に失敗

1 = 開始前

2 = 実行中

3 = キャンセル済み

10 = 正常に終了

11 = 終了(エラー)

stp<<Get Status Message()

説明

ストアドプロセスの失敗に関連するメッセージがあれば、それらを取得する。

戻り値

引用符付き文字列

stp<<Reset Param Values()

説明

すべてのパラメータ値をメタデータ定義のデフォルト値にリセットする。

戻り値

なし

stp<<Run(<named arguments>)

説明

このストアドプロセスオブジェクトを前面で実行する。

戻り値

-1 = 実行に失敗

1 = 開始前

2 = 実行中

3 = キャンセル済み

10 = 正常に終了

11 = 終了(エラー)

オプションの名前付き引数

AutoOpenResults(Boolean)

1(真)の場合、ストアドプロセスの終了後、結果を自動的に開く。
0(偽)の場合、結果は自動的には開かないが、GetResultsメッセージによって戻されたオブジェクトを使って手動で開くことができる。デフォルト値は1(真)。

UserName(username)

ストアドプロセスを指定のユーザ名(引用符付きのuser name)で実行する。

Password(password)

UserNameのパスワードを引用符付きのpasswordで指定する。

AuthDomain(authDomain)

指定のログイン情報(usernamepassword)の認証ドメインを引用符付きで指定する。

ODSDest(dest)

ODSの出力先("HTML""PDF""tagsets.SASReport12"など)を示す引用符付き文字列。ストアドプロセスが生成するODSの出力先を決めるものです。これには、%STPBEGINを呼び出すストアドプロセスSASコードが必要。デフォルト値は"HTML"

GraphicsDevice(device)

ODS結果でのグラフィックの生成に使用するSASグラフィックデバイスを引用符付きで指定する。これには、%STPBEGINを呼び出すストアドプロセスSASコードが必要。デフォルト値は"GIF"

ODSStyle(style name)

結果に適用するODSスタイルを引用符付きで指定する。これには、%STPBEGINを呼び出すストアドプロセスSASコードが必要。デフォルト値はなし。

ODSStyleSheet(path)

生成されたODS結果に適用されるCSSファイルのクライアントコンピュータ上の完全パスを引用符付きのpathで指定する。これには、%STPBEGINを呼び出すストアドプロセスSASコードが必要。デフォルト値はなし。

NoAlerts(Boolean)

1(真)の場合、メッセージボックスではなくJMPログにエラーメッセージが送信される。デフォルト値は0(偽)。

stp<<Set Param Value(name, value)

説明

指定のストアドプロセスパラメータの値を指定の値に設定する。

戻り値

成功したときは1、そうでなければ0(値がパラメータの制約に違反した場合など)

引数

name

値を設定するパラメータの名前を引用符付きで指定する。

value

パラメータの設定値を引用符付きの文字列で指定する。

stp<<Set Results Directory(path)

説明

ストアドプロセスの結果の格納先とするクライアントコンピュータ上のパス(path)を引用符付きで指定する。

戻り値

引用符付き文字列

引数

path

ストアドプロセスの実行結果を格納するディレクトリの完全パスを示した引用符付き文字列。ディレクトリはすでに存在しているか、または作成可能なものでなければならない。結果のディレクトリが指定されない場合、オペレーティングシステムに適した一時的な場所に格納される。ストアドプロセスの実行後、スクリプト可能なSASの結果オブジェクトから、このディレクトリを取得できる。

より詳細な情報が必要な場合や、質問があるときは、JMPユーザーコミュニティで答えを見つけましょう (community.jmp.com).