FBWFMemoryWatcher

Size: px

Start display at page:

Download "FBWFMemoryWatcher"

ゆりなかたづ
6 years ago
Views:

1 IFFBWFMEMORYWATCHER.WIN FBWF Memory Watcher Classembly Devices 用 Windows ドライバソフトウェア Help for Windows

2 目次第 1 章はじめに概要特長...3 第 2 章製品仕様基本仕様製品構成...4 第 3 章導入方法クラスライブラリの参照方法実行手順...6 第 4 章リファレンス関数一覧関数個別説明コールバック関数構造体説明戻り値一覧...17 第 5 章サンプルプログラム MemWatchCall MemWatchMsg...19 第 6 章 FBWF メモリ監視ユーティリティ使用方法コマンド設定ダイアログ...21 第 7 章重要な情報 22 2

3 第 1 章はじめに 1.1 概要 FBWF Memory Watcher は Windows 上のアプリケーションから弊社 Classembly Devices の FBWF メモリを監視する為のソフトウェアです本製品を Windows 上のアプリケーションから DLL をダイナミックリンクし API をコールすることにより監視しますまた付属のユーティリティでは FBWF の使用メモリの閾値設定や監視を GUI で行うアプリケーションです本ドキュメントは Windows 上で本製品を使用するための情報を掲載しています 1.2 特長 FBWF メモリの空き容量を監視することでシステムの安定性を確保できますあらかじめ設定しておいた FBWF メモリの空き容量を下回った場合に割り込みイベントを通知できます FBWF メモリの空き容量を GUI ユーティリティで確認することができ閾値を超えた際にバルーン表示することができます 3

4 第 2 章製品仕様 2.1 基本仕様機能 FBWF メモリ監視割り込みイベント FBWF メモリ監視ユーティリティ FBWF メモリの空き容量取得 FBWF メモリの空き容量下限超え検出 FBWF メモリ確保値表示 FBWF 使用メモリ量表示設定した閾値を超えた場合警告を画面上に表示可能 2.2 製品構成製品構成ファイル名説明最新情報ドキュメント README.HTM 最新ドキュメント掲載ファイルインストールプログラム SETUP.EXE インストール用ファイルユーティリティ IFFBWFMEMORYWA FBWF メモリ監視ユーティリティ TCHER.EXE サンプルプログラム MemWatchCall FBWF メモリ監視サンプルプログラム ( コールバック ) MemWatchMsg FBWF メモリ監視サンプルプログラム ( ウィンドウメッセージ ) DLL IFCFBWFMEMORY WATCHER IFFBWFMEMORYWA TCHER.DLL IFFBWFMEMORYWA TCHER.LIB IFCFBWFCTRL.DL L IFFBWFMEMORYWA TCHER.RESOURCE S.DLL Visual C#.NET Visual Basic.NET 用クラスライブラリソースダイナミックリンクライブラリファイルインポートライブラリファイルユーティリティ用ダイナミックリンクライブラリファイル INI FBWFCONF.INI ユーティリティ用設定ファイルヘッダファイル IFFBWFMEMORYWA Visual C++ 用ヘッダファイル TCHER.H IFFBWFMEMORYWA Visual Basic 用ヘッダファイル TCHER.BAS ヘルプ HELP.PDF ヘルプ (PDF 形式 ) Visual C#.NET,Visual Basic.NET 用サンプルプログラムはそれぞれ Viausl C#.NET 2003, Visual Basic.NET 2003 を使用して作成しています 4

5 第 3 章導入方法 3.1 クラスライブラリの参照方法本製品はクラスライブラリのソースファイルを用意しています Visual C#.NET および Visual Basic.NET をご利用の際はソースコードをビルドしてクラスライブラリを生成し参照することで DLL 関数の定義を容易にすることができます (DLL 関数の呼び出しをカスタマイズしたい場合はクラスライブラリのソースを参照してください ) 1. クラスライブラリの作成方法.NET において DLL 関数を呼び出すにはまずクラスライブラリを用意する必要があります Visual C#.NET の場合 Visual Studio を起動し下記のプロジェクトファイルを開きます < インストール先 >\interface\iffbwfmemorywatcher\samples\cs_net\ifcfbwfmemorywatcher \IFCFBWFMEMORYWATCHER.csproj このプロジェクトをビルドすると bin フォルダにクラスライブラリ IFCFBWFMEMORYWATCHER.dl l が作成されます Visual Basic.NET の場合 Visual Studio を起動し下記のプロジェクトファイルを開きます < インストール先 >\interface\ifcfbwfmemorywatcher\samples\vb_net\ifcfbwfmemorywatcher \IFCFBWFMEMORYWATCHER.vbproj このプロジェクトをビルドすると bin フォルダにクラスライブラリ IFCFBWFMEMORYWATCHER.dl l が作成されます 5

6 2. クラスライブラリの参照 Visual C#.NET, Visual Basic.NET の場合 Visual Studio のメニューのプロジェクトの参照の追加を選択してください参照ボタンをクリックして参照したいクラスライブラリ DLL を指定します例 ) < インストール先 >\interface\ifcfbwfmemorywatcher\samples\cs_net\ifcfbwfmemorywatcher \bin\release\ifcfbwfmemorywatcher.dll < インストール先 >\interface\ifcpmgr\samples\vb_net\ifcfbwfmemorywatcher\bin \Relaase\IFCFBWFMEMORYWATCHER.dll 選択されたコンポーネントに指定した DLL が表示されます OK ボタンをクリックすると設定は完了です各言語毎に下記のようにソースファイルのヘッダで InterfaceCorpDllWrap の名前空間を追加すれば DLL 関数を次章の使用例の方法で呼び出すことができるようになります Visual C#.NET の場合 using InterfaceCorpDllWrap; Visual Basic.NET の場合 Imports InterfaceCorpDllWrap 3.2 実行手順基本的な制御の手順は以下の通りです ( 記述例は C 言語です ) FBWF メモリ監視 FBWF メモリの空き容量を取得できます MwGetStatusを使用します UINT Ret; UINT Status; // FBWF メモリの空き容量の取得 Ret = MwGetStatus(&Status); FBWF メモリの空き容量が下限値を下回った際に割り込みイベントを通知することができます詳細は割り込みイベントをご参照ください 6

7 3.2.2 割り込みイベント割り込みイベント ( メッセージコールバック関数等 ) を登録した後 FBWF メモリの空き容量が下限値を下回れば割り込みイベントが通知されます割り込みイベントの登録は MwSetEvent で行いますイベント発生時にコールバック関数が呼び出される設定例を下記に示します // コールバック関数 void CALLBACK UserCallback(PVOID User) { UINT Ret; UINT Status; } // FBWF メモリの空き容量取得 Ret = MwGetStatus(&Status); // イベントごとの処理 int main(void) { UINT Ret; MW_EVENT_REQ EventReq; // イベント登録 ZeroMemory(&EventReq, sizeof(mw_event_req)); EventReq.CallBackProc = (LPMWCALLBACK)UserCallback; Ret = MwSetEvent(100, &EventReq); } 割り込みイベントの使用終了時は MwSetEvent の pevent に NULL を指定し割り込みイベントを解除してください UINT Ret; // 割り込みの解除 Ret = MwSetEvent(0, NULL); コールバック関数以外の使用方法はサンプルプログラムをご参照ください 7

8 第 4 章リファレンス 4.1 関数一覧 No 関数名機能 FBWF メモリ監視 1 MwGetStatus FBWF メモリの空き容量を取得します割り込み設定 2 MwSetEvent 割り込みイベントを登録します 8

9 4.2 関数個別説明 1. MwGetStatus 機能 FBWF メモリの空き容量を取得します書式 C 言語 UINT MwGetStatus( UINT* pstatus ); Visual Basic Declare Function MwGetStatus Lib "iffbwfmemorywatcher.dll"( _ ByRef pstatus As Long _ )As Long Visual C#.NET [DllImport("iffbwfmemorywatcher.dll")] public static extern uint MwGetStatus( out uint pstatus ); Visual Basic.NET Declare Function MwGetStatus Lib "iffbwfmemorywatcher.dll"(_ ByRef pstatus As Integer _ )As Integer パラメータ pstatus FBWF メモリの空き容量 (MB 単位 ) 格納先です戻り値本関数実行時には下記の戻り値が返ります識別子値内容 IFMW_ERROR_SUCCESS 0 正常終了 IFMW_ERROR_NULL_POINTER C h NULL ポインタ検出 IFMW_ERROR_INVALID_HANDLE C h 内部エラー IFMW_ERROR_SUCCESS 以外の値が返された場合については 4.5 戻り値一覧をご参照ください 9

10 使用例 C 言語 UINT Ret; UINT Status; Ret = MwGetStatus(&Status); Visual Basic Dim Ret As Long Dim Status As Long Ret = MwGetStatus(Status) Visual C#.NET uint Ret; uint Status; Ret = IFCFBWFMEMORYWATCHER.MwGetStatus(out Status); Visual Basic.NET Dim Ret As Integer Dim Status As Integer Ret = IFCFBWFMEMORYWATCHER.MwGetStatus(Status) 現在の FBWF メモリの空き容量を取得します 10

11 2. MwSetEvent 機能 FBWF メモリの空き容量が指定の値を下回った際の割り込みイベント ( ウィンドウメッセージコールバック関数 ) を登録 / 削除します書式 C 言語 UINT MwSetEvent( UINT PMW_EVENT_REQ ); Threshold, pevent Visual Basic 登録 Declare Function MwSetEvent Lib "iffbwfmemorywatcher.dll"( _ ByVal Threshold As Long, _ ByRef pevent As MW_EVENT_REQ _ )As Long 削除 Declare Function MwKillEvent Lib "iffbwfmemorywatcher.dll" _ Alias "MwSetEvent"( _ ByVal Threshold As Long, _ ByVal pevent As Long _ )As Long Visual C#.NET 登録 [DllImport("iffbwfmemorywatcher.dll")] public static extern uint MwSetEvent( uint Threshold, ref MW_EVENT_REQ pevent ); 削除 [DllImport("iffbwfmemorywatcher.dll")] public static extern uint MwSetEvent( uint Threshold, IntPtr pevent ); 11

12 Visual Basic.NET 登録 Declare Function MwSetEvent Lib "iffbwfmemorywatcher.dll"(_ ByVal Threshold As Integer, _ ByRef pevent As MW_EVENT_REQ _ )As Integer 削除 Declare Function MwSetEvent Lib "iffbwfmemorywatcher.dll"(_ ByVal Threshold As Integer, _ ByVal pevent As IntPtr _ )As Integer パラメータ Threshold 割り込みイベントを発生させる FBWF メモリの空き容量 (MB 単位 ) を指定します設定可能範囲は 1~1023 です現在の FBWF メモリの空き容量がこの値より大きい状態からこの値以下へ変化した際に割り込みイベントを発生させます pevent イベント登録用構造体を指定します詳細は MW_EVENT_REQ をご参照ください登録済みのイベントを削除する場合 C 言語では NULL Visual C#.NET と Visual Basic.NET では IntPtr.Zero を指定してください Visual Basic で登録済みのイベントを削除する場合は MwKillEvent 関数を使用し 0 を指定してください戻り値本関数実行時には下記の戻り値が返ります識別子値内容 IFMW_ERROR_SUCCESS 0 正常終了 IFMW_ERROR_INVALID_PARAMETER C h 入力パラメータ不正 IFMW_ERROR_ALREADY C h 既にイベント登録済み IFMW_ERROR_NOT_YET C h まだイベント登録していない IFMW_ERROR_NOT_ALLOCATE C h メモリ確保失敗 IFMW_ERROR_INVALID_HANDLE C h 内部エラー IFMW_ERROR_SUCCESS 以外の値が返された場合については 4.5 戻り値一覧をご参照ください備考 1 つのアプリケーションにつき 1 つのイベントを登録できますメッセージの WPARAM には MW_EVENT_REQ 構造体の Msg メンバで指定した値が渡されますまた LPARAM には MW_EVENT_REQ 構造体の User メンバで指定した値が渡されますコールバック関数についての詳細は 4.3 コールバック関数をご参照ください 12

13 注意コールバック関数は C 言語でのみ使用できますその他の言語ではウィンドウメッセージを使用してください使用例 C 言語 UINT Ret; MW_EVENT_REQ EventReq; EventReq.Wnd = this->m_hwnd; EventReq.Msg = WM_USER ; EventReq.CallBackProc = NULL; EventReq.User = NULL; Ret = MwSetEvent(100, &EventReq); Visual Basic Dim Ret As Long Dim EventReq As MW_EVENT_REQ EventReq.Wnd = Form1.hWnd EventReq.Msg = &H EventReq.CallBackProc = 0 EventReq.User = 0 Ret = MwSetEvent(100, EventReq) Visual C#.NET uint Ret; IFCFBWFMEMORYWATCHER.MW_EVENT_REQ EventReq = new IFCFBWFMEMORYWATCHER.MW_EVENT_REQ(); EventReq.Wnd = this.handle; EventReq.Msg = 0x ; EventReq.CallBackProc = IntPtr.Zero; EventReq.User = IntPtr.Zero; Ret = IFCFBWFMEMORYWATCHER.MwSetEvent(100, ref EventReq); Visual Basic.NET Dim Ret As Integer Dim EventReq As IFCFBWFMEMORYWATCHER.MW_EVENT_REQ _ = New IFCFBWFMEMORYWATCHER.MW_EVENT_REQ EventReq.Wnd = Me.Handle EventReq.Msg = &H EventReq.CallBackProc = IntPtr.Zero EventReq.User = IntPtr.Zero Ret = IFCFBWFMEMORYWATCHER.MwSetEvent(100, EventReq) FBWF メモリの空き容量が 100MB を下回った際に通知するウィンドウメッセージを登録します 13

14 4.3 コールバック関数コールバック関数は C 言語でのみ使用できます書式 C 言語 void CALLBACK UserCallBack( PVOID User ); パラメータ User ユーザパラメータです MW_EVENT_REQ 構造体の User メンバで指定した値が渡されます MW_EVENT_REQ をご参照ください使用例割り込みイベントをご参照ください 14

15 4.4 構造体説明 MW_EVENT_REQ 割り込みイベント登録用の構造体です C 言語 typedef struct _MW_EVENT_REQ{ HWND Wnd; UINT Msg; LPMWCALLBACK CallBackProc; PVOID User; } MW_EVENT_REQ, *PMW_EVENT_REQ; Visual Basic Type MW_EVENT_REQ Wnd As Long Msg As Long CallBackProc As Long User As Long End Type Visual C#.NET [StructLayout(LayoutKind.Sequential)] public struct MW_EVENT_REQ { putlic IntPtr public int public IFCFBWFMEMORYWATCHER.LPMWCALLBACK putlib IntPtr } Wnd; Msg; CallBackProc; User; Visual Basic.NET <StructLayout(LayoutKind.Sequential)> Structure MW_EVENT_REQ Dim Wnd As IntPtr Dim Msg As Integer Dim CallBackProc As IFCFBWFMEMORYWATCHER.LPMWCALLBACK Dim User As IntPtr End Structure 15

16 メンバ Wnd Msg CallBackProc User 説明割り込みイベント通知時に Msg メンバで指定したメッセージのポスト先ウィンドウハンドルを指定しますメッセージポストを行わない場合は C 言語では NULL Visual Basic では 0 Visual C#.NET と Visual Basic.NET では IntPtr.Zero を指定してください割り込みイベント通知時に送出するメッセージコードを指定しますここで指定したメッセージコードはメッセージの WPARAM へ渡されますメッセージポストを行わない場合は C 言語では WM_NULL Visual Basic Visual C#.NET Visual Basic.NET では 0 を指定してください割り込みイベント通知時に呼び出されるコールバック関数へのポインタを指定しますコールバック関数は C 言語でのみ使用できます Visual Basic では 0 Visual C#.NET と Visual Basic.NET では IntPtr.Zero を指定してください C 言語でコールバック関数を使用しない場合は NULL を指定してくださいコールバック関数に渡すユーザデータを指定しますここで指定したデータはメッセージの LPARAM コールバック関数の第 1 引数へ渡されます Visual Basic では 0 Visual C#.NET と Visual Basic.NET では IntPtr.Zero を指定してください 16

17 4.5 戻り値一覧エラー識別子値意味対処方法 IFMW_ERROR_SUCCESS 0 正常終了 - IFMW_ERROR_INVALID_PARAMETER C h ( ) 入力パラメータが不正設定可能範囲をご確認の上パラメータを設定してください IFMW_ERROR_ALREADY C h ( ) 既にイベントが登録されているイベントが登録されていない状態で実行してください IFMW_ERROR_NOT_YET C h ( ) まだイベントが登録されていないイベントが登録されている状態で実行してください IFMW_ERROR_NULL_POINTER C h ( ) NULL ポインタ検出引数に NULL が渡されています有効な変数を指定してください IFMW_ERROR_NOT_ALLOCATE C h メモリ確保失敗メモリの使用を抑えてください ( ) IFMW_ERROR_INVALID_HANDLE C h ( ) 内部エラー DLL 初期化時の内部エラーですアプリケーションを再起動してください 17

18 第 5 章サンプルプログラム以下各サンプルプログラムの概要を説明します 5.1 MemWatchCall 概要 MemWatchCall は割り込みイベントを発生させるサンプルプログラムです割り込みイベントを発生させる任意の FBWF メモリの空き容量を設定し下回った場合には割り込みイベント ( コールバック関数 ) が発生しますまた FBWF メモリの空き容量を 1S 周期で表示します実行手順サンプルプログラムには実行形式のファイルが付属していませんソースコードをコンパイルして実行ファイルを生成してから動作させてください Visual C++ の場合 Visual C++(Visual Studio) を起動しファイルメニューからワークスペースを開くを選びメイクファイル MemWatchCall.mak を開きビルドしてください Visual C#.NET の場合 Visual Studio を起動しファイルメニューから開くプロジェクトを選びプロジェクトファイル MemWatchCall.csproj を開きビルドしてください Visual Basic.NET の場合 Visual Studio を起動しファイルメニューから開くプロジェクトを選びプロジェクトファイル MemWatchCall.vbproj を開きビルドしてください 18

19 5.2 MemWatchMsg 概要 MemWatchMsg は割り込みイベントを発生させるサンプルプログラムです割り込みイベントを発生させる任意の FBWF メモリの空き容量を設定し下回った場合には割り込みイベント ( ウィンドウメッセージ ) が発生しますまた FBWF メモリの空き容量を 1S 周期で表示します実行手順サンプルプログラムには実行形式のファイルが付属していませんソースコードをコンパイルして実行ファイルを生成してから動作させてください Visual C++ の場合 Visual C++(Visual Studio) を起動しファイルメニューからワークスペースを開くを選びメイクファイル MemWatchMsg.mak を開きビルドしてください Visual Basic の場合 Visual Basic を起動しプロジェクトファイル MemWatchMsg.vbp を開きビルドしてください Visual C#.NET の場合 Visual Studio を起動しファイルメニューから開くプロジェクトを選びプロジェクトファイル MemWatchMsg.csproj を開きビルドしてください Visual Basic.NET の場合 Visual Studio を起動しファイルメニューから開くプロジェクトを選びプロジェクトファイル MemWatchMsg.vbproj を開きビルドしてください 19

20 第 6 章 FBWF メモリ監視ユーティリティ FBWF メモリ監視ユーティリティを使用することで下記が可能になります FBWF メモリの設定値確認 FBWF メモリ使用量の閾値設定 6.1 使用方法本ユーティリティは OS 起動時に自動的に起動しますユーティリティが起動しているかどうかはタスクトレイをご確認くださいユーティリティが起動している場合下記のアイコンが表示されます 6.2 コマンド Interface FBWF Memory Watcher のアイコンを右クリックすると下記のようなコマンドウィンドウが起動します各コマンドの内容は下記の通りですコマンド Open Exit 内容後述の設定ダイアログボックスを開き各種設定を行います Interface FBWF Memory Watcher を終了します実行するとタスクトレイからアイコンが消えます 20

6.3 設定ダイアログ Open コマンドを選択すると下記の設定ダイアログが表示されます各表示の内容は下記の通りですメイン画面表示 FBWF Memory 使用量 FBWF RAM FBWF Threshold 内容現在 FBWF で使用しているメモリ量です FBWF で使用できるメモリの総量です FBWF 使用メモリ容量の閾値ですここで指定した閾値を FBWF

21 6.3 設定ダイアログ Open コマンドを選択すると下記の設定ダイアログが表示されます各表示の内容は下記の通りですメイン画面表示 FBWF Memory 使用量 FBWF RAM FBWF Threshold 内容現在 FBWF で使用しているメモリ量です FBWF で使用できるメモリの総量です FBWF 使用メモリ容量の閾値ですここで指定した閾値を FBWF 使用メモリ容量が上回ると警告のバルーンが表示されますチェックの有無で Threshold の有無を決定します有りの状態の時 Threshold が設定できます設定範囲は MB の範囲で初期設定は 300MB に設定しています OK, キャンセルボタン OK ボタンをクリックすることで設定値を反映させることが出来ますキャンセルボタンをクリックすると設定値を反映させずにメイン画面のみ最小化します 21

22 第 7 章重要な情報保証の内容と制限弊社は本ドキュメントに含まれるソースプログラムの実行が中断しないことまたはその実行に誤りが無いことを保証していません本製品の品質や使用に起因する性能に起因するいかなるリスクも使用者が負うものとします弊社はドキュメント内の情報の正確さに万全を期しています万一誤記または誤植などがあった場合弊社は予告無く改訂する場合がありますドキュメントまたはドキュメント内の情報に起因するいかなる損害に対しても弊社は責任を負いませんドキュメント内の図や表は説明のためでありユーザ個別の応用事例により変化する場合があります著作権知的所有権弊社は本製品に含まれるおよび本製品に対する権利や知的所有権を保持しています本製品はコンピュータソフトウェア映像 / 音声 ( 例えば図文章写真など ) を含んでいます医療機器 / 器具への適用における注意弊社の製品は人命に関わるような状況下で使用される機器に用いられる事を目的として設計製造された物では有りません弊社の製品は人体の検査などに使用するに適する信頼性を確保する事を意図された部品や検査機器と共に設計された物では有りません医療機器治療器具などの本製品の適用により製品の故障ユーザ設計者の過失などにより損傷 / 損害を引き起こす場合が有ります複製の禁止弊社の許可なく本ドキュメントの全てまたは一部に関わらず複製改変などを行うことはできません責任の制限弊社は弊社または再販売者の予見の有無にかかわらず発生したいかなる特別損害偶発的損害間接的な損害重大な損害について責任を負いません本製品 ( ハードウェア, ソフトウェア ) のシステム組み込み使用ならびに本製品から得られる結果に関する一切のリスクについては本製品の使用者に帰属するものとします本製品に含まれるバグあるいは本製品の供給 ( 納期遅延 ) 性能もしくは使用に起因する付帯的損害もしくは間接的損害に対して弊社に全面的に責がある場合でも弊社はその製品に対する改良 ( 正常に動作する ) 代品交換までとし金銭面での賠償の責任は負わないものとしますので予めご了承ください本製品 ( ソフトウェアを含む ) は日本国内仕様です本製品を日本国外で使用された場合弊社は一切責任を負いかねますまた弊社は本製品に関し海外での保守サービスおよび技術サポート等は行っておりません 22

23 商標 / 登録商標本書に掲載されている会社名製品名はそれぞれ各社の商標または登録商標です 23

DPC-0401

Interface USB Driver (I/O-CD) DPC-0401 USB 拡張 I/O 用 Windows ドライバ Help for Windows www.interface.co.jp 目次第 1 章はじめに...3 1.1 概要...3 1.2 各 I/O に対応したドライバ...3 第 2 章製品仕様...4 2.1 基本仕様...4 2.2 製品構成...4 2.3 クラスライブラリの参照方法...5