AcReqGenerateReport
レポート実行ファイル(.ROX)かパラメタ値ファイル(.ROV)からレポート
(.ROI)を生成します。
構文 構文 構文 構文
Basic:Function AcReqGenerateReport( filename As String, options As Long, fileNumber As Long ) As Long
C/C++: long AcReqGenerateReport( LPCSTR filename, long options, long fileNumber)
filename
レポートを生成するために使用する .ROX か .ROV ファイルの名前です。ファイ ルが現在のディレクトリにない場合は、フルパス名を指定します。
ファイルがサーバの上に位置する場合は、次の書式を使用します。
rotp:[//<server>]/<path>/<filename>[;<version>]
サーバファイル名の指定方法についての詳細は、 2 章 「リクエスタAPIユーザガ イド」の「レポートサーバファイル名の指定―リクエスタAPI」を参照してくだ さい。
options
エンドユーザデスクトップアプリケーションの起動方法を指定するために使用で きる定数のセットです。複数のオプションを指定するときは、プラス(+)文字 を使用して追加します。次の表に、定数をリストして説明します。
オプション オプション オプション
オプション 説明説明説明説明
AC_REQ_LAUNCH_ALWAYS レポートを生成するためにエンドユーザデ
スクトップアプリケーションの新規インス タンスを起動します。
AC_REQ_LAUNCH_ALWAYS と
AC_REQ_LOCAL はどちらか1つしか指定
できません。
AC_REQ_LOCAL デベロッパワークベンチかエンドユーザデ
スクトップの現在のインスタンス内でレ ポートを生成します。
AC_REQ_LAUNCH_ALWAYS と
AC_REQ_LOCAL はどちらか1つしか指定
できません。
AC_REQ_GENERATE レポートを生成します。
AC_REQ_VIEW 生成されたレポートを表示します。
AC_REQ_PRINT 生成されたレポートを印刷します。
AC_REQ_ASYNC このプロセスを非同期で起動します。関数
はすぐに返され、レポートはバックグラウ ンドで生成されます。
A c R e q G e n e r a t e R e p o r t
オプションの適用範囲 オプションの適用範囲 オプションの適用範囲 オプションの適用範囲
次の表に、オプションについて、レポートが生成されたのがローカルかサーバ上 か、および、レポートが起動されたのがローカルアプリケーションからかサーバ アプリケーションからかによって適用できるものを示します。
AC_REQ_HIDE レポート生成中にエンドユーザデスクトッ
プアプリケーションを表示しません。
AC_REQ_RETURN_HANDLE レポートリクエストへのハンドルを返しま
す。同期モードでレポートを生成するリク エストの場合のみに対応します。
AC_REQ_STAY_OPEN レポート生成後も、エンドユーザデスク
トップアプリケーションを開いておきます。
このオプションは、レポートがエンドユー ザデスクトップの現在のインスタンス内で 生成される場合は無視されます。
AC_REQ_SHOW_PROG_WND レポート生成中に、エンドユーザデスク
トップかデベロッパワークベンチの進行状 況を表示するウィンドウを表示します。
AC_REQ_REPLACE 最後に作成されたレポートを上書きします。
このオプションを省略すると、レポートは バージョン番号付きで作成されます。
AC_REQ_USE_HANDLE 予約されています。
オプション オプション オプション
オプション 説明説明説明説明
オプション オプションオプション
オプション ローカルレポートローカルレポートローカルレポートローカルレポート ローカルで起動 ローカルで起動ローカルで起動
ローカルで起動 サーバレポートサーバレポートサーバレポートサーバレポート ローカルで起動 ローカルで起動ローカルで起動
ローカルで起動 サーバレポートサーバレポートサーバレポートサーバレポート サーバで起動 サーバで起動 サーバで起動 サーバで起動
AC_REQ_LAUNCH_ALWAYS ○ ○(レポート表示
が必要な場合) ×
AC_REQ_LOCAL ○(Actuate Basicを
使用している場合の × ×
A c R e q G e n e r a t e R e p o r t
■ レポートの生成には、エンドユーザデスクトップアプリケーションの現在の インスタンスを使います。エンドユーザデスクトップアプリケーションが起 動されていないなら、 Actuate は新規のインスタンスを起動しようとします。た だしこれは AcReqSetEUDTPath 関数で位置が指定されている場合に限ります。
■ プロセスは同期的に起動されます。関数はレポートが生成された後に返され ます。
■ レポートがローカルである場合に限り、レポートが生成されるときにエンド ユーザデスクトップアプリケーションを表示します。
fileNumber
.ROV ファイルからレポートを生成しているときは、0(ゼロ)を指定します。
.ROX ファイルからレポートを生成しているときは、 AcReqReadFile によって返さ
れたファイル番号を指定します。
次に示すのは、 AcReqGenerateReport への引数の指定方法の例です。
AcReqGenerateReport( "detail.rov", AC_REQ_VIEW, 0 )
AcReqGenerateReport( "detail.rov", AC_REQ_PRINT+AC_REQ_HIDE, 0) AcReqGenerateReport( "detail.rox", AC_REQ_LOCAL, fileNum )
最初の呼び出しは、パラメタファイル名と、生成したレポートを表示することを 意味する定数と、パラメタファイルからレポートを生成することを意味する0
(ゼロ)を渡します。2番目の呼び出しは、エンドユーザデスクトップを表示せず に生成したレポートを印刷することを意味する2つの定数を渡すこと以外は、最 初のものと同じです。3番目の呼び出しは、実行ファイルと、デベロッパワーク ベンチかエンドユーザデスクトップの現在のインスタンス内でレポートを生成す ることを意味する定数と、 AcReqReadFileが返したファイル番号を渡します。
次の呼び出しは、保存されたファイルを使ってサーバ上でレポートを生成しま す。
rsMyRov = "rotp://" + RotpHost + RotpFolder + "/" + "mydetail" + ".rov"
requestHandle = AcReqGenerateReport(rsMyRov, AC_REQ_GENERATE, 0)
次の呼び出しは、実行ファイルと、レポート生成リクエストへハンドルを返すこ とを意味する定数、およびAcReqReadFileが返したファイル番号を渡します。リ クエストは同期的に実行されなければなりません。
requestHandle = AcReqGenerateReport(“rotp://rs/test/forecast.rox”, AC_REQ_RETURN_ HANDLE, fileNum)
A c R e q G e n e r a t e R e p o r t
説明 説明 説明 説明
AcReqGenerateReportは、.ROV か .ROX ファイル内で指定されたパラメタ値に基
づいたレポートを生成するときに使用します。この関数を使うと、ユーザのアプ リケーションにレポート生成を組み込むことができます。プログラムからレポー トを生成する能力はバッチによるレポート作成に役立ちます。
.ROV ファイルからレポートを生成するために、 Actuate は指定された.ROV ファ
イルに対応する.ROX ファイルを起動します。.ROX ファイルは、.ROV ファイル が位置するのと同じディレクトリ内で探されます。.ROX ファイルが .ROV ファ イルと同じディレクトリ内にない場合は、 「<ファイル名> .rox にアクセスでき ません。」と表示され、 .ROX ファイルを探すことができるようにファイルを開く ダイアログボックスが表示されます。
バッチモードでレポートを実行するには、プログラムで .ROX ファイルを指定す る必要があります。そうするには、新規 .ROV ファイルにパラメタ値を書き込む 前に、使用する .ROX の名前を .ROX ファイル名パラメタ−定数、 AC_REQ_ROX によって表されます − に設定します。.ROX ファイル名は表示されないパラメタ で、プログラムからしか設定できません。 このパラメタはリクエスタダイアログ ボックスには表示されません。.ROX ファイル名パラメタを設定するには、次の 例で示すように、 AcReqSetValueStringを使用します。
AcReqSetValueString( fileNum, AC_REQ_ROX, "c:¥test¥myreport.rox" )
実行したい .ROX が .ROV ファイルと同じディレクトリ内にあるときは .ROX ファイル名パラメタを設定する必要はありません。
デフォルトでは、 AcReqGenerateReportが作成する .ROI ファイルは、レポート作 成に使用した .ROX ファイルと拡張子部分以外は同じ名前ですが、
AcReqSetValueString 使うと .ROI ファイル名を変えることができます。詳細につ
いては「AcReqSetValueString」を参照してください。
詳細およびレポート生成の例については、「Visual Basicでのリクエスタ APIの使 用」を参照してください。
リターン値 リターン値 リターン値 リターン値
API関数AcReqGetErrorを使用して、非同期的に生成されたレポートのエラーを
調べます。同期的に生成されたレポートの場合は、AcReqGenerateReportからのリ