Caché での ActiveX と .NET の使用法

Size: px

Start display at page:

Download "Caché での ActiveX と .NET の使用法"

しまなおおふさ
5 years ago
Views:

1 Caché での ActiveX と.NET の使用法 Version InterSystems Corporation 1 Memorial Drive Cambridge MA

Caché での ActiveX と.NET の使用法 Caché Version 5.1 2006-03-14 Copyright 2006 InterSystems Corporation. All rights reserved. このドキュメントは Sun Microsystems RenderX Inc. アドビシステムズおよびワールドワイドウェブコンソーシアム (www.w3c.

Ensemble 製品とロゴは InterSystems Corporation の登録商標です InterSystems という名前とロゴは InterSystems Corporation の登録商標ですこのドキュメントはインターシステムズ社 ( 住所 :One Memorial Drive, Cambridge, MA 02142)

2 Caché での ActiveX と.NET の使用法 Caché Version Copyright 2006 InterSystems Corporation. All rights reserved. このドキュメントは Sun Microsystems RenderX Inc. アドビシステムズおよびワールドワイドウェブコンソーシアム ( のツールと情報を使用して Adobe Portable Document Format (PDF) で作成およびフォーマットされました主要ドキュメント開発ツールは InterSystems が構築した Caché と Java を使用した特別目的の XML 処理アプリケーションです Caché 製品とロゴは InterSystems Corporation の登録商標です Ensemble 製品とロゴは InterSystems Corporation の登録商標です InterSystems という名前とロゴは InterSystems Corporation の登録商標ですこのドキュメントはインターシステムズ社 ( 住所 :One Memorial Drive, Cambridge, MA 02142) あるいはその子会社が所有する企業秘密および秘密情報を含んでおりインターシステムズ社の製品を稼動および維持するためにのみ提供されるこの発行物のいかなる部分も他の目的のために使用してはならないまたインターシステムズ社の書面による事前の同意がない限り本発行物をいかなる形式いかなる手段でその全てまたは一部を再発行複製開示送付検索可能なシステムへの保存あるいは人またはコンピュータ言語への翻訳はしてはならないかかるプログラムと関連ドキュメントについて書かれているインターシステムズ社の標準ライセンス契約に記載されている範囲を除きここに記載された本ドキュメントとソフトウェアプルグラムの複製使用廃棄は禁じられているインターシステムズ社はソフトウェアライセンス契約に記載されている事項以外にかかるソフトウェアプログラムに関する説明と保証をするものではないさらにかかるソフトウェアに関するあるいはかかるソフトウェアの使用から起こるいかなる損失損害に対するインターシステムズ社の責任はソフトウェアライセンス契約にある事項に制限される前述はそのコンピュータソフトウェアの使用およびそれによって起こるインターシステムズ社の責任の範囲制限に関する一般的な概略である完全な参照情報はインターシステムズ社の標準ライセンス契約に記されそのコピーは要望によって入手することができるインターシステムズ社は本ドキュメントにある誤りに対する責任を放棄するまたインターシステムズ社は独自の裁量にて事前通知なしに本ドキュメントに記載された製品および実行に対する代替と変更を行う権利を有する Caché および InterSystems Caché Caché SQL Caché ObjectScript および Caché Object はインターシステムズ社の商標ですここで使われている他の全てのブランドまたは製品名は各社および各組織の商標または登録商標ですインターシステムズ社の製品に関するサポートやご質問は以下にお問い合わせください : InterSystems ワールドワイドカスタマサポート Tel: Fax: support@intersystems.com

3 目次 1 はじめに ActiveX インタフェースの要素 ActiveX 用 Caché オブジェクトサーバ Caché ActiveX オブジェクト Visual Basic プロジェクトの構成 Caché オブジェクト / Visual Basic アプリケーションの構成部分サーバへの接続新規オブジェクトインスタンスの作成オブジェクトの保存既存のオブジェクトのオープン Visual Basic での Caché オブジェクトの使用法 Visual Basic でのコールバック機能の使用法 Visual Basic でのクエリの実行 Visual Basic でのエラートラップ Caché での ActiveX と.NET の使用法 iii

4 図一覧 ActiveX 用 Caché オブジェクトサーバ... 1 Visual Basic コードの自動継続... 7 Visual Basic でのポップアップヘルプウィンドウ... 7 iv Caché での ActiveX と.NET の使用法

5 テーブル一覧 ActiveX エラーコード Caché での ActiveX と.NET の使用法 v

7 1 はじめにここでは以下について説明します ActiveX インタフェースの要素 Visual Basic プロジェクトの構成 Caché オブジェクト / Visual Basic アプリケーションの構成部分 Caché オブジェクトは幅広いクライアントアプリケーションとの接続および ActiveX インタフェース経由の開発ツールを提供します ActiveX 用 Caché オブジェクトサーバ Caché オブジェクトには以下の主要な ActiveX コンポーネントが含まれます Caché での ActiveX と.NET の使用法 1

8 はじめに ActiveX 用 Caché オブジェクトサーバ ActiveX オートメーションサーバで Caché オブジェクトを ActiveX オブジェクトとして公開します Caché リストコントロール Visual Basic 用に書かれた ActiveX コントロールでクエリ結果の表示に役に立ちますクエリの選択のためのインタフェースと実行にはクエリパラメータを提供する必要があります Caché クエリコントロール Visual Basic 用に書かれた ActiveX コントロールでクエリを実行して結果を表示する単純なインタフェースを提供します Caché クエリコントロールは実行時に ID を返す任意のクエリを選択し任意のクエリパラメータのためのインタフェースを提供します Caché オブジェクトフォームウィザード単一 Caché クラスのプロパティにアクセスするために迅速に容易で簡単なフォームを作成できる Visual Basic アドインです 2 Caché での ActiveX と.NET の使用法

9 2 ActiveX インタフェースの要素 Caché ActiveX バインディングは ActiveX オブジェクトをサポートするすべてのアプリケーションからの Caché へのアクセスを提供しますこのバインディングにより Visual Basic 内の Caché オブジェクトおよびその他のクライアントのアプリケーションを開始し操作することができますまたサーバ側オブジェクトをインスタンス化するためのトランスペアレントインタフェースを提供しますバインディングには Visual Basic からのみ使用できひとまとめに Visual Caché と呼ばれる特別なツール一式も含まれます注釈 : このドキュメントの例ではすべて Visual Basic を使用しますが Visual Caché は使用しません 2.1 ActiveX 用 Caché オブジェクトサーバ ActiveX 用 Caché オブジェクトサーバは完全な ActiveX インプロセスオートメーションサーバですこれによりクライアントアプリケーションはサーバ上の Caché オブジェクトにアクセスすることができます ActiveX 用 Caché オブジェクトサーバは内部に ActiveX オブジェクトを作成します ActiveX オブジェクトは Caché サーバのオブジェクトを反映しますオブジェクトプロパティは ActiveX プロパティとして公開されます同様にメソッドは ActiveX メソッドとして公開されますメソッドが呼び出されるとサーバマシン上で実行されますすべてのクライアント側 Caché ObjInstance オブジェクトはサーバ上のオブジェクトを参照します複数のクライアント側オブジェクトが同じサーバ側オブジェクトを参照することができますクライアント側オブジェクトが接続されている限りそれぞれの参照が追加されるたびにサーバ側オブジェクトの参照数は 1 ずつ増加します SysList や ResultSet オブジェクトのような特別な機能を実行するクライアント側オブジェクトは Caché オブジェクトに基づいておらずサーバ上のオブジェクトを参照しません ActiveX から使用 Caché での ActiveX と.NET の使用法 3

10 ActiveX インタフェースの要素可能なオブジェクトのタイプに関する詳細は以下の Caché ActiveX オブジェクトを参照してくださいクライアント側 Caché オブジェクトは ActiveX オブジェクトで IDispatch インタフェース (Visual Basic でのオブジェクト ) へのポインタ用に参照されます例えば patient オブジェクトのプロパティとメソッドに Visual Basic からアクセスするには以下のコードを使用します Print patient.name 'returns the value of Name for the referenced patient object Print patient.admit 'runs the Admit() method of the patient object on the server 一般的な ActiveX オートメーションサーバの進歩に伴い Caché ActiveX 用オブジェクトサーバはクライアントオペレーティングシステムで定義するオブジェクトクラスのすべてを登録する必要がありませんその代わりに実行時にクラス情報を決定しますこれにより ActiveX レジストリエントリを維持しないで多数のクライアントマシンと多数のサーバベースのオブジェクトの大容量のアプリケーションを開発することが可能です $system.obj.exportodl(classlist,odlfile,flag,&errorlog) ルーチンを使用してオブジェクトに静的な ActiveX タイプライブラリを生成することもできます詳細は "Caché クラスリファレンス " を参照してください 2.2 Caché ActiveX オブジェクト Caché は一連の ActiveX オブジェクトを提供して Caché サーバ接続を管理しオブジェクトとの対話を可能にしますこれらのオブジェクトは CacheObject.dll 内にあり以下を含みます CacheObject.ObjInstance サーバ側 Caché オブジェクトのクライアント側の表現体ですクライアントのアプリケーションが使用する各サーバ側の Caché オブジェクトに対して 1 つの CacheObject.ObjInstance のインスタンスが存在します CacheObject.Factory ファクトリオブジェクトですアプリケーションはこのオブジェクトを使用して Caché サーバへの接続を確立し Caché オブジェクトを作成して管理しますアプリケーションには CacheObject.Factory クラスのインスタンスを 1 つだけ生成する必要があります CacheObject.SysList リスト操作オブジェクトですアプリケーションはこのオブジェクトを使用して Caché の $List 形式でデータを作成し管理します CacheObject.ResultSet クエリ処理オブジェクトですアプリケーションはこのオブジェクトを使用してクエリ (%Library.Query のインスタンスである内部クラスクエリまたは任意 SQL クエリ ) を実行しこれらのクエリの結果を処理します CacheObject.BinaryStream バイナリストリーム操作オブジェクトですアプリケーションはこのオブジェクトを使用して Caché のバイナリストリームでデータを作成し管理します 4 Caché での ActiveX と.NET の使用法

11 Caché ActiveX オブジェクト CacheObject.CharStream 文字ストリーム操作オブジェクトですアプリケーションはこのオブジェクトを使用して Caché の文字ストリームでデータを作成し管理します Caché での ActiveX と.NET の使用法 5

3 Visual Basic プロジェクトの構成参照設定なしに Visual Basic プロジェクトから Caché オブジェクトを使用することは可能ですが事前結合を使用する場合には Visual Basic プロジェクトを構成する必要があります事前結合は Visual Basic の機能でユーザがオブジェクトを宣言してそのタイプに関する情報を伝えるためのものです例えば

13 3 Visual Basic プロジェクトの構成参照設定なしに Visual Basic プロジェクトから Caché オブジェクトを使用することは可能ですが事前結合を使用する場合には Visual Basic プロジェクトを構成する必要があります事前結合は Visual Basic の機能でユーザがオブジェクトを宣言してそのタイプに関する情報を伝えるためのものです例えば事前結合では以下を指定することが可能です Dim MyList as CacheObject.SysList 事前結合はポップアップメニューを提供し文の終了に使用できる要素を表示することもできます例えば利用可能なオブジェクトタイプのリストから新規のインスタンスを関連付けることができます Visual Basic コードの自動継続事前結合は Caché 要素にポップアップ構文ウィンドウを提供します Visual Basic でのポップアップヘルプウィンドウ事前結合を使用するには以下の説明のとおりプロジェクト参照を選択します Visual Basic プロジェクト構成プロセスはプロジェクト参照の選択から構成されます新規の Visual Basic プロジェクトを作成する際には常にプロジェクト参照に cacheobject.dll を追加する必要があります以下はその方法です Caché での ActiveX と.NET の使用法 7

14 Visual Basic プロジェクトの構成 1. Visual Basic 内で [ プロジェクト ] メニューの [ 参照設定 ] を選択して参照ウィンドウを開きます 2. CacheObject の左側のチェックボックスにチェックを付けます CacheObject が利用可能な参照のリストに存在しない場合 1. [ 参照 ] ボタンをクリックします 2. <installation-root>\bin ディレクトリで cacheobject.dll を探しダブルクリックします 8 Caché での ActiveX と.NET の使用法

15 4 Caché オブジェクト / Visual Basic アプリケーションの構成部分ここでは Caché オブジェクトを操作する Visual Basic の基本的な機能について説明します以下の内容を取り上げますサーバへの接続新規オブジェクトインスタンスの作成オブジェクトの保存既存のオブジェクトのオープン Visual Basic での Caché オブジェクトの使用法 Visual Basic でのコールバック機能の使用法 Visual Basic でのクエリの実行 Visual Basic でのエラートラップ 4.1 サーバへの接続通常クライアントアプリケーションはまず CacheObject.Factory オブジェクトを作成し Caché を起動しているサーバマシンへの接続を確立します Visual Basic 内では以下のコードがこれを実行します Caché での ActiveX と.NET の使用法 9

16 Caché オブジェクト / Visual Basic アプリケーションの構成部分 'Visual Basic Code option Explicit Dim factory As CacheObject.Factory Private Sub Form_Load() ' Create instance of factory object ' You must use "Set" to assign an object value Set factory = CreateObject("CacheObject.Factory") ' Establish connection to server if one doesn't exist If Not factory.isconnected() Then Dim connectstring As String ' You can explicitly specify the connection string: connectstring = "cn_iptcp: [1972]:user" ' Alternately, you can pop up a connection dialog ' This method returns the connection string. connectstring = factory.connectdlg() Dim success As Boolean success = factory.connect(connectstring) End If End Sub まず Visual Basic の CreateObject 関数を呼び出して CacheObject.Factory オブジェクトのインスタンスを生成します Set factory = CreateObject("CacheObject.Factory") CreateObject が cacheobject.dll (CacheObject.Factory オブジェクトの実装を含みます ) を見つけることができない場合やロードできない場合は失敗します上記のコードにもあるとおり factory.isconnected を使用して接続が確立されているかどうかを調べるためにオプションで CacheObject.Factory オブジェクトをテストすることができますこのメソッドは接続が存在する場合真を返します次に CacheObject.Factory オブジェクトの Connect メソッドを使用してサーバへの接続を確立します success = factory.connect(connectstring) Connect に接続プロトコル IP アドレスか完全修飾されたドメイン名 (FQDN) とポート番号およびコロン (:) で区切られたネームスペースからなる接続文字列を渡します接続プロトコルは常に cn_iptcp で TCP/IP プロトコルを示します IP アドレスとポートはともに特定の Caché サーバを一意に指定しますポート番号は IP アドレスか FQDN の直後に続く角括弧 ( [ と ] ) で囲んで指定しますネームスペースは Caché オブジェクトを含むネームスペースを指定しますネームスペースを省略するとアプリケーションは既定のネームスペースに接続しますユーザは直接 Connect メソッドに接続文字列を渡すことができますまたエンドユーザが接続情報を接続ダイアログボックスで指定できるようにすることも可能ですこのダイアログは CacheObject.Factory オブジェクトの ConnectDlg メソッドが実行されているときはいつでも表示されますエンドユーザが接続情報を指定し [OK] をクリックすると ConnectDlg メソッドは生じた接続文字列を返しますその文字列は接続を作成するために Connect に渡されます 10 Caché での ActiveX と.NET の使用法

17 新規オブジェクトインスタンスの作成 Connect はサーバに正常に接続した場合は真を失敗した場合は偽を返します 4.2 新規オブジェクトインスタンスの作成 CacheObject.Factory オブジェクトの New メソッドを使用して Caché オブジェクトの新規インスタンスを生成することが可能です Dim Patient As Object Set Patient = factory.new("patient") New の引数はインスタンス生成のための Caché のクラス名です New は以下の処理を実行します指定されたオブジェクトの新規インスタンスをサーバ上に作成しますこの場合サーバ側で以下を呼び出すのと同じです Set object = ##class(patient).%new() ActiveX 用 Caché オブジェクトサーバにこのサーバ側オブジェクトの OREF 値を返しますサーバ側オブジェクトに接続しているクライアントにある ActiveX オブジェクトの新規インスタンスを生成しますこの ActiveX オブジェクトにハンドル (LPDISPATCH) を返します指定されたオブジェクトを New で作成できない場合はエラーが発生します ("Visual Basic でのエラートラップ " を参照してください ) 4.3 オブジェクトの保存永続オブジェクトのインスタンスをその %Save メソッド (Visual Basic では sys_save と呼ばれます ) を使用して保存できます sys_save は Caché オブジェクトのメソッドであり CacheObject.Factory オブジェクトのメソッドではないことに注意してください Dim status As String patient.sys_save patient.sys_close Set patient = Nothing また使用の際にオブジェクト上の sys_close を呼び出す必要があることに注意してくださいこれはサーバ上のオブジェクトをクローズしますまた Patient を Nothing に設定して Visual Basic のオブジェクトをクローズします sys_save と sys_close への呼び出しの後に括弧がないことにも注意してくださいこれは Visual Basic では呼び出しの後に空の括弧が続く場合その結果を使用する必要があるためです呼び Caché での ActiveX と.NET の使用法 11

18 Caché オブジェクト / Visual Basic アプリケーションの構成部分出しの返り値を無視するには ( または返り値がない場合には ) 上記の呼び出しのように括弧を省略します 4.4 既存のオブジェクトのオープン CacheObject.Factory オブジェクトの OpenId メソッドを使用してデータベースから既存の Caché オブジェクトをロードできます Dim Patient As Object Set Patient = factory.openid("myapp.patient", id) OpenId は 2 つの引数を取りますオープンする Caché クラスの名前およびオブジェクトがデータベースに格納される ID 値です ID 値は文字列として処理されます OpenId では以下を実行しますサーバのメモリに指定されたオブジェクトをロードしますこの場合サーバ側で以下を呼び出すのと同じです Set object = ##class(myapp.patient).%openid(id) ActiveX クライアントのメモリ内サーバ側オブジェクトに対する OREF 値を返しますサーバ側オブジェクトに接続しているクライアントにある ActiveX オブジェクトの新規インスタンスを生成しますハンドルをこの ActiveX オブジェクトへ返します指定されたオブジェクトを OpenId メソッドでオープンできない場合はエラーが発生します (" Visual Basic でのエラートラップ " を参照してください ) 注釈 : クライアント側の Open メソッドもあり完全な OID 値 (%Persistent クラスの %Open メソッドに類似 ) を使用してオブジェクトをオープンします 4.5 Visual Basic での Caché オブジェクトの使用法 CacheObject.Factory オブジェクトの New または OpenId メソッドを呼び出して Caché オブジェクトのインスタンスを生成すると別の Visual Basic オブジェクトを使用するのと同様にそのオブジェクトを使用することができます例えばプロパティの値を取得して設定します Dim name As String name = patient.name patient.name = name 12 Caché での ActiveX と.NET の使用法

19 オブジェクト上でメソッドを呼び出すことができます ( メソッドがサーバ上で実行されることに注意してください ) patient.admit() Visual Basic と Caché ObjectScript ではオブジェクトの使用法が少し異なります Caché で % で始まるメソッドは Visual Basic では sys_ で始まりますしたがって ObjectScript の %Save メソッドは Visual Basic では sys_save メソッドですまた Visual Basic オブジェクトの既定のプロパティに依存しないようにします例えば以下を patient.name = txtname.text 以下の代わりに使用します patient.name = txtname ' Don't use default property syntax Visual Basic でのコールバック機能の使用法 4.6 Visual Basic でのコールバック機能の使用法 ActiveX 用 Caché オブジェクトサーバはファクトリクラスの SetOutput メソッド経由でコールバック機能をサポートしますこのメソッドによりシステム出力をユーザのクライアントアプリケーションに向けることができます例えば以下のようになります Set factory = CreateObject("CacheObject.Factory") factory.setoutput(text1) ' System output now goes to textbox Text1 出力機能を無効にするには空の文字列で SetOutput を呼び出します factory.setoutput("") 4.7 Visual Basic でのクエリの実行 Caché はクエリを実行する強力なインタフェースを提供しますこのインタフェースは ResultSet オブジェクトを使用して ActiveX からアクセスできます ResultSet オブジェクトは ActiveX にのみ存在し Caché 内で他に関連するオブジェクトはありません各 ResultSet オブジェクトは特定の Caché クラスで定義された特定のクエリに結びついています例えば Person クラスではクエリ ByName を実行します Caché での ActiveX と.NET の使用法 13

20 Caché オブジェクト / Visual Basic アプリケーションの構成部分 Dim rset As CacheObject.ResultSet Dim columns As Integer Dim counter As Integer Set rset = factory.resultset("person","byname") 'Find out how many columns will be in the data columns = rset.getcolumncount() 'Now run the ByName query. 'This query will return all people 'whose names begin with the letter specified rset.execute("a") 'Cycle through the returned rows and access the data While rset.next() For counter = 1 To columns Print rset.getdata(counter) Next counter Wend 'Close the result set rset.close() この例を使用するとクラス Person で定義したクエリ ByName を実行できますこのクエリは指定した文字 ( A ) で始まる名前を持つ全員のオブジェクトを返しますクエリを実行した後 rset ResultSet オブジェクトの Next メソッドを呼び出すことで 1 つの行から次の行へ移動できます ResultSet GetColumnCount を使用してデータの各行にある列数を割り出し上記の For ループを使用して現在の行の各列に格納された値を出力します While ループで 1 つの行から次の行へ移動しますそれらをまとめてクエリによって返されたすべてのデータを出力できますすべてのデータが処理されると Close で ResultSet オブジェクトをクローズできます 4.8 Visual Basic でのエラートラップ CacheObject.Factory オブジェクトはエラーの条件に遭遇すると Visual Basic エラーを発生します Visual Basic の err オブジェクトを使用してエラーに関する情報を取得できます例えば以下のようになります Private Sub OpenObject(id As String) ' Set up error handler On Error GoTo errortrap: ' try to open non-existent object Dim Patient As Object Set Patient = factory.openid("patient", id) '... Exit Sub errortrap: ' handle error (show error string in dialog box) MsgBox (Err.Description) End Sub 14 Caché での ActiveX と.NET の使用法

21 交互に CacheObject.Factory クラスの GetErrorText メソッドを使用できますこのメソッドは生成された err オブジェクトの説明プロパティを取得し生成されたエラーのテキストを返します例えば以下のようになります ' Caché was unable to save your class MyClass. ' The returned error is encapsulated by the err object msg = factory.geterrortext(err.description) ' msg now contains the string ' "Unable to save class: MyClass" Caché ActiveX バインディングは以下のエラーコードのうちのいずれかを返す場合があります ActiveX エラーコード Visual Basic でのエラートラップエラーコード意味オブジェクト作成の試行中にエラーが発生しました指定したネームスペースとサーバにクラスが存在することを確認します Caché システム上でエラーが発生しました返りタイプ %Status を持つメソッドでエラーが発生したため状態コードが偽を返します "Caché エラーリファレンス " で内部メッセージのリストを参照してください Caché での ActiveX と.NET の使用法 15

Caché SQL に関するよくある質問

Caché SQL に関するよくある質問 Version 5.1 2006-03-14 InterSystems Corporation 1 Memorial Drive Cambridge MA 02142 www.intersystems.com Caché SQL に関するよくある質問 Caché Version 5.1 2006-03-14 Copyright 2006 InterSystems