v7.

20

テクニカル リファレンス

2010年 10月
法律条項
免責条項
Schneider Electric (Australia) Pty. Ltd. は、本マニュアルに関して一切の表明または保証をするものではありません。また、法律が認め
る最大限の範囲において、本マニュアルと別の文書の置き換えを暗示するような、あらゆる保証違反に対する法的責務を明示的に制
限します。さらに、Schneider Electric (Australia) Pty. Ltd. はいつでもこの広告内容を変更する権利を保持し、その変更についてはいか
なる人物にも報告する義務を負わないものとします。

著作権
© Copyright 2010 Schneider Electric (Australia) Pty. Ltd. All rights reserved.

商標
Schneider Electric (Australia) Pty. Ltd.では、本マニュアルで言及される企業名、製品、サービスに関する商標情報を提供するために、
あらゆる努力をしています。
Citect、CitectHMI、および CitectSCADA は、Schneider Electric (Australia) Pty. Ltd. の登録商標です。
IBM、IBM PC、および IBM PC AT は、International Business Machines Corporation の登録商標です。
MS-DOS、Windows、Windows NT、Microsoft、および Excel は、Microsoft Corporation の米国またはその他の国における登録商
標または商標です。
DigiBoard、PC/Xi および Com/Xi は、Digi International Inc. の商標です。
Novell、Netware および Netware Lite は、Novell, Inc. の米国またはその他の国における登録商標または商標です。
dBASEは、dataBased Intelligence, Inc の商標です。
本ド キュメント で言及されるその他のブランド または製品はすべて、各社の商標または登録商標です。

一 般 的 な注 意
本マニュアルで使用されている製品名のいくつかは、それらを特定する目的のみで使用されていますが、それぞれが該当する企業の商
標である場合があります。

CitectSCADAバージョン v7.20の2010年10月エディション
マニュアル改訂版バージョンv7.20.

今すぐ、www.Citect.com/citectscada の Schneider Electric (Australia) Pty. Ltd. へお問い合わせください

内容

法律条項 2

内容 3

安全情報 7
危 険 カテゴリと特 殊 シンボル 7
以 下 の点 に注 意 してください。 8
作 業 を始 める前 に 8

テクニカル リファレンス 11

Chapter: 1 パラメータ 13
パラメータ使 用 の規 則 13
ネット ワーク上 でのパラメータ使 用 14
パラメータ ダイアログ 15
パラメータ プロパティ 15

Chapter: 2 設 定 パラメータ 17
パラメータのシンタックス 17
パラメータ値 の設 定 18
パラメータ優 先 順 位 21
階 層 パラメータ 22
Citect.ini のコメント 23

Chapter: 3 参 照 情 報 25
仕様 25
グラフィックス 26
I/O デバイスデータ型 28
定 義 済 みAN 29

3
Contents

定 義 済 みテンプレート 30
定 義 済 みコマンド 34
定 義 済 み文 字 セット 36
定 義 済 みフォント 38
定 義 済 みデバイス 40
定 義 済 みCicodeファイル 41
定 義 済 みカラー名 とコード 42
定 義 済 みキーボード キーコード 43
定 義 済 みラベル 53
ASCII/ANSI 文 字 コード 一 覧 60
フォーマット フィールド 71
アラーム表 示 フィールド 72
アラームサマリーフィールド 75
コマンド フィールド の使 用 77
エラーメッセージ 78
プロト コル一 般 エラー 79
汎 用 ド ライバエラー 85
プロト コル固 有 エラー 88
標 準 ド ライバエラー 92

Chapter: 4 CtAPI関 数 97
I/Oポイント カウント 98
CtAPI 同 期 操 作 98
CTAP 関 数 を使 用 したデータ読 み込 み 99
I/Oタグインターフェース 100
タグ関 数 100
リスト 関 数 100
配 列 サポート 101
デジタル配 列 を読 み込 むときのビット シフト 101
CitectSCADA または CitectSCADAド ライバからのCTAPI 101
エラーコード 101
デバッグト レース 103
関 数 リファレンス 103

Chapter: 5 CSV_include リファレンス 157

CSV_include パラメータ 157
CSV_include 関 数 157

Chapter: 6 グラフィックス ビルダー オート メーション インターフェース 259

エラー処 理 260
オート メーション イベント 262
関 数 カテゴリ 262
整 列 と位 置 の関 数 263
イベント 関 数 269
PasteGenie 270
PasteSymbol 271
特殊関数 272

4
 Contents

Visible 272
動 的 なプロパティの関 数 273
PropertiesInputTouchGet 300
PropertiesInputTouchPut 301
PropertiesShowDialog 301
PropertiesSymbolSetGet 302
PropertiesSymbolSetPut 303
PropertiesSymbolSetSymbolGet 304
PropertiesSymbolSetSymbolPut 305
PropertiesTransCentreOffsetExpressGet 307
PropertiesTransCentreOffsetExpressPut 307
PropertiesTransformationGet 308
PropertiesTransformationPut 310
ライブラリオブジェクト 関 数 320
メタデータ関 数 331
その他 の関 数 337
オブジェクト の描 画 とプロパティの関 数 341
オプション関 数 391
ページ関 数 394
ページ プロパティの関 数 421
プロジェクト 関 数 441
テキスト プロパティの関 数 452

Chapter: 7 よくある質 問 (FAQ) 461

ページ 461
グラフィックス 462
ランタイム 462
ト レンド 463
コント ロール 464
アラーム 465
その他 466

用語集 469

目次 495

5
Contents

6
 安全情報

安全情報

危 険 カテゴリと特 殊 シンボル

以 下 のシンボルおよび特 別 メッセージは、潜 在 的 な危 険 の警 告 、および操 作 を明 確 または簡

単 にする場 合 の注 意 として本 マニュアルあるいは製 品 上 で表 示 される場 合 があります。
製 品 上 の「危 険 」ラベルまたは「警 告 」ラベルの稲 妻 またはANSI manシンボルは、後 述 するよ
うに、指 示 に従 わないと人 体 に傷 害 を負 う可 能 性 のある電 気 的 ハザード を示 しています。
マニュアルにある安 全 メッセージの感 嘆 符 は、身 体 の傷 害 が生 じる可 能 性 がある危 険 を示 し
ます。起 こり得 る傷 害 あるいは致 死 を回 避 するために、このシンボルで開 始 するすべての安 全
メッセージを順 守 してください。

シンボル 名前

稲妻

ANSI man

感嘆符

危 険 は、回 避 しないと、死 亡 するか、または重 傷 を負 う非 常 に危 険 な状 況 を示 しています。

警 告 は、回 避 しないと、死 亡 するか、または重 傷 を負 うる可 能 性 がある危 険 な状 況 を示 しています。

注 意 は、回 避 しないと、わずかな負 傷 または軽 傷 を負 う可 能 性 がある危 険 な状 況 を示 しています。

7
安全情報

注意
注 意 は安 全 アラーム シンボルなしで使 用 されます。これは、回 避 しないと、物 的 損 害 が発 生 する可 能 性 のあ
る危 険 況 を示 しています。

以 下 の点 に注 意 してください。

電 気 機 器 は、資 格 を持 った担 当 者 のみが、取 付 け、操 作 、修 理 、メンテナンスを行 わなけれ

ばなりません。Schneider Electric (Australia) Pty. Ltd.は、本 マニュアルの使 用 から生 じるいか
なる結 果 に対 しても一 切 責 任 を負 いません。

作 業 を始 める前 に

CitectSCADAは、Supervisory Control and Data Acquisition (SCADA、監 視 制 御 および

データ取 得 ) ソリューションです。これによって、産 業 システムとプロセスを管 理 、監 視 するソフト
ウェアの作 成 が容 易 になります。CitectSCADA は制 御 システムとプロセスにおいて中 心 的 な
役 割 を果 たすものですから、CitectSCADAプロジェクト を適 切 に設 計 、委 託 、および試 験 して
から、操 作 設 定 を行 う必 要 があります。次 の事 項 に注 意 してください:

予 期 しない機 器 の動 作

CitectSCADA あるいは他 の SCADA ソフト ウェアを PLC ベース制 御 プログラムの代 わりとして使 用 しないでくだ
さい。SCADA ソフト ウェアは直 接 の高 速 システム制 御 用 に設 計 されていません。

これらの指 示 に従 わない場 合 は、死 亡 、重 傷 、または装 置 の損 傷 を引 き起 こす可 能 性 があります。

制御不能

l 制 御 スキームの設 計 者 は、制 御 パスの障 害 の可 能 性 を考 慮 しなければなりません。また、重 要 な制

御 機 能 を確 実 にするために、パスの障 害 中 、および障 害 後 は安 全 なマルチステート になる方 法 を提 供
しなければなりません。重 要 な制 御 機 能 の例 として、非 常 停 止 およびオーバート ラベル停 止 がありま
す。
l 重 要 な制 御 機 能 には、個 別 、または冗 長 による制 御 パスが提 供 されなければなりません。
l システム制 御 パスには通 信 リンクが含 まれる場 合 もあります。予 期 しない送 信 遅 延 またはリンク障 害 か
ら引 き起 こされる結 果 について考 慮 しておく必 要 があります。*
l CitectSCADAを使 用 して作 成 した制 御 システムの実 装 ごとに、適 切 に動 作 するかどうか個 別 的 かつ徹
底 的 にテスト した後 で、サービスを開 始 する必 要 があります。
これらの指 示 に従 わない場 合 は、死 亡 、重 傷 、または装 置 の損 傷 を引 き起 こす可 能 性 があります。

8
 安全情報

* 追 加 情 報 として、NEMA ICS 1.1 (最 新 版 )、「ソリッド ステート コント ロールのアプリケーショ

ン、設 置 、および保 守 のための安 全 ガイド ライン」を参 照 してください。

9
安全情報

10
テクニカル リファレンス

このセクションでは、以 下 のテクニカル リファレンス情 報 、および

CitectSCADA 用 語 集 を記 載 します。
設 定 パラメータ
CitectSCADA 参 照 情 報
CtAPI 関 数
グラフィックス ビルダー オート メーション
用語集

11
12
Chapter: 1 パラメータ
パラメータは、それぞれの CitectSCADAコンピュータが CitectSCADA の設 定 およびランタイム
環 境 で、どのように動 作 するかを決 定 します。例 えば、Citectプロジェクト エディタのツールバー
を表 示 したり隠 したりするパラメータや、ランタイムに、プライマリおよび冗 長 レポート サーバーが
ハート ビート シグナルを受 送 信 しているかを決 定 するパラメータがあります。

予 期 しない機 器 の動 作

l Citect.ini パラメータの変 更 や削 除 を行 う前 に、このマニュアルの適 切 な資 料 を読 み、理 解 してくださ

い。
l 資 料 に記 載 されていない Citect.ini パラメータを変 更 したり、削 除 しないでください。
l Citect.ini ファイルの一 部 を削 除 する前 に、不 要 な、または資 料 に記 載 されていないパラメータは削 除
されないことを確 認 してください。
l プロジェクト を実 行 中 に設 定 ファイルを編 集 しないでください。
これらの指 示 に従 わない場 合 は、死 亡 、重 傷 、または装 置 の損 傷 を引 き起 こす可 能 性 があります。

注 ：文 書 化 されていない、必 要 な機 能 については、必 ず技 術 サポート 担 当 者 の助 言 を

要 求 してください。

操 作 パラメータを以 下 の場 所 に設 定 することができます。
l プロジェクト データベース内 。
l V7.10 からCitectSCADAは Citect.ini ファイルが、設 置 時 に選 択 されたCitectSCADAユー
ザーおよびデータフォルダのconfig フォルダにあることを予 測 します。その場 所 にファイルがな
い場 合 、他 は検 索 せず、エラーを表 示 します。他 の場 所 にINIファイルを保 存 する必 要 が
ある場 合 は、citect32.exeおよびctexplor.exeを起 動 するときに、コマンド ラインにその場 所 の
パスを指 定 する必 要 があります。詳 細 は、テキスト エディタを参 照 してください。
l プロジェクト データベースおよびcitect.iniファイルの両 方 (パラメータ優 先 順 位 を参 照 してく
ださい)。

パラメータ使 用 の規 則
パラメータの使 用 時 には、次 の規 則 を守 る必 要 があります。
l citect.iniファイルで設 定 されたパラメータは、プロジェクト データベースで設 定 されたパラ
メータより優 先 されます。

13
Chapter: 1 パラメータ

l プロジェクト データベースのパラメータを設 定 ( または変 更 ) する場 合 、パラメータ設 定 を使

用 する前 に、プロジェクト をコンパイルし直 す必 要 があります。
l ファイル パラメータには、使 用 前 にCitectSCADAを再 起 動 しておく必 要 がある
citect.ini
ものがあります。該 当 するプロセスが再 起 動 されるとただちに使 用 されるパラメータもありま
す。例 えば、アラーム サーバーのイベント パラメータは、特 定 のアラーム サーバーが再 起 動
されるとただちに使 用 されます。
l データベース内 のパラメータ セット は、特 定 のCitectSCADAプロジェクト に対 しローカルなも
のです。複 数 のCitectSCADAシステムを使 用 している場 合 、citect.iniファイルに設 定 され
たパラメータは、( 複 数 のCitectSCADAプロジェクト を使 用 している場 合 、) すべて
のCitectSCADAプロジェクト に適 用 されます。
プロジェクト データベースにパラメータを設 定 するには

1. [システム] をクリックし、[パラメータ] を選 択 します。

2. パラメータのセクション名 を入 力 します。
3. パラメータの名 前 を入 力 します。
4. パラメータの値 を入 力 します。
5. データベースにレコード を追 加 します。
citect.iniのローカル ファイルのパラメータを設 定 するには

1. ヘルプ内 でパラメータを見 つけます。

2. ボタン ( デフォルト 値 未 満 ) を使 用 して値 を編 集 します。

注 :現 在 のパラメータ値 が、ダイアログ フィールド に表 示 されます (ダイアログ フィールド に

何 も表 示 されない場 合 、パラメータはデフォルト 値 に設 定 されます)。

または
3. テキスト エディタを使 用 してcitect.iniファイルを編 集 します。
4. 次 の書 式 のパラメータを入 力 します。

[SECTION NAME]
Parameter=<value>

ネット ワーク上 でのパラメータ使 用

ネット ワーク上 で CitectSCADA を使 用 する場 合 、グローバル、ローカル( 各 サーバ、およびクライ
アント に対 してローカル) 、またはグローバル/ローカル両 方 でパラメータを使 用 できます。プロジェ
クト データベースに設 定 されているパラメータは、コント ロール クライアント のcitect.iniにも設 定
されている場 合 を除 いて、すべてのクライアント に適 用 されます。ローカルcitect.ini fileに設

14
 Chapter: 1 パラメータ

定 されている値 は、設 定 されたクライアント についてのみ、プロジェクト データベースより優 先 さ

れます。例 :

ここでは、パラメータ( パラメータ x) が、(ファイル サーバー上 にある)プロジェクト データベースの n

の値 に設 定 されています。). システム実 行 時 に、この値 (n) は、アラーム サーバーと、両 方 のク
ライアント に適 用 されます。同 じパラメータをI/O サーバー とト レンド サーバーの両 方 に異 なる値
を設 定 ( それぞれのcitect.iniファイルでローカルに設 定 ) します。システム実 行 時 に、I/Oサー
バーはpの値 をパラメータに使 用 し、ト レンド サーバーはmの値 を使 用 します。

パラメータ ダイアログ
パラメータ ダイアログ ボックスを使 い、パラメータにプロパティを割 り当 てます。

パラメータ プロパティ
パラメータには、次 のプロパティがあります。
セクション名
パラメータ セクション。半 角 48文 字 以 下 の値 を入 力 します。

15
Chapter: 1 パラメータ

名前
値 を定 義 するパラメータ名 半 角 32文 字 以 下 の値 を入 力 します。
値
パラメータ値 半 角 254文 字 以 下 の値 を入 力 します。
コメント
任 意 の役 立 つコメント 。半 角 48文 字 以 下 の値 を入 力 します。

16
Chapter: 2 設定パラメータ

パラメータの概 要
CitectSCADA には、プロジェクト の操 作 に関 わる設 定 、および CitectSCADA ネット ワーク内 で
各 コンピュータに参 加 するための設 定 に使 用 する多 くのパラメータのセット があります。
操 作 パラメーは以 下 の場 所 で設 定 できます。
l プロジェクト データベース
プロジェクト データベースのパラメータ セット は、特 定 の CitectSCADA プロジェクト にローカル
に適 用 されます。
l Citect.ini ファイル
Citect.ini ファイルのパラメータ セット は、Citect.ini ファイルがあるコンピュータで実 行 され
る CitectSCADA プロジェクト 全 体 に適 用 されます。
この章 には、以 下 のト ピックがあります。
l パラメータのシンタックス
Citect.ini ファイルのシンタックス。

l パラメータ値 の設 定
CitectSCADA では、各 種 ツールでパラメータ値 を設 定 できます。
l パラメータ優 先 順 位
Citect.ini ファイルとパラメータ データベースの両 方 に値 が設 定 されている場 合 、どちらのパ
ラメータ値 を使 用 するかを取 り決 めるルール。
l 階 層 パラメータ
特 定 のクラスタまたはサーバー プロセスに対 してパラメータを微 調 整 する方 法 。
l Citect.ini のコメント
Citect.ini ファイルにコメント を追 加 する方 法 。

全 システム パラメータの完 全 なリスト については、パラメータ ヘルプ ファイルを参 照 してくださ

い。

パラメータのシンタックス
パラメータは、目 的 に応 じて複 数 のセクションにグループ分 けされています。
セクションを定 義 するするために citect.ini で使 用 されるシンタックスは、以 下 のようになってい
ます。

[Section Name]

17
Chapter: 2 設定パラメータ

<parameter name1> = <parameter value1>

<parameter name2> = <parameter value2>
<parameter nameX> = <parameter valueX>

例 :

[Alarm]
SavePeriod = 600
SaveSecondary =
ScanTime = 500

パラメータの最 大 長 は 254 文 字 です。

サーバーコンポーネント に関 連 するセクション( アラーム、ト レンド 、レポート 、IO サーバー) は階
層 継 承 もサポート し、パラメータはクラスタまたはサーバーコンポーネント レベルに微 調 整 されま
す。使 用 されるシンタックスは次 のとおりです。

[Section Name.ClusterName.ServerName]
<parameter name1> = <parameter value1>
<parameter name2> = <parameter value2>
<parameter nameX> = <parameter valueX>

例 :

[Alarm.Cluster1.Server1]
SavePeriod = 600
ScanTime = 500

詳 細 については、階 層 パラメータを参 照 してください。

パラメータ値 の設 定

意 図 しない装 置 操 作

l Citect.ini パラメータの変 更 や削 除 を行 う前 に、このマニュアルの適 切 な資 料 を読 み、内 容 を理 解 して

ください。
l 資 料 に記 載 されていない Citect.ini パラメータを変 更 したり、削 除 しないでください。
l Citect.ini ファイルの一 部 を削 除 する前 に、必 要 な、または資 料 に記 載 されていないパラメータは削 除
されないことを確 認 してください。
l プロジェクト を実 行 中 に設 定 ファイルを編 集 しないでください。
これらの指 示 に従 わない場 合 は、死 亡 、重 傷 、または装 置 の損 傷 を引 き起 こす可 能 性 があります。

18
 Chapter: 2 設定パラメータ

注 :記 載 されていない機 能 については、必 ずこの製 品 についての技 術 サポート 担 当 者 にお

問 い合 わせください。

CitectSCADAには、パラメータ値 を作 成 または編 集 する方 法 がいくつかあります。

l Citectプロジェクト エディタ
プロジェクト データベースの値 を作 成 または変 更 するために使 用 します。
l コンピュータ セット アップ ウィザード
各 マシンで必 須 で、しかも共 通 に使 用 されるcitect.iniパラメータを設 定 するのに使 用 しま
す。このウィザード で、表 示 される一 連 の情 報 収 集 ページを使 用 してパラメータ値 を設 定 で
きます。
l コンピュータ セット アップ エディタ
citect.iniファイルのパラメータを作 成 または修 正 するために使 用 します。このツールは、グ
ラフィカル インターフェ-スとコンテキスト に対 応 するヘルプ リファレンスを結 び付 けて、特 定 の
パラメータの値 を設 定 する素 早 く便 利 な設 定 ををユーザーに提 供 します。
l テキスト エディタ
テキスト エディタを使 用 してcitect.iniファイルを修 正 できます。しかし、システム設 定 にエ
ラーがある危 険 があるので、推 奨 できる方 法 ではありません。
citect.iniファイルのパラメータを設 定 (または変 更 ) する場 合 、新 規 パラメータ設 定 を使 用 す
る前 に、CitectSCADAを再 起 動 する必 要 があります。この規 則 にはいくつかの例 外 があ
り、citect.iniパラメータは定 期 的 に読 み込 まれ、ランタイムに変 更 できます。この場 合 、このよ
うなパラメータは必 要 に応 じてマニュアルに記 載 されています。

Citect プロジェクト エディタ

プロジェクト データベースのパラメータを作 成 または変 更 できるのは、Citect プロジェクト エディタ
のみです。
プロジェクト データベースにパラメータを設 定 するには:

1. [システム] メニューで、[パラメータ] を選 択 し、[パラメータ] ダイアログボックスを表 示 します。

2. パラメータのセクション名 を入 力 します (16 文 字 以 下 )。
3. パラメータの名 前 を入 力 します (16 文 字 以 下 )。
4. パラメータの値 を入 力 します (254 文 字 以 下 )。
5. データベースにレコード を追 加 します。

注 ：既 存 のパラメータを検 索 するには、スクロールバー( フォームの右 側 ) を使 用 し、各 パラ

メータ レコード 間 を移 動 します。レコード 番 号 がフォームの左 下 端 に表 示 されます。

プロジェクト データベースのパラメータを設 定 ( または変 更 ) する場 合 、新 規 パラメータ設 定 を使

用 する前 に、プロジェクト を再 コンパイルする必 要 があります。

19
Chapter: 2 設定パラメータ

コンピュータ セット アップ ウィザード

コンピュータ セット アップ ウィザード では、必 須 かつ共 通 で使 用 されるシステム パラメータを設 定
するための簡 単 なインターフェースが用 意 されています。ウィザード は数 ページに渡 っています。
l プロジェクト データベースに保 存 されている設 定 を使 用 してコンテキスト 情 報 がユーザーに
提 供 されます。
l Citect.ini ファイルのシンタックス、パラメータを理 解 する必 要 がありません。
l ウィザード 内 に既 に設 定 されている関 連 する以 前 の値 を反 映 し、動 作 を修 正 します。
これは CitectSCADA を実 行 している各 コンピュータの初 期 のセット アップ中 に使 用 され、後 で
再 使 用 してパラメータ設 定 を修 正 することができます。ウィザード インターフェースを使 用 して
ユーザーから集 められたパラメータ値 は、ローカルのCitect.ini ファイルに書 き込 まれます。
詳 細 については、[コンピュータ セット アップ ウィザード の使 用 ] を参 照 してください。

コンピュータ セット アップ エディタ

コンピュータ セット アップ エディタは、Citect.iniパラメータの設 定 を行 うグラフィカル ユーザーイン
ターフェースを備 えており、特 定 のパラメータを検 索 および変 更 するための便 利 なツールです。
エディタは以 下 の特 徴 があります。
l 各 セクションについて、ノード を持 つ拡 張 可 能 なツリーとしてCitect.ini ファイル内 のパラ
メータを表 示 するグラフィカル インターフェース。
l すべての Citect.ini パラメータについての組 み込 みのヘルプリファレンス;
l 2 つの個 別 の Citect.ini ファイルの比 較 レポート 生 成 機 能 。
l パラメータ値 の有 効 性 をチェックする Citect.ini ファイルの分 析 レポート 生 成 機 能 。
コンピュータ セット アップ エディタの使 用 方 法 については、コンピュータ セット アップ エディタ の [ヘ
ルプ] メニューからのコンピュータ セット アップ エディタ ヘルプの使 用 を参 照 してください。

注 ：階 層 パラメータ使 用 してコンポーネント またはサーバーレベルで設 定 する場 合 には、コ

ンピュータ セット アップ エディタで、サーバー パラメータの管 理 、設 定 を行 うことができませ
ん。

テキスト エディタ
ファイルは、CitectSCADA 動 作 パラメータを保 存 するテキスト ファイルです。インス
citect.ini
ト ール中 、このファイルの初 期 バージョンがインスト ール中 に選 択 された CitectSCADA ユー
ザUser and Data ディレクト リの config フォルダにコピーされます。
この場 所 にファイルがない場 合 、他 は検 索 せず、エラーを表 示 します。他 の場 所 に ini ファイル
を保 存 する必 要 がある場 合 は、citect32.exe および ctexplor.exe を起 動 するときに、コマンド ラ
インにその場 所 のパスを指 定 する必 要 があります。

20
 Chapter: 2 設定パラメータ

注 ：citect.iniファイルのファイル名 と場 所 は、CitectSCADA Explorer または Citect32 ラン

タイムを実 行 するときに、-i"file_path.INI" オプションを使 用 して変 更 できます。

citect.ini のローカル ファイルのパラメータを設 定 するには

1. テキスト エディタを使 用 して citect.ini ファイルを開 きます。

2. 次 のフォーマット のパラメータを入 力 します。
[SECTION NAME]
Parameter=<value>

3. citect.ini ファイルに変 更 を保 存 します。

パラメータ優 先 順 位
プロジェクト データベースと citect.ini ファイルの両 方 にパラメータが設 定 されているコンピュータ
では、citect.ini に含 まれている値 がそのコンピュータに使 用 されます。
例 えば、下 記 の図 では、パラメータ X のプロジェクト 値 ( プロジェクト データベースに保 存 されて
います) は n です。これはI/Oサーバーとト レンド サーバー「以 外 」のすべてのサーバーおよびクライ
アント のパラメータ X に使 用 されている値 です。I/Oサーバーとト レンド サーバーは、両 方 ともとも
ローカル citect.ini ファイルに設 定 されている値 を使 用 します( それぞれ p および m ) 。

そのため、プロジェクト にグローバルで、プロジェクト を動 かしているサーバーの大 半 に適 用 される

パラメータはプロジェクト データベースで定 義 されるべきです。プロジェクト データベースでは集 中
して管 理 およびコント ロールできるようになっています。このグローバル値 に対 する例 外 は、例 外
を適 用 するの citect.ini ファイルを修 正 して管 理 できます。
パラメータがプロジェクト データベースでも citect.ini ファイルにおいても設 定 されていない場
合 、システムはそのパラメータのデフォルト 値 を使 用 します。

21
Chapter: 2 設定パラメータ

階 層 パラメータ
CitectSCADAでは、クラスタリング加 え、1台 のコンピュータ上 で同 一 タイプのサーバを複 数 実
行 できる機 能 をサポート しているので、サーバー コンポーネント パラメータ (アラーム、レポート
サーバー、ト レンド 、およびIOサーバー) をマシン レベルよりもさらに詳 細 なレベルに設 定 する必
要 がある場 合 があります。そのため、これらのパラメータはさまざまなレベルで設 定 できる階 層 パ
ラメータとなっています。
l コンポーネント タイプ レベル
最 大 範 囲 。サーバー タイプのすべてのインスタンスに適 用 されるパラメータ値 。
l クラスタ レベル
指 定 されたクラスタで実 行 されているサーバーのすべてのインスタンスに適 用 されるパラメー
タ値 。
l サーバー レベル
指 定 されたマシン上 の、指 定 されたクラスタで実 行 されているすべてのサーバーのインスタン
スに適 用 されるパラメータ値 。
これらのパラメータは、階 層 パラメータをサポート しています。すなわち、パラメータは以 下 のよう
に動 作 します。
1. サーバー レベルでパラメータに設 定 された値 を適 用 します。
2. 上 記 の指 定 がない場 合 は、クラスタ レベルでパラメータに設 定 された値 を適 用 します。
3. 上 記 の指 定 がない場 合 は、コンポーネント レベルでパラメータに設 定 された値 を適 用 しま
す。
4. 上 記 の指 定 がない場 合 は、パラメータのデフォルト 値 を適 用 します。

例
以 下 のCitect.ini file はクラスタ1のサーバー1とサーバー2の両 方 、そしてクラスタ2のサー
バー3およびサーバー4の両 方 に適 用 されます。

[Alarm]SavePeriod = 500
[Alarm.Cluster1]SavePeriod = 600
[Alarm.Cluster1.Server1]SavePeriod = 1000

これを、以 下 の図 で説 明 します。

22
 Chapter: 2 設定パラメータ

[Alarm]SavePeriod に対 して各 サーバーに適 用 された値 は以 下 のようになります。

クラスタ名 コンピュータ名 SavePeriod値

クラスタ 1 サーバー1 1000

クラスタ 1 サーバー2 600

クラスタ 2 サーバー3 500

クラスタ 2 サーバー4 500

注 : 階 層 パラメータがパラメータ データベースに設 定 されている場 合 があります。この場 合

は、この場 合 は通 常 の優 先 順 位 が適 用 されます。詳 細 については、パラメータの優 先 順
位 を参 照 してください。

Citect.ini のコメント
コメント は以 下 の特 殊 文 字 を使 用 して Citect.ini ファイル内 に挿 入 することができます。
l 改 行 の最 初 に `#' を使 用 してコメント のテキスト を続 けて付 加 できます。コメント は後 に続
くINI エレメント (セクションまたはパラメータ) に関 連 する内 容 が良 いでしょう。コメント には等
号 (=)記 号 文 字 を使 用 しないでください。
l パラメータの最 初 に `!' を使 用 すると、パラメータは無 効 になり、初 期 値 が適 用 されることを
示 します。

注 ：行 の最 初 にコメント 特 殊 文 字 を使 用 しても、'=' を含 むすべての行 はパラメータとして

扱 われてしまいます。

例：

23
Chapter: 2 設定パラメータ

[LAN]
#Disable Networking
Disable=1

24
Chapter: 3 参照情報
このセクションには、以 下 を含 む、CitectSCADA に関 するリファレンス情 報 があります。
仕様
フォーマット フィールド
エラー メッセージ

予 期 しない機 器 の動 作

CtAPI でデジタル型 を読 み取 る場 合 は、常 に、あと 2 バイト 大 きいバッファを使 ってください。これにより、ビット シ

フト 演 算 のシステムメモリ破 壊 を防 止 することができます。

これらの指 示 に従 わない場 合 は、死 亡 、重 傷 、または装 置 の損 傷 を引 き起 こす可 能 性 があります。

仕様
このセクションでは、CitectSCADA 仕 様 のリファレンス情 報 を定 義 します。
l グラフィックス
l プロジェクト
l I/O デバイス データ型
l 定 義 済 み AN
l 定 義 済 みテンプレート
l 定 義 済 みコマンド
l 定 義 済 み文 字 セット
l 定 義 済 みフォント
l 定 義 済 みデバイス
l 定 義 済 み Cicode ファイル
l 定 義 済 みカラー名 とコード
l 定 義 済 みキーボード キー コード
l 定 義 済 みラベル
l ASCII/ANSI 文 字 コード 一 覧

25
Chapter: 3 参照情報

グラフィックス
下 の表 は CitectSCADA プロジェクト 仕 様 を定 義 しています。

高解像度色表示 VGA, SVGA, XGA, SXGA (任 意 解 像 度 )

パレット の色 255

パレット から選 択 可 能 なユーザー定 義 色 1,680万

自 由 形 状 グラフィックス/表 示 ページ数 65000*

ページ当 りのオブジェクト アニメーション ポイント (AN) 32000

画面更新時間 500 ミリ秒 (注 を参 照 )

注 : 画 面 の更 新 時 間 は、使 用 されるI/Oデバイス プロト コルとシステム設 計 により異 なりま

す。最 小 更 新 レート は1ミリ秒 で、これはPLCが速 くデータを提 供 できる場 合 にのみ可 能 で
す。CitectSCADAはオンデマンド ベースの読 み取 りおよび動 的 な最 適 化 を利 用 するので、
可 能 な限 り最 も速 い画 面 更 新 レート を維 持 します。これらの技 術 によりCitectSCADAが
必 要 な情 報 のみをPLCから読 み取 ることを可 能 となり、I/Oデバイスへの通 信 チャネルを最
大 限 に活 用 します。100,000ポイント で実 際 にインスト -ル済 みのシステムのパフォーマンス
テスト では、画 面 更 新 率 を400ミリ秒 に保 持 します。

プロジェクト
下 の表 は CitectSCADA プロジェクト 仕 様 を定 義 しています。

設 定 プロジ 1022*
ェクト

CitectSCA- 4,194,303 (500,000* が推 奨 の最 大 数 です)

DA で定
義 される変 これは、実 行 中 のシステムに対 するシステム全 体 の限 界 ( 制 限 ) です。クラスタ化 に関 係
数 タグの数 なく、現 在 、コンパイル、および実 行 中 のプロジェクト に含 まれる全 プロジェクト のタグすべて
が、この制 限 に関 わっています。

重 要 ：プロジェクト に複 数 のタグをベースにしたドライバを使 用 する場 合 、最 大 許 容 数 はド

ライバに定 義 された変 数 のビット 長 さによって異 なります。これは、各 タグを識 別 する際 、ド
ライバで OID を使 用 する必 要 があるからです。例 えば、32ビット デジタルを使 用 するタグ
ベースのドライバでは、許 容 される変 数 の数 は32で割 った数 になります (つまり、プロジェク
ト に32ビット デジタルのみ含 まれる場 合 は、変 数 の最 大 数 は131,072 になります)。ドラ
イバに指 定 されたビット サイズが定 義 されていない場 合 、初 期 値 の 16 となります。

26
 Chapter: 3 参照情報

含 まれるプ 240 (インクルード プロジェクト を含 む)

ロジェクト の
数

同 時 にログ 250*
インできる
ユーザ数

レポート の 1000*
数

アラームが 150000*
監視す
るI/Oデバ
イス アドレ
スの数

履 歴 ト レン 32000*
ドの数

同 じチャー 16*
ト図上に
表 示 される
ト レンドの
数

アラーム数 アラーム タイプ毎 に65,535

同 じページ 16000
上 に表 示
されるト レ
ンドの数

ユーザ関 4500*
数 の数

標準内蔵 700
された関 数
の数

システムの 3000*
ための操
作 コマンド
の数

CitectSCA- 16383
DAに接 続
できるI/O
デバイス数

27
Chapter: 3 参照情報

同時複数 4095
プロト コル
の数

領 域 の数 255

アラーム分 16376
類 の数

最大同時 512
マルチタス
ク処 理 スレ
ッド

*これらの値 には実 際 の制 約 はなく、単 なる最 大 推 奨 値 に過 ぎません。ただし、この数 を超 過

した場 合 、ト レンド サーバーのパフォーマンス (CPU負 荷 ) およびプロセス アナリスト を表 示 する
クライアント のCPU負 荷 に影 響 を与 える可 能 性 があります。

I/O デバイス データ型

以 下 の表 には、データ型 、サイズ、許 容 値 が表 示 されています。

データ型 サイズ 許容値

BCD 2バイト 0～ 9,999

バイト 1バイト 0～ 255

デジタル 1ビット または1バイト 0または1

整数 2バイト -32,768～ 32,767

符 号 なし整 数

LONG型 整 数 4バイト

LONG型 BCG 4バイト

浮 動 小 数 点 (実 数 ) 4バイト

文字列 256バイト ( タグおよび Cicode 関 数 ) ASCII (NULL で終 了 )

128バイト ( グローバルCicode変 数 )

28
 Chapter: 3 参照情報

定 義 済 みAN
次 の表 にすべての定 義 済 みANが説 明 されています。

AN 説明 コメント

1 キー ここにオペレータからのキーボード入 力 がエコーバック( 表 示 ) されます。

ボード
入力
列

2 プロン プロンプト 列 は、オペレータに重 要 な情 報 を伝 えるために使 用 されます。Prompt()

プト 関 数 を使 用 してプロンプト を表 示 し、オペレータの処 理 を手 助 けしたり、また
列 は、DspError() 関 数 を使 用 して警 告 やエラーメッセージを表 示 できます。プロン
プト メッセージを表 示 するには、Cicode関 数 を使 用 する必 要 があります。

以 下 のANはバージョン 2.xx式 テンプレート ( あるいはバージョン 2.xxからバージョンアップされたページ) 専

用 に予 約 されています。

3 予約

4 予約

5 未確 もし、アラームが確 認 されていなければ、「未 確 認 アラーム」のメッセージが表 示 さ

認ア れます。次 に、アラーム ページを選 択 してアラームの詳 細 を表 示 できます。
ラーム

6 ハード CitectSCADAによりハードウェア アラームが検 知 された場 合 、"HARDWARE

ウェア ALARMS" というメッセージが表 示 されます。次 に、アラーム ページを選 択 してア
アラー ラームの詳 細 を表 示 できます。
ム

7 アラー アラームが無 効 になると、「アラーム無 効 」のメッセージが表 示 されます。次 に、ア

ム無 ラーム ページを選 択 してアラームの詳 細 を表 示 できます。
効

8 予約

9 時間 現 在 のシステム時 刻 が表 示 されます。時 間 ディスプレイの書 式 を設 定 するには、

主 要 Windowsプログラム グループのウィンドー コント ロール パネルを使 用 する
か、CitectSCADAパラメータを設 定 します。

10 Date 現 在 のシステム日 付 けが表 示 されます。日 付 ディスプレイの書 式 を設 定 するに

は、主 要 Windowsプログラム グループのWindows コント ロール パネルを使 用 す
るか、CitectSCADAパラメータを設 定 します。

11 最終 ここに最 後 に作 動 したアラームが表 示 されます。

29
Chapter: 3 参照情報

アラー
ム

12 ペー グラフィックス ページのタイト ルが表 示 されます。

ジタイ
トル

13 ペー グラフィックス ページの名 前 が表 示 されます。

ジ名

14 コマン ボタンあるいはアニメーション オブジェクト に関 連 するヘルプ テキスト が表 示 されま

ドヘ す。
ルプ

15 ボタン ページに依 存 するボタン

16 ボタン ページに依 存 するボタン

17 ボタン ページに依 存 するボタン

18 最終 現 在 のページの前 に表 示 された、グラフィックス ページを選 択 するボタン

ペー
ジボ
タン

19 ペー ページの順 に次 のグラフィックス ページを選 択 するボタン

ジアッ
プボ
タン

20 ペー ページ順 に前 のグラフィックス ページを選 択 するボタン

ジダウ
ンボ
タン

定 義 済 みテンプレート
以 下 のテンプレート は、さまざまなスタイルで提 供 されています。これらのテンプレート のほとんど
は、完 全 に設 定 されています。テンプレート をほとんどまたは全 くカスタマイズせずに、ページを作
成 できます。

テンプレート 名 説明

Normal 基 本 的 なグラフィックス表 示 ページ用 のテンプレート です。このテンプ

レート には、(アラームやメニュー ページの表 示 のような) 基 本 的 な
ページ制 御 用 のボタンと、プラント の配 置 や制 御 ボタンなどを描 画 す

30
 Chapter: 3 参照情報

るための大 きな空 白 エリアがあります。

Blank 完 全 に空 白 のテンプレート です。このテンプレート は、全 体 のページを

設 定 するのに使 用 します。

PageMenu 簡 単 なメニューページを作 成 するためのテンプレート 。CitectSCADA

は、プロジェクト を開 発 すると、自 動 的 に (このテンプレート に基 づいて)
メニュー ページを生 成 します。特 定 の要 求 に合 わせて、メニュー ペー
ジを修 正 できます。

Book1Menu .. (オープン ブック 書 式 の) メニュー ページを作 成 するための別 のテンプ

Book5Menu レート です。オペレータは、該 当 するタブをクリックして、メニュー ページ
間 を移 動 できます。これらのテンプレート を使 用 するには、各 メニュー
ページにボタンを追 加 し、必 要 に応 じて他 のグラフィックス ページを表
示 します。

テンプレート として同 じ名 前 のページを作 成 し、余 分 な設 定 を追 加 し

ないようにして下 さい。ページがリンクされない場 合 は、メニューを修 正
できるので、どのページ名 でも受 け入 れられます。

Tab1Menu .. (タブ 書 式 の) メニュー ページを作 成 するための別 のテンプレート で

Tab6Menu す。オペレータは、該 当 するタブをクリックして、メニュー ページ間 を移
動 できます。これらのテンプレート を使 用 するには、各 メニュー ページに
ボタンを追 加 し、必 要 に応 じて他 のグラフィックス ページを表 示 しま
す。

テンプレート として同 じ名 前 のページを作 成 し、余 分 な設 定 を追 加 し

ないようにして下 さい。ページがリンクされない場 合 は、メニューを修 正
できるので、どのページ名 でも受 け入 れられます。

SingleTrend ト レンド ウィンドウが 1 つある、ト レンド ページを作 成 するためのテンプ

レート です。ト レンド ペンを設 定 する方 法 はいくつかあります。
1. ウィンドウをダブルクリックします。
2. ランタイムでページを開 いたときに、PageTrend() 関 数 を使 ってト
レンド ペンをパラメータとして渡 します。

3. ランタイムに、(ページから) 手 動 でペンを選 択 します。

SingleTrend ページは、周 期 または周 期 イベント 型 のト レンド タグを

使 って設 定 できます。

DoubleTrend ト レンド ウィンドウが 2 つある、ト レンド ページを作 成 するためのテンプ

レート です。ウィンドウごとにト レンド ペンを設 定 するには、ウィンドウを
ダブルクリックするか、ランタイムに (ページから) 手 動 でペンを選 択 しま
す。各 ト レンド ページを表 示 するには、メニュー ページにボタンを追 加
します。

DoubleTrend ページは、周 期 または周 期 イベント 型 のト レンド タグを

使 って設 定 できます。

CompareTrend 一 方 が他 方 の上 に重 ねられた、2 つのト レンドがあるト レンド ページを

31
Chapter: 3 参照情報

作 成 するためのテンプレート です。ト レンドごとに (最 高 4 つまで) ト レ

ンド ペンを設 定 するには、ウィンドウをダブルクリックするか、ランタイムに
(ページから) 手 動 でペンを選 択 します。各 ト レンド ページを表 示 する
には、メニュー ページにボタンを追 加 します。CompareTrend ページ
は、周 期 または周 期 イベント 型 のト レンド タグを使 って設 定 できます。

EventTrend イベント ト レンド ウィンドウが 1 つあるト レンド ページを作 成 するテンプ

レート です。ト レンド ペンを設 定 する方 法 はいくつかあります。
1) ウィンドウをダブルクリックします
2) ランタイムでページを開 いたときに、PageTrend() 関 数 を使 ってト
レンドのペンをパラメータとして渡 します。
3) ランタイムに、(ページから) 手 動 でペンを選 択 します。

EventTrend ページは、イベント 型 のト レンド タグを使 ってしか設 定 で

きません。

ZoomTrend ト レンド ウィンドウとズーム ウィンドウが 1 つずつある、ト レンド ページを

作 成 するテンプレート です。ト レンド ペンを設 定 するには、ウィンドウを
ダブルクリックするか、ランタイムに手 動 で (ページから) ペンを選 択 しま
す。

ZoomTrend ページは、周 期 または周 期 イベント 型 のト レンド タグを

使 って設 定 できます。

PopTrend ポップアップ ト レンドとして表 示 する、小 型 のト レンド ページを作 成 する

ためのテンプレート です。ト レンド ペンを設 定 するには、PageTrend()
関 数 を使 用 してト レンド ページを開 き、ト レンド ペンをパラメータとして
渡 すか、またはランタイムに手 動 で (ページから) ペンを選 択 します。

PopTrend ページは、周 期 または周 期 イベント 型 のト レンドタグを使 っ

て設 定 できます。

MeanMeanChart 2 つの平 均 ウィンドウがある SPC ページを作 成 するテンプレート です。

RangeChart 平 均 値 および値 域 ウィンドウがある SPC ページを作 成 するテンプレー

ト です。

StandardChart 平 均 値 ウィンドウと標 準 偏 差 ウィンドウがある SPC ページを作 成 する

テンプレート です。

SPCCPK SPC 出 力 チャート 図 を作 成 するテンプレート です。ペンを設 定 するに

は、ウィンドウをダブルクリックするか、ランタイムに手 動 で (ページから)
ペンを選 択 します。

SPCCPK ページは、周 期 またはイベント 型 の SPC タグで設 定 できま

す。

SPCPareto SPC パレート チャート 図 を作 成 するテンプレート です。(ト レンド タグで

はなく) 変 数 タグを設 定 するには、ウィンドウをダブルクリックします。

SPCXRSChart 平 均 値 ウィンドウ、値 域 ウィンドウ、および標 準 偏 差 ウィンドウがある

32
 Chapter: 3 参照情報

SPC 制 御 チャート 図 を作 成 するテンプレート です。ペンを設 定 するに

は、ウィンドウをダブルクリックするか、ランタイムに手 動 で (ページから)
ペンを選 択 します。

SPCXRSChart ページは、周 期 またはイベント 型 の SPC タグで設 定

できます。

EventSPCXRS SPCXRS ウィンドウが 1 つあるト レンド ページを作 成 するテンプレート

です。ペンを設 定 するには、ウィンドウをダブルクリックするか、ランタイム
に手 動 で (ページから) ペンを選 択 します。

EventSPCXRS ページはイベント 型 の SPC タグを使 わないと設 定 でき

ません。

アラーム アラーム表 示 ページを作 成 するためのテンプレート です。このテンプ

レート を基 にして、「Alarm」と呼 ばれるページを作 成 してください。(メニ
ュー ページのような他 のページ上 にある) アラーム表 示 用 のボタンを
正 常 に動 作 させるためです。(アラーム ディスプレイ ボタンが
PageAlarm() 関 数 を呼 び出 します。)このテンプレート か
ら、「Alarm」ページを (修 正 なしで) 直 接 作 成 できますし、要 求 に合
わせてそのページを修 正 できます。

サマリー アラーム サマリー ページを作 成 するためのテンプレート です。このテン

プレート を基 にして、(メニュー ページのような他 のページ上 にある) ア
ラーム サマリー ボタンが正 しく動 作 するよう、「Summary」と呼 ばれる
ページを作 成 してください。(アラーム サマリー ボタンが
PageSummary() 関 数 を呼 び出 します。)このテンプレート か
ら、「Summary」ページを (修 正 なしで) 直 接 作 成 できますし、要 求
に合 わせてそのページを修 正 することができます。

ハードウェア ハードウェア アラーム ページを作 成 するためのテンプレート です。このテ

ンプレート を基 にして、(メニュー ページのような他 のページ上 にある)
ハードウェア アラーム ボタンが正 しく動 作 するよう、「Hardware」と呼
ばれるページを作 成 してください。(ハードウェア アラーム ボタンが
PageHardware() 関 数 を呼 び出 します。)このテンプレート か
ら、「Hardware」ページを (修 正 なしで) 直 接 作 成 できますし、要 求
に合 わせてそのページを修 正 することができます。

無効 無 効 アラームのページを作 成 するためのテンプレート で
す。PageDisabled() 関 数 を使 う場 合 、このテンプレート を基 にし
て、「Disabled」と呼 ばれるページを作 成 してください。このテンプレート
から、「Disable」ページを (修 正 なしで) 直 接 作 成 することや、要 求
に合 わせてそのページを修 正 することができます。

ファイル ファイル/画 面 変 換 表 示 ページを作 成 するためのテンプレート です。こ

のページを使 用 して (レポート やその他 の情 報 などの) 任 意 の ASCII
ファイルを表 示 することができます。PageFile() 関 数 を使 う場 合 、この
テンプレート を基 にして、「File」と呼 ばれるページを作 成 してください。こ
のテンプレート から、「File」ページを (修 正 なしで) 直 接 作 成 すること
や、要 求 に合 わせてそのページを修 正 することができます。

GroupStatus プラント 装 置 のグループに対 する、マルチステート 表 示 ページを作 成 す

33
Chapter: 3 参照情報

るためのテンプレート です。

TrnPopStat ト レンド統 計 を表 示 するページを作 成 するためのテンプレート です。こ

のテンプレート を基 にして、「!TrendStats」と呼 ばれるページを作 成 し
てください。ト レンド ウィンドウから呼 び出 されると、そのウィンドウの中 で
使 用 される (最 小 、最 大 、平 均 などの) ト レンド ペンの統 計 が表 示 さ
れます。TrnPopStat ウィンドウを表 示 して、ト レンドのあるエリアを一
括 りにすることもでき、そうするとそのエリアについての統 計 が表 示 されま
す。

定 義 済 みコマンド
このセクションは、インクルード プロジェクト で定 義 済 みのシステム キーボード コマンド について
説 明 します。( システム キーボード コマンド は、コンピュータ画 面 に表 示 されるどのグラフィックス
ページ上 でも動 作 します。)
l システム キーボード コマンド データベース
l 定 義 済 みキーボード キー
l キーボード キー データベース

システム キーボード コマンド データベース

次 の表 に、コマンド とその関 数 に関 連 するキー シーケンスを示 します。

キー シーケンス コマンド 説明

*BS KeyBS() 現 在 のキーをバックスペース

DOWN KeyDown() カーソルを下 へ移 動

PGDN PagePrev() 前 のページを表 示

PGUP PageNext() 次 のページを表 示

RIGHT KeyRight() カーソルを右 へ移 動

UP KeyUp() カーソルを上 へ移 動

通 常 、同 じキー シーケンスでプロジェクト に新 しいコマンド を設 定 して、定 義 済 みコマンド を上

書 きができます。上 書 きできないコマンド は *BS コマンド のみです。このシーケンスは、キー コマ
ンド ラインから最 後 のキーを削 除 するのに使 用 するホット キーだからです。

注 ：インクルード プロジェクト を変 更 しないでください。インクルード プロジェクト の変 更 内 容

34
 Chapter: 3 参照情報

は、CitectSCADA を再 インスト ール、または新 しいバージョンにアップグレード すると失 われ

ます。

定 義 済 みキーボード キー
下 記 に説 明 されているキーボード キーは、インクルード プロジェクト で事 前 定 義 されています。
次 で説 明 するキーボード キーは、インクルード プロジェクト で定 義 済 みです。これらのキーは、オ
ブジェクト のキーボード コマンド を定 義 する時 など、どのキー シーケンス フィールド でも使 用 でき
ます。

キーボード キー データベース
次 の表 は、キー名 、コード 、および説 明 を示 しています。

キー名 キー コード 説明

BS KEY_ バックスペース キー
BACKSPACE

DOWN KEY_DOWN カーソルを下 へ移 動

DOWN_SHIFT KEY_DOWN_SHIFT シフト 下 キー

Enter KEY_ENTER エンター キー

LBUTTON_DBL KEY_LBUTTON_ マウス左 ボタン ダブルクリック

DBL

LBUTTON_DN KEY_LBUTTON_ マウス左 ボタン押 下

DN

LBUTTON_UP KEY_LBUTTON_ マウス左 ボタン開 放

UP

LBUTTON_ KEY_LBTN_ マウス左 ボタン押 下 (コマンド カーソル)

CMD_DN CMD_DN

LBUTTON_CMD_ KEY_LBTN_CMD_ [Ctrl] キーを押 さえながらマウス左 ボタン押 下 (コマンド

DNC DNC カーソル)

LBUTTON_CMD_ KEY_LBTN_CMD_ [Shift] キーを押 さえながらマウス左 ボタン押 下 (コマンド

DNS DNS カーソル)

LBUTTON_ KEY_LBTN_ マウス左 ボタン開 放 (コマンド カーソル)

CMD_UP CMD_UP

LBUTTON_CMD_ KEY_LBTN_CMD_ [Ctrl] キーを押 さえながらマウス左 ボタン開 放 (コマンド

UPC UPC カーソル)

35
Chapter: 3 参照情報

キー名 キー コード 説明

LBUTTON_CMD_ KEY_LBTN_CMD_ [Shift] キーを押 さえながらマウス左 ボタン開 放 (コマンド

UPS UPS カーソル)

LEFT KEY_LEFT カーソル左

MBUTTON_DN KEY_MBUTTON_ マウス中 央 ボタン押 下

DN

MBUTTON_UP KEY_MBUTTON_ マウス中 央 ボタン開 放

UP

PGDN KEY_PGDN ページ下 キー

PGUP KEY_PGUP ページ上 キー

RBUTTON_DN KEY_RBUTTON_ マウス右 ボタン押 下

DN

RBUTTON_UP KEY_RBUTTON_ マウス右 ボタン開 放

UP

RBUTTON_ KEY_RBTN_ マウス右 ボタン押 下 (コマンド カーソル)

CMD_DN CMD_DN

RBUTTON_ KEY_RBTN_ マウス右 ボタン開 放 (コマンド カーソル)

CMD_UP CMD_UP

RIGHT KEY_RIGHT カーソル右

UP KEY_UP カーソル上

UP_SHIFT KEY_UP_SHIFT シフト 上 キー

注 :インクルード プロジェクト を変 更 しないでください。インクルード プロジェクト への修 正 内

容 は、CitectSCADA を再 インスト ールしたり、アップグレード すると消 失 します。

定 義 済 み文 字 セット
以 下 の文 字 セット は、インクルード プロジェクト のラベルとして事 前 定 義 されています。

ラベル 値 説明

36
 Chapter: 3 参照情報

DEFAULT_CHARSET 1 Windows のデフォルト の文 字 セット を使 用 します。

SHIFTJIS_CHARSET 日 本 語 文 字 セット
128

HANGEUL_CHARSET 韓 国 語 文 字 セット
129

GB2312_CHARSET 中 国 語 文 字 セット
134

CHINESEBIG5_CHARSET 中 国 語 文 字 セット
136

JOHAB_CHARSET
130

HEBREW_CHARSET
177

ARABIC_CHARSET
178

GREEK_CHARSET
161

TURKISH_CHARSET
162

VIETNAMESE_CHARSET
163

THAI_CHARSET
222

EASTEUROPE_CHARSET
238

37
Chapter: 3 参照情報

RUSSIAN_CHARSET
204

BALTIC_CHARSET
186

注 : インクルード プロジェクト を変 更 しないでください。インクルード プロジェクト への修 正 内

容 は、CitectSCADA を再 インスト ールしたり、アップグレード すると消 失 します。

定 義 済 みフォント
以 下 のフォント は、インクルード プロジェクト で事 前 定 義 されています。

フォント 名 フォント のタイプ サイズ 色

AlmAccOffFont Arial 10 白

AlmAccOnFont Arial 10 シアン

AlmDisabledFont Arial 10 白

AlmUnAccOffFont Arial 10 茶

AlmUnAccOnFont Arial 10 黄

ButtonFont Arial 10 黒

Casanova Arial -10 黒

ControlLimits Times New Roman 14 黒

DefaultFont Courier New 14 白

DisabledFont Arial 10 白

FontOP Courier New 14 薄 シアン

FontPV Courier New 14 薄緑

38
 Chapter: 3 参照情報

FontSP Courier New 14 薄赤

FontTune Courier New 14 黄

GraphBigFont Arial 60 黒

GraphColour Arial 32 青

GraphColourBig Arial 60 赤

GraphColourSmall Courier New 20 黒

GraphFont Arial 32 黒

GraphSmallFont Courier New 20 黒

HardwareFont Arial 10 薄赤

Pen1SpcFont Courier 10 白

Pen1TrendFont Courier New 14 薄緑

Pen2SpcFont Courier New 14 薄緑

Pen2TrendFont Courier New 14 黄

Pen3SpcFont Courier New 14 薄 シアン

Pen3TrendFont Courier New 14 薄赤

Pen4SpcFont Courier New 14 薄青

Pen4TrendFont Courier New 14 薄 シアン

Pen5TrendFont Courier New 14 薄 マゼンタ

Pen6TrendFont Courier New 14 白

Pen7TrendFont Courier New 14 薄青

Pen8TrendFont Courier New 14 灰色

PromptFont Arial 10 白

39
Chapter: 3 参照情報

SpcFont Courier New 14 白

TextFont Arial 10 白

TimeFont Arial 10 黒

TrendFont Courier New 14 白

TrendHistFont Courier New 14 黄

TrendSHistFont Arial -10 マゼンタ

TrendSFont Arial -10 黒

UnacceptedFont Arial 10 黄

Vanuatu Arial -9 黒

System Arial 10 黒

TrendSCentreFont Arial -10 黄

PopFont Arial 9 黒

同 じ名 称 の新 しいフォント をプロジェクト に追 加 することにより、予 め定 義 されたフォント を無 効

にすることができます。

注 : インクルード プロジェクト を変 更 しないでください。インクルード プロジェクト への修 正 内

容 は、CitectSCADA を再 インスト ールしたり、アップグレード すると消 失 します。

定 義 済 みデバイス
このセクションは、インクルード プロジェクト で定 義 済 みのデバイスについて説 明 します。
デバイス データベース
下 のテーブルは、CitectSCADAがサポート するデバイスを示 します。

デバイス名 タイプ 説明

ASCII_DEV 0 Asciiデバイス番 号

40
 Chapter: 3 参照情報

PRINTER_DEV 1 プリンタ デバイス番 号

dBASE_DEV 2 dBASEデバイス番 号

SQL_DEV 4 SQLデバイス番 号

AlarmDisk 0(ASCIIファイル) デフォルト アラーム ログ ファイル

AlarmPrint 0(ASCIIファイル) デフォルト アラーム プリント 装 置

KeyDisk 0(ASCIIファイル) デフォルト キーボード ログ ファイル

KeyPrint 1(プリンタ) デフォルト キーボード プリンタ ログ

Printer1 1(プリンタ) LPT1: プリンタ1装 置

Printer2 1(プリンタ) LPT2: プリンタ2装 置

SummaryPrint 0(ASCIIファイル) デフォルト アラーム サマリー プリンタ装 置

SummaryDisk 0(ASCIIファイル) デフォルト アラーム サマリー ログ ファイル

_Trend 3 (dBASE) ト レンドRDBデバイス

Scratch 0(ASCIIファイル) DevModify関 数 デバイス

注 : インクルード プロジェクト を変 更 しないでください。インクルード プロジェクト への修 正 内

容 は、CitectSCADA を再 インスト ールしたり、アップグレード すると消 失 します。

定 義 済 みCicodeファイル
以 下 のCicodeファイルは、インクルード プロジェクト の一 部 分 です。

ファイル名 説明

citect.ci 全 般 的 なユーティリティ関 数

debug.ci ユーザー Cicode デバッグ関 数

export.ci 情報関数

41
Chapter: 3 参照情報

graph.ci ト レンド データのエクスポート 関 数

info.ci 情報関数

numpad.ci 数 字 入 力 キーパッド関 数

page.ci グラフィック ページのユーティリティ関 数

pareto.ci パレート チャート 図 のための関 数

spc.ci デフォルト SPC 関 数

spcplus.ci SPC関 数 - 拡 張

statpop.ci ト レンド統 計 関 数

tag.ci タグの割 付 けと操 作 のための関 数

trend.ci デフォルト ト レンド関 数

trninfo.ci ト レンド情 報 収 集 関 数

zoom.ci ト レンド ズーム関 数

注 : インクルード プロジェクト を変 更 しないでください。インクルード プロジェクト への修 正 内

容 は、CitectSCADA を再 インスト ールしたり、アップグレード すると消 失 します。

定 義 済 みカラー名 とコード
標 準 色 16色 を、CitectSCADAシステムで使 用 することができます。これらは、インクルード プロ
ジェクト で定 義 済 みです。そのわかり易 さから、コード 値 を使 用 する場 合 は常 にこれらの色 を名
前 で照 会 します。

色 ラベル コード

黒 0x000000

青 0x000080

緑 0x008000

42
 Chapter: 3 参照情報

シアン 0x008080

赤 0x800000

マゼンタ 0x800080

茶 0x808000

グレー 0xBFBFBF

ダークグレー 0x7F7F7F

薄青 0x0000FF

薄緑 0x00FF00

薄 シアン 0x00FFFF

薄赤 0xFF0000

薄 マゼンタ 0xFF00FF

黄 0xFFFF00

白 0xFFFFFF

TRANSPARENT 0XFF000000

注 : インクルード プロジェクト を変 更 しないでください。インクルード プロジェクト への修 正 内

容 は、CitectSCADA を再 インスト ールしたり、アップグレード すると消 失 します。

定 義 済 みキーボード キー コード
次 の重 要 なキー コード ラベルは、CitectSCADAインクルード プロジェクト で定 義 済 みです。
キーボード キーを定 義 する時 、キー コード として入 力 することができます。従 って、各 キーの16
進 数 を覚 える必 要 はありません。

キー コード キー コード
キーの説 明
(CitectSCADA ラベル) (16進 数 )

KEY_LBUTTON 0x0001 マウス左 ボタン

43
Chapter: 3 参照情報

キー コード キー コード
キーの説 明
(CitectSCADA ラベル) (16進 数 )

KEY_RBUTTON 0x0002 マウス右 ボタン

KEY_MBUTTON 0x0004 マウス中 央 ボタン

KEY_LBUTTON_UP 0x0201 マウス左 ボタン開 放

KEY_RBUTTON_UP 0x0202 マウス右 ボタン開 放

KEY_MBUTTON_UP 0x0204 マウス中 央 ボタン開 放

KEY_LBUTTON_ 0x0401 マウス左 ボタンのダブルクリック

DBL

KEY_RBUTTON_ 0x0402 マウス右 ボタンのダブルクリック

DBL

KEY_MBUTTON_ 0x0403 マウス中 央 ボタンのダブルクリック

DBL

KEY_LBUTTON_DN 0x0801 マウスの左 ボタンを下 へ

KEY_RBUTTON_DN 0x0802 マウスの右 ボタンを下 へ

KEY_MBUTTON_DN 0x0804 マウスの中 央 ボタンを下 へ

KEY_LBTN_CMD_ 0x0601 マウスの左 ボタンを開 放 ( コマンド カーソル)

UP

KEY_RBTN_CMD_ 0x0602 マウスの右 ボタンを開 放 ( コマンド カーソル)

UP

KEY_MBTN_CMD_ 0x0604 マウスの中 央 ボタンを開 放 ( コマンド カーソル)

UP

KEY_LBTN_CMD_ 0x0605 マウスの左 ボタンを下 へ( コマンド カーソル)

DN

KEY_RBTN_CMD_ 0x0606 マウスの右 ボタンを下 へ( コマンド カーソル)

DN

KEY_MBTN_CMD_ 0x0608 マウスの中 央 ボタンを下 へ( コマンド カーソル)

DN

KEY_LBTN_CMD_ 0x1601 Shift キーを押 しながらカーソル押 しながらマウスの左 ボタ

44
 Chapter: 3 参照情報

キー コード キー コード
キーの説 明
(CitectSCADA ラベル) (16進 数 )

UPS ンを開 放 ( コマンド カーソル)

KEY_RBTN_CMD_ 0x1602 Shift キーを押 しながらカーソル押 しながらマウスの右 ボタ

UPS ンを開 放 ( コマンド カーソル)

KEY_MBTN_CMD_ 0x1604 Shift キーを押 しながらカーソル押 しながらマウスの中 央 ボ

UPS タンを開 放 ( コマンド カーソル)

KEY_LBTN_CMD_ 0x1605 Shift キーを押 しながらカーソル押 しながらマウスの左 ボタ

DNS ンを下 へ( コマンド カーソル)

KEY_RBTN_CMD_ 0x1606 Shift キーを押 しながらカーソル押 しながらマウスの右 ボタ

DNS ンを下 へ( コマンド カーソル)

KEY_MBTN_CMD_ 0x1608 Shift キーを押 しながらカーソル押 しながらマウスの中 央 ボ

DNS タンを下 へ( コマンド カーソル)

KEY_LBTN_CMD_ 0x2601 Ctrl キーを押 しながらマウスの左 ボタンを開 放 ( コマンド

UPC カーソル)

KEY_RBTN_CMD_ 0x2602 Ctrl キーを押 しながらマウスの右 ボタンを開 放 ( コマンド

UPC カーソル)

KEY_MBTN_CMD_ 0x2604 Ctrl キーを押 しながらマウスの中 央 ボタンを開 放 ( コマンド

UPC カーソル)

KEY_LBTN_CMD_ 0x2605 Ctrl キーを押 しながらマウスの左 ボタンを下 へ( コマンド

DNC カーソル)

KEY_RBTN_CMD_ 0x2606 Ctrl キーを押 しながらマウスの右 ボタンを下 へ( コマンド

DNC カーソル)

KEY_MBTN_CMD_ 0x2608 Ctrl キーを押 しながらマウスの中 央 ボタンを下 へ( コマンド

DNC カーソル)

KEY_BACKSPACE 0x0008 バックスペース

KEY_TAB 0x0009 タブ

KEY_LF 0x000A 改行

KEY_VT 0x000B 垂 直 タブ

KEY_FF 0x000C 改 ページ

45
Chapter: 3 参照情報

キー コード キー コード
キーの説 明
(CitectSCADA ラベル) (16進 数 )

KEY_RETURN 0x000D 強制改行

KEY_ENTER 0x000D 入 力 ( 上 と同 じキー)

KEY_ESCAPE 0x001B エスケープ

KEY_ESC 0x001B エスケープ( 上 と同 じキー)

KEY_DELETE 0x012E 削除

KEY_PGUP 0x0121 ページ戻 し

KEY_PGDN 0x0122 ページ送 り

KEY_END 0x0123 エンド

KEY_HOME 0x0124 ホーム

KEY_LEFT 0x0125 カーソル左 移 動

KEY_UP 0x0126 カーソル上 移 動

KEY_RIGHT 0x0127 カーソル右 移 動

KEY_DOWN 0x0128 カーソル下 移 動

KEY_LEFT_SHIFT 0x1125 Shift キーを押 しながらカーソル左 移 動

KEY_UP_SHIFT 0x1126 Shift キーを押 しながらカーソル上 移 動

KEY_RIGHT_SHIFT 0x1127 Shift キーを押 しながらカーソル右 移 動

KEY_DOWN_SHIFT 0x1128 Shift キーを押 しながらカーソル下 移 動

KEY_INSERT 0x012D 挿入

KEY_HELP 0x012F ヘルプ

KEY_F1 0x0170 F1

KEY_F2 0x0171 F2

46
 Chapter: 3 参照情報

キー コード キー コード
キーの説 明
(CitectSCADA ラベル) (16進 数 )

KEY_F3 0x0172 F3

KEY_F4 0x0173 F4

KEY_F5 0x0174 F5

KEY_F6 0x0175 F6

KEY_F7 0x0176 F7

KEY_F8 0x0177 F8

KEY_F9 0x0178 F9

KEY_F10 0x0179 F10

KEY_F11 0x017A F11

KEY_F12 0x017B F12

KEY_F13 0x017C F13

KEY_F14 0x017D F14

KEY_F15 0x017E F15

KEY_F16 0x017F F16

KEY_F1_SHIFT 0x1170 シフト F1

KEY_F2_SHIFT 0x1171 シフト F2

KEY_F3_SHIFT 0x1172 シフト F3

KEY_F4_SHIFT 0x1173 シフト F4

KEY_F5_SHIFT 0x1174 シフト F5

KEY_F6_SHIFT 0x1175 シフト F6

KEY_F7_SHIFT 0x1176 シフト F7

47
Chapter: 3 参照情報

キー コード キー コード
キーの説 明
(CitectSCADA ラベル) (16進 数 )

KEY_F8_SHIFT 0x1177 シフト F8

KEY_F9_SHIFT 0x1178 シフト F9

KEY_F10_SHIFT 0x1179 シフト F10

KEY_F11_SHIFT 0x117A シフト F11

KEY_F12_SHIFT 0x117B シフト F12

KEY_F13_SHIFT 0x117C シフト F13

KEY_F14_SHIFT 0x117D シフト F14

KEY_F15_SHIFT 0x117E シフト F15

KEY_F16_SHIFT 0x117F シフト F16

KEY_F1_CTRL 0x2170 コント ロールF1

KEY_F2_CTRL 0x2171 コント ロールF2

KEY_F3_CTRL 0x2172 コント ロールF3

KEY_F4_CTRL 0x2173 コント ロールF4

KEY_F5_CTRL 0x2174 コント ロールF5

KEY_F6_CTRL 0x2175 コント ロールF6

KEY_F7_CTRL 0x2176 コント ロールF7

KEY_F8_CTRL 0x2177 コント ロールF8

KEY_F9_CTRL 0x2178 コント ロールF9

KEY_F10_CTRL 0x2179 コント ロールF10

KEY_F11_CTRL 0x217A コント ロールF11

KEY_F12_CTRL 0x217B コント ロールF12

48
 Chapter: 3 参照情報

キー コード キー コード
キーの説 明
(CitectSCADA ラベル) (16進 数 )

KEY_F13_CTRL 0x217C コント ロールF13

KEY_F14_CTRL 0x217D コント ロールF14

KEY_F15_CTRL 0x217E コント ロールF15

KEY_F16_CTRL 0x217F コント ロールF16

KEY_A_SHIFT 0x1041 シフト A

KEY_B_SHIFT 0x1042 シフト B

KEY_C_SHIFT 0x1043 シフト C

KEY_D_SHIFT 0x1044 シフト D

KEY_E_SHIFT 0x1045 シフト E

KEY_F_SHIFT 0x1046 シフト F

KEY_G_SHIFT 0x1047 シフト G

KEY_H_SHIFT 0x1048 シフト H

KEY_I_SHIFT 0x1049 シフト I

KEY_J_SHIFT 0x104A シフト J

KEY_K_SHIFT 0x104B シフト K

KEY_L_SHIFT 0x104C シフト L

KEY_M_SHIFT 0x104D シフト M

KEY_N_SHIFT 0x104E シフト N

KEY_O_SHIFT 0x104F シフト O

KEY_P_SHIFT 0x1050 シフト P

KEY_Q_SHIFT 0x1051 シフト Q

49
Chapter: 3 参照情報

キー コード キー コード
キーの説 明
(CitectSCADA ラベル) (16進 数 )

KEY_R_SHIFT 0x1052 シフト R

KEY_S_SHIFT 0x1053 シフト S

KEY_t_SHIFT 0x1054 シフト T

KEY_U_SHIFT 0x1055 シフト U

KEY_V_SHIFT 0x1056 シフト V

KEY_W_SHIFT 0x1057 シフト W

KEY_X_SHIFT 0x1058 シフト X

KEY_Y_SHIFT 0x1059 シフト Y

KEY_Z_SHIFT 0x105A シフト Z

KEY_A_CTRL 0x2041 コント ロールA

KEY_B_CTRL 0x2042 コント ロールB

KEY_C_CTRL 0x2043 コント ロールC

KEY_D_CTRL 0x2044 コント ロールD

KEY_E_CTRL 0x2045 コント ロールE

KEY_F_CTRL 0x2046 コント ロールF

KEY_G_CTRL 0x2047 コント ロールG

KEY_H_CTRL 0x2048 コント ロールH

KEY_I_CTRL 0x2049 コント ロールI

KEY_K_CTRL 0x204B コント ロールK

KEY_L_CTRL 0x204C コント ロールL

KEY_M_CTRL 0x204D コント ロールM

50
 Chapter: 3 参照情報

キー コード キー コード
キーの説 明
(CitectSCADA ラベル) (16進 数 )

KEY_N_CTRL 0x204E コント ロールN

KEY_O_CTRL 0x204F コント ロールO

KEY_P_CTRL 0x2050 コント ロールP

KEY_Q_CTRL 0x2051 コント ロールQ

KEY_R_CTRL 0x2052 コント ロールR

KEY_S_CTRL 0x2053 コント ロールS

KEY_T_CTRL 0x2054 コント ロールT

KEY_U_CTRL 0x2055 コント ロールU

KEY_V_CTRL 0x2056 コント ロールV

KEY_W_CTRL 0x2057 コント ロールW

KEY_X_CTRL 0x2058 コント ロールX

KEY_Y_CTRL 0x2059 コント ロールY

KEY_Z_CTRL 0x205A コント ロールZ

KEY_A_ALT 0x4041 オルタネート A

KEY_B_ALT 0x4042 オルタネート B

KEY_C_ALT 0x4043 オルタネート C

KEY_D_ALT 0x4044 オルタネート D

KEY_E_ALT 0x4045 オルタネート E

KEY_F_ALT 0x4046 オルタネート F

KEY_G_ALT 0x4047 オルタネート G

KEY_H_ALT 0x4048 オルタネート H

51
Chapter: 3 参照情報

キー コード キー コード
キーの説 明
(CitectSCADA ラベル) (16進 数 )

KEY_I_ALT 0x4049 オルタネート I

KEY_J_ALT 0x404A オルタネート J

KEY_K_ALT 0x404B オルタネート K

KEY_L_ALT 0x404C オルタネート L

KEY_M_ALT 0x404D オルタネート M

KEY_N_ALT 0x404E オルタネート N

KEY_O_ALT 0x404F オルタネート O

KEY_P_ALT 0x4050 オルタネート P

KEY_Q_ALT 0x4051 オルタネート Q

KEY_R_ALT 0x4052 オルタネート R

KEY_S_ALT 0x4053 オルタネート S

KEY_T_ALT 0x4054 オルタネート T

KEY_U_ALT 0x4055 オルタネート U

KEY_V_ALT 0x4056 オルタネート V

KEY_W_ALT 0x4057 オルタネート W

KEY_X_ALT 0x4058 オルタネート X

KEY_Y_ALT 0x4059 オルタネート Y

KEY_Z_ALT 0x405A オルタネート Z

キーを定 義 するには
l Shift キーには、キー値 に 0x1000 を加 算 。
l Ctrl キーには、キー値 に 0x2000 を加 算 。
l Alt キーには、キー値 に 0x4000 を加 算 。
上 記 定 義 のキーは、標 準 の IBM 互 換 のキーです。

52
 Chapter: 3 参照情報

注 : インクルード プロジェクト を変 更 しないでください。インクルード プロジェクト への修 正 内

容 は、CitectSCADA を再 インスト ールしたり、アップグレード すると消 失 します。

定 義 済 みラベル
このセクションでは、インクルード プロジェクト で定 義 済 みのラベルについて説 明 します。
ラベル データベース
インクルード プロジェクト で定 義 済 みの名 前 と数 式 を定 義 しています。

名前 数式 コメント

__DATE__ $1 コンパイル日 付

__DB__ $4 コンパイラ データ

ベース名

__FIELD__ $6 コンパイラ フィールド

名

__ファイル__ $2 コンパイラ ファイル名

__LINE__ $3 コンパイラ ライン番

号

__RECORD__ $5 コンパイラ レコード

番号

__TIME__ $0 コンパイル時 刻

_BLANK_ NULL 定 義

AlarmFirstCatRec(hCat,nType,hArea=-1) _AlarmQueryFirstRec 領 域 でのAlarm

(hCat,nType,hArea,0) Cat Rec入 手

AlarmFirstPriRec(hPri,nType,hArea=-1) _AlarmQueryFirstRec 領 域 でのAlarm Pri

(hPri,nType,hArea,1) Rec入 手

_AlarmQueryNextRec 領 域 でのAlarm
AlarmNextCatRec(hRec,hCat,nType,hArea=- (hRec,hCat,nType,hArea,0) Cat Rec入 手
1)

_AlarmQueryNextRec 領 域 でのAlarm Pri

AlarmNextPriRec(hRec,hPri,nType,hArea=- (hRec,hPri,nType,hArea,1) Rec入 手
1)

53
Chapter: 3 参照情報

ANIMATE 2 表 示 モード 2

ANM_ARRAY 16 配 列 モードでのアニ
メーション シンボル

ANSI_CHARSET 0 ANSI 文 字 セット

Arg1 GetGlbStr(0) キーボード引 数 1

Arg2 GetGlbStr(1) キーボード引 数 2

Arg3 GetGlbStr(2) キーボード引 数 3

Arg4 GetGlbStr(3) キーボード引 数 4

Arg5 GetGlbStr(4) キーボード引 数 5

Arg6 GetGlbStr(5) キーボード引 数 6

Arg7 GetGlbStr(6) キーボード引 数 7

Arg8 GetGlbStr(7) キーボード引 数 8

ArgValue1 StrToValue(Arg1) 引 数 1 の値 を取 得

Assert(arg) IF NOT (arg) THEN _Assert アサーション プロセ

(#arg, __ファイル__, __LINE__); ス
END

BAD_HANDLE -1 不 正 なハンドル

BORDER 2 枠 線 のみ

BORDER_3D 1 3D 透 明 ボタン

CreateControlObject _CreateControlObject
(sCls,sName,x1,y1,x2,y2,sEventCls="") (sCls,sName,x1,y1,x2,y2, CreateControlObject
sEventCls) デフォルト イベント
クラス

DateDay(time) _TimeSub(time,3) 時 刻 から日 付 を取

得

DateDayMonth(time) _TimeSub(time,10) 月 末 日 を取 得

54
 Chapter: 3 参照情報

DateMonth(time) _TimeSub(time,5) 時 刻 から月 を取 得

DateWeekDay(time) _TimeSub(time,4) 時 刻 から週 日 を取

得

DELETE_ANM 000 アニメーション削 除

DevFirst(hDev) DevSeek(hDev,0) Offset=0 の

DevSeek

_DspButton(hAn,UK,sText, 表 示 ボタン
DspButton(hAn,UK=0,sText,hFont=0,nW=0, hFont,nW,nH,DK,RK,nM)
nH=0,DK=0,RK=0,nM=0)

DspButtonFn(hAn,UF=0,sText,hFont=0, _DspButtonFn(hAn,UF,sText, ボタンを表 示

nW=0,nH=0,DF=0,RF=0,nM=0) hFont,nW,nH,DF,RF,nM)

DspSym(hAn,sSym,mode=0) _DspSym(hAn,sSym,mode) シンボル表 示

DspSymAnm(hAn,s1,s2=0,s3=0,s4=0, _DspSymAnm マルチ シンボル表

s5=0,s6=0,s7=0,s8=0) (hAn,s1,s2,s3,s4,s5,s6,s7,s8,0,- 示
"")

DspSymAnmEx(hAn,mode,s1,s2=0, _DspSymAnm(hAn,s1,s2,s3,s4, モード付 き

s3=0,s4=0, s5,s6,s7,s8,mode,s9) DspSymAnm
s5=0,s6=0,s7=0,s8=0,s9=0)

EVEN_P 2 偶 数 パリティ

Exec(sText,mode=1) _Exec(sText,mode) Exec プログラム、デ

フォルト から標 準 へ

FALSE 0 ブール値 、偽

FlashColourState() StrToInt(PageInfo(18)) ブール値 としてのフラ

ッシュ色 のマルチス
テート

GetBlueValue(PackedRGB) ((PackedRGB / 65536) BITAND 容 量 圧 縮 RGB 色

255) の青 コンポーネント
を取 得

GetGreenValue(PackedRGB) ((PackedRGB / 256) BITAND 容 量 圧 縮 RGB 色

255) の緑 コンポーネント
を取 得

GetRedValue(PackedRGB) (PackedRGB BITAND 255) 容 量 圧 縮 RGB 色

の赤 コンポーネント

55
Chapter: 3 参照情報

を取 得

GetVar(sTag,sField) $7 変 数 フィールド デー
タ取 得

GetVarDef(sTag,sField,sDefault) $10 定 義 されている場

合 、変 数 フィールド
データ取 得

GetVarStr(sTag,sField) $8 str として変 数 フィー

ルド データ取 得

GetVarStrDef(sTag,sField,sDefault) $11 定 義 されている場

合 、str として変 数
フィールド データ取
得

GRAY_ALL 3 ボタン全 体 をグレー

にする

GRAY_HIDE 4 グレーになっている
時 、オプションを非
表示

GRAY_PART 2 テキスト /シンボルを

隠 しグレーにする

GRAY_SUNK 1 テキスト /シンボルを

隠す

IFDEF(sTag,sTrue,sFalse) $9 マクロが定 義 されて

いる場 合 、インライ
ンにする

InAnimationCycle() StrToInt(PageInfo(19)) ブール値 としてのア

ニメーション サイクル

InCommunicationsCycle() StrToInt(PageInfo(20)) ブール値 としての通

信 サイクル

KeyDown() KeyMove(4) カーソルを下 へ移 動

KeyLeft() KeyMove(1) カーソルを左 へ移 動

KeyReplay() _KeyReplay(1) キー リプレイ - 最 後

のキー

KeyReplayAll() _KeyReplay(0) キー リプレイ - すべ

56
 Chapter: 3 参照情報

てのキー

KeyRight() KeyMove(2) カーソルを右 へ移 動

KeyUp() KeyMove(3) カーソルを上 へ移 動

NONE 0 パリティなし

NORMAL 0 ノーマル ボタン

ODD_P 1 奇 数 パリティ

OVERLAP 1 表 示 モード 1

PackedRGB(Red,Green,Blue) (Red + Green * 256 + Blue * コンポーネント から

65536) 容 量 圧 縮 RGB を
作成

PlotInfo(hPlot,nType,sInput="") _PlotInfo(hPlot,nType,sInput) プロット システムにつ

いての情 報 を取 得

Print(sText,nMode=0) デバイスに印 刷 出
DevPrint(DevCurr(),sText,nMode) 力

PrintLn(sText) DevPrint(DevCurr(),sText,1) デバイスに印 刷 出

力 、改 行

Pulse(arg) arg = TRUE; Sleep(2); arg = 変 数 をパルスする

FALSE;

RAboveUCL 8192

RBelowLCL 16384

ROutsideCL 4096

_ マクロをシャット ダウ
Shutdown(sDest="",sProject="",nMode=1) Shutdown(sDest,sProject,nMode) ン

SOFT 0 表 示 モード 0

TableMath(Table, Size, Command, _TableMath(Table, Size, タブ上 の数 学 的 操

mode=0) Command,mode) 作

57
Chapter: 3 参照情報

TARGET 3 画 面 ターゲット

_Wave(4,p,lo,hi,off) ランダム波 のテスト

TestRandomWave(p=60,lo=0,hi=100,off=0)

TestSawWave(p=60,lo=0,hi=100,off=0) _Wave(3,p,lo,hi,off) のこぎり波 のテスト

TestSinWave(p=60,lo=0,hi=100,off=0) _Wave(0,p,lo,hi,off) sin 波 のテスト

_Wave(1,p,lo,hi,off) 正 方 波 のテスト
TestSquareWave(p=60,lo=0,hi=100,off=0)

_Wave(2,p,lo,hi,off) 三 角 波 のテスト
TestTriangWave(p=60,lo=0,hi=100,off=0)

TimeHour(time) _TimeSub(time,0) 時 刻 から時 間 数 を

取得

TimeMidNight(time) _TimeSub(time, 7) 深 夜 に時 刻 を抽 出

TimeMin(time) _TimeSub(time,1) 時 刻 から分 を取 得

TimeSec(time) _TimeSub(time,2) 時 刻 から秒 を取 得

TimeSecond(time) _TimeSub(time, 2) 時 刻 から秒 を取 得

TimeYearDay(time) _TimeSub(time, 8)

Toggle(arg) arg = NOT arg; 変 数 を設 定 /削 除

TRN_EVENT 2 イベント ト レンド

TRN_PERIODIC 1 周 期 ト レンド

TRN_PERIODIC_EVENT 3 周 期 イベント ト レン
ド

TRUE 1 ブール値 、真

UnitControl(IODev,Type,Data)
IODeviceControl(IODev,Type,Data)

58
 Chapter: 3 参照情報

UnitInfo(IODev,Type) IODeviceInfo(IODev,Type)

UnitStats() IODeviceStats()

UserCreate(s1,s2,s3,s4,s5="",pG="", _UserCreate(s1,s2,s3,s4,s5, 権 限 を持 つ新 ユー
p1="",p2="",p3="",p4="",p5="",p6="", pG,p1,p2,p3,p4,p5,p6,p7,p8) ザを作 成
p7="",p8="")

WRITE_ON_DRAG 1 スライダーの書 き込
みモード

WRITE_ON_DROP 0 スライダーの書 き込
みモード

XAboveUCL 4

XBelowLCL 8

XDownTrend 64

XErratic 512

XFreak 1

XGradualDown 256

XGradualUp 128

XMixture 2048

XOutsideCL 2

XOutsideWL 16

XStratification 1024

XUpTrend 32

注 :インクルード プロジェクト を変 更 しないでください。インクルード プロジェクト への修 正 内

容 は、CitectSCADA を再 インスト ールしたり、アップグレード すると消 失 します。

59
Chapter: 3 参照情報

ASCII/ANSI 文 字 コード 一 覧
コード 表 は、Latin 1 の ANSI 文 字 セット を示 しています。0～ 31 のコード は制 御 コード です。
標 準 ASCII コード は 32～ 127 (10進 数 ) で、使 用 される ANSI 文 字 セット に関 わらず、共 通
です。160～ 255 (10進 数 ) の残 りのコード は、ANSI 文 字 セット が使 用 される言 語 により異 なり
ます。

シンボル 10進 数 Hex

{NUL} 0 00

{SOH} 1 01

{STX} 2 02

{ETX} 3 03

{EOT} 4 04

{ENQ} 5 05

{ACK} 6 06

{BEL} 7 07

{BS} 8 08

{HT} 9 09

{LF} 10 0A

{VT} 11 0B

{FF} 12 0C

{CR} 13 0D

{SO} 14 0E

{SI} 15 0F

{DLE} 16 10

60
 Chapter: 3 参照情報

{DC1} 17 11

{DC2} 18 12

{DC3} 19 13

{DC4} 20 14

{NAK} 21 15

{SYN} 22 16

{ETB} 23 17

{CAN} 24 18

{EM} 25 19

{SUB} 26 1A

{ESC} 27 1B

{FS} 28 1C

{GS} 29 1D

{RS} 30 1E

{US} 31 1F

{SPC} 32 20

! 33 21

" 34 22

# 35 23

$ 36 24

% 37 25

& 38 26

61
Chapter: 3 参照情報

' 39 27

( 40 28

) 41 29

* 42 2A

+ 43 2B

, 44 2C

- 45 2D

. 46 2E

/ 47 2F

0 48 30

1 49 31

2 50 32

3 51 33

4 52 34

5 53 35

6 54 36

7 55 37

8 56 38

9 57 39

: 58 3A

; 59 3B

< 60 3C

62
 Chapter: 3 参照情報

= 61 3D

> 62 3E

? 63 3F

@ 64 40

A 65 41

B 66 42

C 67 43

D 68 44

E 69 45

F 70 46

G 71 47

H 72 48

I 73 49

J 74 4A

K 75 4B

L 76 4C

M 77 4D

N 78 4E

O 79 4F

P 80 50

Q 81 51

R 82 52

63
Chapter: 3 参照情報

S 83 53

T 84 54

U 85 55

V 86 56

W 87 57

X 88 58

Y 89 59

Z 90 5A

[ 91 5B

\ 92 5C

] 93 5D

^ 94 5E

_ 95 5F

` 96 60

a 97 61

b 98 62

c 99 63

d 100 64

e 101 65

f 102 66

g 103 67

h 104 68

64
 Chapter: 3 参照情報

i 105 69

j 106 6A

k 107 6B

l 108 6C

m 109 6D

n 110 6E

o 111 6F

p 112 70

q 113 71

r 114 72

s 115 73

t 116 74

u 117 75

v 118 76

w 119 77

x 120 78

y 121 79

Z 122 7A

{ 123 7B

| 124 7C

} 125 7D

~ 126 7E

65
Chapter: 3 参照情報

{Delete} 127 7F

128 80

129 81

‚ 130 82

ƒ 131 83

„ 132 84

... 133 85

† 134 86

‡ 135 87

ˆ 136 88

‰ 137 89

Š 138 8A

< 139 8B

Π140 8C

141 8D

142 8E

143 8F

144 90

` 145 91

' 146 92

" 147 93

" 148 94

66
 Chapter: 3 参照情報

· 149 95

- 150 96

- 151 97

˜ 152 98

™ 153 99

š 154 9A

> 155 9B

œ 156 9C

157 9D

158 9E

Ÿ 159 9F

{NBSP} 160 A0

¡ 161 A1

¢ 162 A2

£ 163 A3

¤ 164 A4

¥ 165 A5

¦ 166 A6

§ 167 A7

¨ 168 A8

© 169 A9

ª 170 AA

67
Chapter: 3 参照情報

« 171 AB

172 AC

¯ 173 AD

® 174 AE

¯ 175 AF

° 176 B0

± 177 B1

² 178 B2

³ 179 B3

´ 180 B4

µ 181 B5

182 B6

· 183 B7

¸ 184 B8

¹ 185 B9

º 186 BA

» 187 BB

¼ 188 BC

½ 189 BD

¾ 190 BE

¿ 191 BF

À 192 C0

68
 Chapter: 3 参照情報

Á 193 C1

 194 C2

à 195 C3

Ä 196 C4

Å 197 C5

Æ 198 C6

Ç 199 C7

È 200 C8

É 201 C9

Ê 202 CA

Ë 203 CB

Ì 204 CC

Í 205 CD

Î 206 CE

Ï 207 CF

Ð 208 D0

Ñ 209 D1

Ò 210 D2

Ó 211 D3

Ô 212 D4

Õ 213 D5

Ö 214 D6

69
Chapter: 3 参照情報

× 215 D7

Ø 216 D8

Ù 217 D9

Ú 218 DA

Û 219 DB

Ü 220 DC

Ý 221 DD

Þ 222 DE

ß 223 DF

à 224 E0

á 225 E1

â 226 E2

ã 227 E3

ä 228 E4

å 229 E5

æ 230 E6

ç 231 E7

è 232 E8

é 233 E9

ê 234 EA

ë 235 EB

ì 236 EC

70
 Chapter: 3 参照情報

í 237 ED

î 238 EE

ï 239 EF

ð 240 F0

ñ 241 F1

ò 242 F2

ó 243 F3

ô 244 F4

õ 245 F5

ö 246 F6

÷ 247 F7

ø 248 F8

ù 249 F9

ú 250 FA

û 251 FB

ü 252 FC

ý 253 FD

þ 254 FE

ÿ 255 FF

フォーマット フィールド
このセクションでは、以 下 について説 明 します。

71
Chapter: 3 参照情報

l アラーム表 示 フィールド
l アラーム サマリー フィールド
l コマンド フィールド

アラーム表 示 フィールド
以 下 に一 覧 表 示 されているフィールド のいずれか、または、アラーム サマリーのフィールド を使
用 して、アラーム表 示 (アラーム カテゴリを参 照 ) およびアラーム ログ デバイス (アラーム表 示 の
設 定 を参 照 ) を設 定 できます:

フィールド 名 説明

{Tag,n} アラーム タグ

注 :タグフィールドが長 い名 前 (最 大 79 文 字 ) をサポート するように設 定 さ

れている場 合 、アラーム表 示 で重 なって表 示 されることがあります。長 い名 前
が予 測 される場 合 は、表 示 に小 さいフォント を使 用 してください。

{TagEx,n} クラスタ名 のプリフィックスのついたアラーム タグ

注 :TagExフィールドが長 い名 前 (最 大 79 文 字 ) をサポート するように設

定 されている場 合 、アラーム表 示 で重 なって表 示 されることがあります。長 い
名 前 が予 測 される場 合 は、表 示 に小 さいフォント を使 用 してください。

{AlarmType,n} アラーム タイプ (文 字 列 )、ローカライズできません。値

は:Digital、Analog、Advanced、Multi-Digital、Argyle Analog、Time
Stamped、Time Stamped Digital、Time Stamped Analog。

{TypeNum,n} アラームタイプ番 号 (AlarmType を使 用 して代 わりに文 字 列 の値 を取 得 し

ます)。値 は:

-1 無 効
0 デジタル
1 アナログ
2 高機能
3 マルチデジタル
4 ArgAna
5 ユーザーイベント
6 タイムスタンプ
7 ハードウェア
8 タイムスタンプ デジタル
9 タイムスタンプ アナログ

{AlmComment,n} [アラーム プロパティ] ダイアログ ボックスの [コメント ] フィールドに入 力 された

テキスト 。

{Cluster,n} クラスタ名

72
 Chapter: 3 参照情報

フィールド 名 説明

{CUSTOM1,n} 設 定 しているアラーム カスタム フィールド。

{CUSTOM2,n}
{CUSTOM3,n}
{CUSTOM4,n}
{CUSTOM5,n}
{CUSTOM6,n}
{CUSTOM7,n}
{CUSTOM8,n}

{Name,n} アラーム名

注 ：名 前 フィールドが長 い名 前 (最 大 79 文 字 ) をサポート するように設 定

されている場 合 、アラーム表 示 で重 なって表 示 されることがあります。長 い名
前 が予 測 される場 合 は、表 示 に小 さいフォント を使 用 してください。

{Native_Name,n} 式 によるアラーム名

注 ：Native_Nameフィールドが長 い名 前 (最 大 79 文 字 ) をサポート す
るように設 定 されている場 合 、アラーム表 示 で重 なって表 示 されることがあり
ます。長 い名 前 が予 測 される場 合 は、表 示 に小 さいフォント を使 用 してくださ
い。

{Desc,n} アラームの説 明

{Native_Desc,n} ネイティブ言 語 (母 国 語 )でのアラーム説 明

{Category,n} アラーム カテゴリ

{Help,n} ヘルプ ページ

{Area,n} エリア

{Priv,n} 権限

{Priority,n} アラーム カテゴリーの優 先 順 位

{Type,n} アラームのタイプ、または条 件 ：
ACKNOWLEDGED
CLEARED
DISABLED
UNACKNOWLEDGED

{LocalTimeDate,n} アラームの日 付 および時 刻 形 式 ："yyyy-mm-dd hh:mm:ss[.ttt]"

{Time,n} アラームの状 態 が変 化 した時 刻 (hh:mm:ss)。(このフィールドをアラームが

確 認 された時 刻 に使 用 するには、[Alarm]SetTimeOnAckパラメータを設
定 します)。

73
Chapter: 3 参照情報

フィールド 名 説明

{Date,n} アラームの状 態 が変 化 した日 付 (dd:mm:yyyy)。使 用 するフォーマット

が、パラメータ [ALARM]ExtendedDate で変 更 できることに注 意 してくださ
い。

{DateExt,n} 拡 張 フォーマット による、アラームの状 態 が変 化 した日 付 。

{State,n} アラームの現 在 の状 態 。このフィールドはアラーム表 示 にのみ使 用 できます。

アラーム サマリーには使 用 できません。
オン
オフ

{Millisec,n} {Time,n} フィールドにミリ秒 を追 加 します。

{High,n} 上 限 アラームをト リガする値 。

{HighHigh,n} 上 上 限 アラームをト リガする値 。

{Low,n} 下 限 アラームをト リガする値 。

{LowLow,n} 下 下 限 アラームをト リガする値 。

{Rate,n} 変 化 率 アラームをト リガする値 。

{Deviation,n} 偏 差 アラームをト リガする値 。

{Deadband,n} 不感帯

{Format,n} 変 数 タグの表 示 フォーマット 。

{Value,n} アナログ変 数 の現 在 の値 。

{State,n} アラームの現 在 の状 態 。このフィールドはアラーム表 示 にのみ使 用 できます。

アラーム サマリーには使 用 できません。
偏差
率
下限
下下限
上限
上上限
クリア済 み

{ErrDesc,n} プロト コル (通 信 ) エラーに関 連 するテキスト 文 字 列 。このフィールドはハード

ウェア エラーにのみ関 連 し、検 出 されたエラーが何 であれ、エラーに関 連 する
追 加 の説 明 を含 みます (例 えば、エラーがデバイスに関 連 する場 合 はデバイ
ス名 が、Cicode 関 数 に関 連 する場 合 は関 数 名 が、I/O デバイスに関 連 す
る場 合 は I/O デバイスの警 告 メッセージがそれぞれ返 されます)。

74
 Chapter: 3 参照情報

フィールド 名 説明

{ErrPage,n} アラームに関 連 するページ、デバイスなど。

{LogState,n} アラームが伝 送 された最 後 の状 態 です。(これは、アラームをデバイスにログを

とるときに役 立 ちます。

{State_desc, n} 特 定 の状 態 に対 して設 定 された説 明 (例 えば、正 常 や停 止 など)。この説

明 は、マルチデジタル アラームのプロパティを設 定 する際 に入 力 します。

{Paging,n} アラームがページされるべきかどうかを示 します。その値 がTRUE(真 )ならば、

アラームはページされます。デフォルト 値 はFALSEです。アラームのページング
プロパティを参 照 してください。

{PagingGroup, n} アラームが属 するページング グループを示 します。最 大 80文 字 。

{AcqDesc,n} アラーム取 得 エラーのテキスト 形 式 表 記 。

{AcqError, n} アラーム取 得 エラーの数 値 形 式 表 記 。

nは、表 示 フィールド のサイズを指 定 します。

注：
l 上 記 のフィールド のどれでも任 意 のタイプのアラーム用 に表 示 できま
す。特 定 のアラーム タイプに適 用 できない場 合 は、ゼロまたは空 の文
字 列 が表 示 されます。
l アラーム値 が表 示 されるフィールド (n) より長 い場 合 は、途 中 で切 り捨
てられ、#OVR (「フォーマット 幅 を超 えました」)警 告 メッセージに置 き換
えられます。
l サマリー ページには｛SumState｝を使 用 します。デバイスの状 態 をログ
するには、{LogState} を使 用 します。State はアラームの現 在 の状
態 、SumState はアラームが発 生 した場 合 の状 態 、Log State は変 化
時 におけるアラームの状 態 です。
関連項目
アラーム サマリー フィールド

アラーム サマリー フィールド

次 のうち任 意 のフィールド を任 意 の組 み合 わせで使 用 して、アラーム サマリーとアラーム サマ
リー デバイスの表 示 の形 式 を設 定 できます。
アラームの特 定 のカテゴリー全 体 に対 してアラーム サマリーをフォーマット するには、[アラーム カ
テゴリーのプロパティ] ダイアログ ボックスの [サマリー フォーマット ] フィールド でフィールド 名 を指 定
します。

75
Chapter: 3 参照情報

また、[Alarm]DefSumFmtパラメータを使 用 してアラーム サマリーをフォーマット することもできます。

特 に、アラーム サマリーのフォーマット が同 じ場 合 に使 用 できます。

フィールド 名 説明

{UserName,n} ログオンし、アラームに対 して何 らかのアクション (例 えば、アラームの確 認

や無 効 化 など) を実 行 したユーザーの名 前 (ユーザー名 )。アラームが最
初 に起 動 した時 、ユーザー名 は「システム」にセット されることに注 意 してく
ださい。

{FullName,n} ログオンし、アラームに対 して何 らかのアクション (例 えば、アラームの確 認

や無 効 化 など) を実 行 したユーザーの完 全 な名 前 (フルネーム)。アラー
ムが最 初 に起 動 した時 、ユーザーのフルネームは「システム」にセット され
ることに注 意 してください。

{UserDesc,n} ユーザー イベント に関 連 するテキスト 。

{OnDate,n} アラームがアクティブになった日 付 。

{OnDateExt,n} 拡 張 フォーマット で、アラームがアクティブになった日 付 (dd/mm/yyyy)。

{OffDate,n} アラームが通 常 のマルチステート に戻 った日 付 。

{OffDateExt,n} 拡 張 フォーマット で、アラームが通 常 のマルチステート に戻 った日 付

(dd/mm/yyyy)。

{OnTime,n} アラームがアクティブになった時 刻 。

{OffTime,n} アラームが通 常 のマルチステート に戻 った時 刻 。

{DeltaTime,n} OnDate/OnTimeとOffDate/OffTime 間 の秒 数 による時 間 差 。

{OnMilli,n} アラームがアクティブになった時 刻 にミリ秒 を追 加 します。

{OffMilli,n} アラームが通 常 のマルチステート に戻 った時 刻 にミリ秒 を追 加 します。

{AckTime,n} アラームが確 認 された時 刻 。

{AckDate,n} アラームが確 認 された日 付 。

{AckDateExt,n} 拡 張 フォーマット による、アラームが確 認 された日 付 (dd/mm/yyyy)。

{SumState,n} アラームが発 生 した際 に、そのマルチステート を記 述 します。

{SumDesc,n} アラーム サマリーの説 明 。

{SumType,n} アラーム サマリーのタイプ (アラーム「タイプ」と同 様 )。値

76
 Chapter: 3 参照情報

フィールド 名 説明

は、ACKNOWLEDGED、CLEARED、DISABLED、UNACKNOWLEDG-
ED

{Native_SumDesc,n} ネイティブ言 語 による、アラーム サマリーの説 明 。

{Comment,n} ランタイム時 にオペレーターがアラーム サマリーのエント リーに追 加 するコメ

ント 。コメント は、AlarmComment() 関 数 を使 用 して指 定 します。

{Native_Comment,n} ネイティブ言 語 による、ランタイム時 にオペレーターがアラーム サマリーのエ

ント リーに追 加 するコメント 。

nは、表 示 フィールドのサイズを指 定 します。

注 ：アラーム サマリーには、[マルチステート ]以 外 の任 意 のアラーム表 示 フィールド を追 加 で

きます。

関連項目
アラーム サマリーの表 示 順 序 の変 更

コマンド フィールドの使 用
次 のフィールド (または組 み合 わせ) を使 用 して、コマンド のログ デバイスをフォーマット します。

フィールド 名 説明

{UserName,n} コマンドが発 行 されたときに、ログオンしていたユーザの名 前

(UserName)。

{FullName,n} コマンドが発 行 されたときに、ログオンしていたユーザのフルネーム

(FullName)。

{Time,n} コマンドが発 行 されたときの時 刻 (短 いフォーマット ) (hh:mm)。

{TimeLong,n} コマンドが発 行 されたときの時 刻 (長 いフォーマット ) (hh:mm:ss)。

{Date,n} コマンドが発 行 されたときの日 付 (短 いフォーマット ) (dd:mm:yy)。

{DateLong,n} コマンドが発 行 されたときの日 付 (長 いフォーマット ) (日 月 年 )。

{DateExt,n} コマンドが発 行 されたときの日 付 (拡 張 フォーマット )(dd:mm:yyyy)。

77
Chapter: 3 参照情報

{Page,n} コマンドが発 行 されたときに表 示 されるページ。

{MsgLog,n} (コマンド レコードの) メッセージ ログのプロパティとして送 信 されるメッセー

ジ。

キーボード コマンド のみに、(コマンド フィールドの) 次 のフィールドを使 用 できます。

{Arg1,n} 先 頭 のキーボード コマンドの引 数 (ある場 合 )。

{Arg2,n} 2番 目 のキーボード コマンドの引 数 (ある場 合 )。

...

{Arg8,n} 8番 目 のキーボード コマンドの引 数 (ある場 合 )。

{Native_MsgLog,n} (コマンド レコードの)メッセージ ログのプロパティとして送 られたメッセージの

母 国 語 バージョン。

nは、表 示 フィールドのサイズを指 定 します。

例 えば、次 のようにデバイスを設 定 できます。

名前 KeyLog

フォーマット {Date,9} {MsgLog,27} {Arg1,3} by {FullName,11}

ここで、キーボード コマンド ( オブジェクト 、ページ、またはシステム) を次 のような設 定 で作 りま

す。

ログ デバイス KeyLog

キー シーケンス ### ENTER

ログ メッセージ 密 度 のセット ポイント の変 更 先

次 のような出 力 結 果 になります。「99年 1月 1日 に、Timothy Leeが密 度 セット ポイント を123に

変 更 しました」。

エラー メッセージ
CitectSCADA には、2 種 類 のプロト コル ド ライバ エラーがあります。

78
 Chapter: 3 参照情報

l 一般
l ド ライバ固 有
一 般 エラーは、ハード ウェア エラー 0-31で、すべてのプロト コルに共 通 します。
ド ライバには、それぞれ固 有 のエラーもあり、ハード ウェア アラーム システムでは認 識 できない独
自 のエラーです。ド ライバは、その固 有 のエラーを I/O サーバが認 識 できる一 般 エラーに変 換 し
ます。
例 えば、ド ライバが動 作 不 能 になった場 合 、ド ライバ固 有 のエラーと対 応 する一 般 エラーの両
方 があります。

注 : ド ライバ エラー メッセージなど、デバイス ド ライバの実 装 に関 連 する情 報 については、[

ド ライバ参 照 ヘルプ] を参 照 してください。

関連項目
汎 用 ド ライバ エラー
ド ライバ固 有 エラー
ド ライバ参 照 ヘルプの使 用

プロト コル一 般 エラー

CitectSCADA には、2種 類 のプロト コル ド ライバー エラーがあります。一 般 およびプロト コル固
有 エラーです。一 般 エラーは、ハード ウェア エラー 0-31で、すべてのプロト コルに共 通 します。
プロト コル ド ライバーには、それぞれ固 有 のエラーもあり、ハード ウェア アラーム システムでは認
識 できない独 自 のエラーです。ド ライバーは、その固 有 のエラーをI/Oサーバが認 識 できる一 般
エラーに変 換 します。例 えば、ド ライバーに問 題 があった場 合 、プロト コル固 有 のエラーと対 応
する一 般 エラーの両 方 があります。

汎 用 エラー
この表 では、汎 用 プロト コル エラーを説 明 します。

エラー番 号 エラー タイト ル 説明

1 範 囲 外 のアドレ 存 在 しないデバイス アドレスに対 し、要 求 が発 生 しました。例 えば、

スです。 レジスターが 200 しかない I/O デバイスで、レジスター番 号 4000
の読 み取 りが試 行 されました。変 数 タグデータベースを確 認 しエラー
を探 します。

2 キャンセルされ ドライバで処 理 中 に、サーバーがコマンドを取 り消 しました。ドライバ

たコマンド のコマンド処 理 に時 間 がかかりすぎたことが考 えられます。ドライバが
指 定 制 限 時 間 内 に応 答 できなかった場 合 は、CitectSCADA によ
りコマンドがキャンセルされます。制 限 時 間 は、タイムアウト 期 間 とタ
イムアウト が起 きる毎 にコマンドを再 送 する回 数 のによるものです。
プロト コルのTimeoutおよびRetry パラメータで、これらの値 を大 きく

79
Chapter: 3 参照情報

エラー番 号 エラー タイト ル 説明

することができます。WatchTime パラメータも確 認 して、ドライバが

I/O デバイスへのリンクをチェックする頻 度 を確 かめます。通 信 エラー
も確 認 します。

3 不 明 なデータ プロト コルがサポート しないデータ型 を指 定 する要 求 が出 されまし

型 た。このエラーは通 常 の操 作 では発 生 しません。コンピュータを再
起 動 して、ドライバおよびハードウェアをすべてリセット してください。
問 題 が解 決 しない場 合 は、この製 品 の技 術 サポート にご連 絡 くだ
さい。自 分 でプロト コル ドライバを作 成 した場 合 、コンパイラ指 定 と
ドライバのデータベースの不 一 致 が原 因 でこのエラーが発 生 しま
す。

4 不 明 なフォーマ 例 えば、浮 動 小 数 点 のアドレスに、無 効 な浮 動 小 数 点 で表 され

ット た数 を書 き込 もうとした場 合 など、書 き込 み要 求 が無 効 データを
含 んでいます。CitectSCADAデータベースをチェックします。

5 不 明 なコマンド サーバーから、ドライバが認 識 しないコマンドが送 信 されました。この

エラーは通 常 の操 作 では発 生 しません。コンピュータを再 起 動 し
て、ドライバおよびハードウェアをすべてリセット してください。問 題 が
解 決 しない場 合 は、この製 品 の技 術 サポート にご連 絡 ください。

6 不 良 あるいは 通 信 チャネルに問 題 があるため、送 信 されたデータのエラーを引 き

不 適 切 な応 答 起 こしています。通 信 チャネル ハードウェアの設 定 を調 べてくださ
い。例 えば、送 信 側 と受 信 側 の間 のパリティ, ボー レート 、スト ップ
ビット 、またはデータ ビット が一 致 していない場 合 があります。I/O デ
バイスの設 定 、CitectSCADA ポート およびボード フォームのフィー
ルド データが同 じであるかチェックします。

7 I/Oデバイスから I/O デバイスが、読 み取 り、書 き込 み要 求 に応 答 しません。ドライバ

応 答 なし が I/O デバイスにコマンドを送 信 しましたが、I/O デバイスが制 限 時
間 内 に応 答 しません。これは、通 信 損 失 の最 初 のサインです。I/O
デバイスがサーバに正 しく接 続 され、電 源 が入 っているかどうかを確
認 します。このエラーは、タイムアウト 時 間 が短 すぎる場 合 にもおこり
ます。プロト コルのTimeoutパラメータの時 間 を長 くしてみてくださ
い。遅 延 パラメータを変 更 することにより、応 答 を受 ける時 刻 と次 の
コマンドを送 信 する時 刻 の時 間 差 を延 長 することができます。

8 一 般 的 なエ CitectSCADA は I/O デバイス間 との通 信 を確 立 しましたが、I/O

ラー デバイスがプロト コルのエラーを検 知 しました。このエラーは、通 信 リ
ンクの障 害 、または(I/O デバイス内 の)ラダー ロジック のエラーにより
発 生 する可 能 性 があります。

解決方法：

1. I/O デバイスが正 しく動 作 していることを確 認 します。

2. 通 信 ケーブルが (送 信 側 、受 信 側 の両 方 で) 正 しく接 続 されて

いることを確 認 します。

3. エキスプレス通 信 ウィザードを使 用 して、I/Oデバイスの設 定 ( 特

80
 Chapter: 3 参照情報

エラー番 号 エラー タイト ル 説明

に、アドレスおよび特 別 オプション のフィールド) と推 奨 設 定 およ

びI/Oデバイスの設 定 が一 致 していることを確 認 します。

4. シリアル通 信 を行 っている場 合 、エキスプレス通 信 ウィザードを

使 用 して、ポート の設 定 ( 特 に、ボー レート 、スト ップ ビット 、データ
ビット およびパリティ) と推 奨 設 定 およびI/Oデバイスの設 定 が一 致
していることを確 認 します。

5. ハードウェア アラーム ページを表 示 し、プロト コル エラーが表 示

されていることに注 目 してください。

6. I/O デバイス、ネット ワークおよび通 信 ボードに添 付 されているマ

ニュアルを参 考 にして、エラーが発 生 した場 所 を突 き止 めます。

7. I/O デバイスのラダー ロジックにエラーがあるかどうかを確 認 しま

す。

8. コンピュータ セット アップ ウィザードを実 行 します。

9. プロジェクト をコンパイルし直 し、CitectSCADAランタイムを開 始

します。

9 書 き込 み先 が 無 許 可 修 正 から保 護 されている位 置 に、書 込 み操 作 が行 われよ

プロテクト されて うとしました。書 込 み操 作 を許 可 するため、この位 置 へのアクセス権
います。 を変 更 してください。

10 ハードウェア エ 通 信 チャンネル、サーバー、または I/O デバイス ハードウェアのいず

ラー れかに問 題 が発 生 しました。すべてのハードウェアコンポーネント を
調 べてください。コマンドまたはデータ要 求 が処 理 されていません。
サーバーの稼 動 が通 常 の動 作 でない恐 れがあります。

11 I/O デバイス警 サーバーと I/O デバイス間 の通 信 リンクは正 しく機 能 しています

告 が、I/O デバイスがプログラム モードであるなどの警 告 状 態 が発 生
しました。I/O デバイスが正 しいモードになっていることを確 認 してくだ
さい。

12 I/O デバイスが I/O デバイスがオフライン モードで外 部 通 信 を妨 害

オフラインで交
信不可 解決方法：

1. I/O デバイスが正 しく動 作 していることを確 認 します。

2. 通 信 ケーブルが切 れていないことを確 認 します。

3. 通 信 ケーブルが (送 信 側 、受 信 側 の両 方 で) 正 しく接 続 されて

いることを確 認 します。

4. シリアル通 信 を行 っている場 合 、通 信 ケーブルとヘルプ システム

の図 表 が一 致 していることを確 認 します。

5. エキスプレス通 信 ウィザードを使 用 して、I/Oデバイスの設 定 ( 特

81
Chapter: 3 参照情報

エラー番 号 エラー タイト ル 説明

に、アドレスおよび特 別 オプション のフィールド) と推 奨 設 定 およ

びI/Oデバイスの設 定 が一 致 していることを確 認 します。

6. シリアル通 信 を行 っている場 合 、エキスプレス通 信 ウィザードを

使 用 して、ポート の設 定 ( 特 に、ボー レート 、データ ビット 、スト ップ
ビット およびパリティ) と推 奨 設 定 およびI/Oデバイスの設 定 が一 致
していることを確 認 します。

7. コンピュータ セット アップ ウィザードを実 行 します。

8. Citect.ini ファイルの次 の内 容 をチェックします。

[IOSERVER]

Server=1

Name=<name>

ここで、

<name> は、CitectSCADAプロジェクト に設 定 されたサーバー名

です。(カスタム設 定 で、サーバー名 を確 認 します。)

9. プロジェクト をコンパイルし直 し、CitectSCADAランタイム システ

ムを開 始 します。

注 ：スタンバイ I/O デバイスが設 定 されている場 合 、このエラーが発

生 すると、スタンバイ I/O デバイスが起 動 します。I/O デバイスがオフ
ラインになった時 点 で、現 行 のコマンドまたはデータ要 求 が完 了 して
いません。

13 ドライバ ソフト ウ 内 部 ソフト ウェアエラーがドライバ内 で発 生 しました。このエラーは通

ェア エラー 常 の操 作 では発 生 しません。コンピュータを再 起 動 して、ドライバお
よびハードウェアをすべてリセット してください。問 題 が解 決 しない場
合 は、この製 品 の技 術 サポート にご連 絡 ください。

14 ユーザー アクセ 権 限 のないのユーザーが情 報 へアクセスしようとしました。ユーザー

ス違 反 のアクセス権 をチェックして下 さい。

15 メモリー不 足 - サーバーがメモリー不 足 で、操 作 を継 続 することができません。バッ

致命的 ファおよびキューの割 り当 てを少 なくするか、サーバー コンピュータの
メモリーを拡 張 します。コマンドまたはデータ要 求 が処 理 されていま
せん。

16 バッファなしで継 割 り当 てられる使 用 可 能 な通 信 バッファがないか、コンピュータのメ

続不可能 モリー不 足 です。サーバーの性 能 が落 ちたことが考 えられますが、
続 けて実 行 することができます。メモリーを拡 張 します。

17 バッファ不 足 警 このエラーは、一 時 的 な高 負 荷 によりに起 きることがありますが、特

告 に何 の影 響 もありません。このエラーが頻 繁 に発 生 する場 合 は、通
信 バッファの数 を増 やしてください。

82
 Chapter: 3 参照情報

エラー番 号 エラー タイト ル 説明

18 ドライバーへのコ ドライバに送 信 されたコマンドが多 すぎます。

マンド数 が多 す
ぎます

19 ドライバ応 答 な サーバーがドライバからのレスポンスを受 け取 っていません。このエ

し ラーは通 常 の操 作 では発 生 しません。コンピュータを再 起 動 して、
ドライバおよびハードウェアをすべてリセット してください。問 題 が解 決
しない場 合 は、この製 品 の技 術 サポート にご連 絡 ください。

20 開 かれているチ 各 ドライバがサポート する通 信 チャネルは数 チャネルのみです。制

ャネル数 が多 限 を超 過 しました。このエラーは、サーバーから不 自 然 なかたちで
過 ぎます 終 了 し、再 起 動 した場 合 に起 こりえます。コンピュータを再 起 動 し
て、ドライバおよびハードウェアをすべてリセット してください。問 題 が
解 決 しない場 合 は、この製 品 の技 術 サポート にご連 絡 ください。コ
マンドまたはデータ要 求 は完 了 していません。

21 チャネルがオフラ 通 信 チャネルは現 在 オフラインであり、通 信 することができません。

インで通 信 不 サーバが通 信 チャネルを初 期 化 できないか、実 行 中 にチャンルがオ
可能 フラインになりました。チャンネルのハードウェアにエラーがないかを確
認 します。このエラーが起 きると、このチャンネルに接 続 されている
I/O デバイスはすべてオフラインと見 なされ、スタンバイ I/O デバイス
が起 動 します。コマンドまたはデータ要 求 は完 了 していません。

22 チャネルがまだ サーバーが、開 いていないチャネルと通 信 しようとしました。コンピ

開 かれていない ュータを再 起 動 して、ドライバおよびハードウェアをすべてリセット して
ください。問 題 が解 決 しない場 合 は、この製 品 の技 術 サポート にご
連 絡 ください。コマンドまたはデータ要 求 は完 了 していません。

23 チャネルがまだ サーバーは、初 期 化 されていないチャネルで通 信 しようとしていま

初 期 化 されて す。このエラーは通 常 の操 作 では発 生 しません。コンピュータを再
いない 起 動 して、ドライバおよびハードウェアをすべてリセット してください。
問 題 が解 決 しない場 合 は、この製 品 の技 術 サポート にご連 絡 くだ
さい。コマンドまたはデータ要 求 は完 了 していません。

24 チャンネル毎 の チャンネルに接 続 されている I/O デバイスが多 すぎます。このエラー

I/O デバイスが は通 常 の操 作 では発 生 しません。コマンドまたはデータ要 求 は完
多 すぎる 了 していません。コンピュータを再 起 動 して、ドライバおよびハードウ
ェアをすべてリセット してください。問 題 が解 決 しない場 合 は、この製
品 の技 術 サポート にご連 絡 ください。

25 データがまだ有 要 求 されたデータの処 理 中 で、データは適 当 な時 に戻 されます。こ

効 になっていな のエラーは、I/O デバイスからデータを取 得 するために、複 雑 な通
い 信 を行 う必 要 のあるドライバのみに起 こります。この警 告 は無 視 して
ください。

26 コマンドのキャン サーバーがコマンドをキャンセルしようとしましたが、ドライバがコマンド
セルができな を認 識 できませんでした。このエラーは通 常 の操 作 では発 生 しませ
い。 ん。コンピュータを再 起 動 して、ドライバおよびハードウェアをすべてリ
セット してください。問 題 が解 決 しない場 合 は、この製 品 の技 術 サ

83
Chapter: 3 参照情報

エラー番 号 エラー タイト ル 説明

ポート にご連 絡 ください。

27 スタンバイ ユニ 通 信 が、プライマリ I/O デバイスからスタンバイI/Oデバイスに切 り替

ット が使 用 可 わりました。「ホット 」な切 り替 えが行 われた後 、サーバがこのメッセー
能 になった ジを戻 します。プライマリ I/O デバイスのエラーを解 決 してください。

28 メッセージ オー 応 答 バッファより応 答 が長 いです。シリアル通 信 ドライバでこのエ

バーラン ラーが発 生 した場 合 、文 字 化 けした文 字 が受 信 されている可 能
性 があります。通 信 リンクおよびドライバのボーレート をチェックしてく
ださい。

29 不 良 ユーザー 無 効 な特 殊 オプションが設 定 されているなどの、設 定 エラーがあり

パラメータ ます。

30 スタンバイ I/O スタンバイ I/O デバイスでエラーが起 きました。スタンバイ I/O デバイ

デバイスのエ スのエラーを解 決 してください。
ラー

31 I/Oサーバーか I/Oサーバーに送 信 された要 求 の1つまたは2つが、制 限 時 間 内 に

らのタイムアウト 完 了 しませんでした。I/Oサーバーがオフラインか、I/Oサーバーが要
要求 求 を完 了 するための時 間 がかかりすぎています。PLC通 信 リン
ク、PLC制 限 時 間 、PLC再 送 、ネット ワーク通 信 を確 認 してくださ
い。このエラーは、ネット ワークがない場 合 にも起 こります。例 え
ば、I/O サーバーがコント ロール クライアント . 問 題 が解 決 しない場
合 は、[LAN] TimeOut パラメータを増 やしてください。デフォルト の
タイムアウト は 8000 ミリ秒 です。

32 リモート ユニット リモート I/O デバイスが接 続 されていません。

と通 信 できない

274 無 効 な引 数 が 無 効 な引 数 が、Cicode 関 数 に渡 されました。これは、一 般 エラー

渡 された メッセージで、関 数 に渡 された引 数 が範 囲 外 、または無 効 な場 合
に生 成 されます。関 数 に渡 された引 数 の値 をチェックします。引 数
がオペレータから直 接 入 力 される場 合 、正 しい引 数 が関 数 に渡 さ
れたかチェックする必 要 があります。

281 サーバーが見 つ 指 定 した CitectSCADA サーバーが見 つかりません。サーバーが起

からない 動 していないか、ネット ワークに通 信 上 の問 題 が発 生 しています。
ネット ワークが正 しく設 定 されており、クライアント とサーバーで同 じ
サーバー名 を使 用 しているかチェックしてください。

418 サーバーのタイ 必 要 なサーバー タイプがサーバーに設 定 されていません。

プがクラスタ上
にない

448 レコード サイズ RDB ファイルに、不 正 なサイズのレコードが含 まれています。

の不 一 致

84
 Chapter: 3 参照情報

エラー番 号 エラー タイト ル 説明

451 サーバーの以 指 定 したサーバーで既 に再 読 み込 みが実 行 中 のた

前 の再 読 み込 め、ServerReload Cicode 関 数 を使 用 した再 読 み込 みを開 始 で
み中 きません。

452 無 効 な RCB RDB ファイルが未 対 応 のバージョンのソフト ウェアを使 用 してコンパ

バージョン イルされました。

454 Cicode ライブラ メモリの Cicode ライブラリのタイムスタンプが、ディスク上 の Cicode

リのタイムスタン ライブラリのタイムスタンプと異 なります。Cicode ライブラリが異 なる
プが一 致 しませ 可 能 性 があります。
ん

519 リモート Cicode RPC リモート 呼 び出 しを行 う Cicode 呼 び出 しが、要 求 する結 果

呼 び出 しが中 が返 される前 に中 断 されました。
断

520 アラーム カテゴリが カテゴリ番 号 が有 効 な範 囲 外 ( 0 から 16376 を含 む) です。

範囲外

521 データ参 照 レ ART サーバーの再 読 み込 み中 に、レコードが削 除 されました。

コードの削 除

522 ト レンド アーカイ ト レンド レコードのアーカイブ プロパティが、起 動 または再 読 み込 み

ブ プロパティの 中 に変 更 されました。
不一致

523 アラーム優 先 順 位 カテゴリの優 先 順 位 が有 効 な範 囲 外 ( 0 から 256 を含 む) です。

が範 囲 外

汎 用 ド ライバ エラー
次 のエラーは、すべての CitectSCADAド ライバの一 般 的 なエラーです。ド ライバ エラーは
CitectSCADA が解 釈 する前 に、汎 用 エラーにマッピングされる必 要 があります。

エラー 説明

GENERIC_ADDRESS_RANGE_ERROR 存 在 しないデバイス アドレスに対 し、要 求 が発 生 しまし

た。例 えば、デバイス内 に200のレジスタしかないのに、
(0x0001 | SEVERITY_ERROR) レジスタナンバー4000を読 み込 もうとした場 合 です。

GENERIC_CMD_CANCELED ドライバの処 理 中 に、サーバーがコマンドをキャンセルし

ました。これは、ドライバがコマンドを処 理 するのに時 間
(0x0002 | SEVERITY_ERROR) がかかりすぎた際 に発 生 します。ドライバのタイムアウト
時 間 と再 試 行 回 数 を確 認 していください。

GENERIC_INVALID_DATA_TYPE プロト コルによってサポート されていないデータ型 に対 する

85
Chapter: 3 参照情報

(0x0003 | SEVERITY_ERROR) 要 求 が発 生 しました。このエラーは通 常 の操 作 では発

生 しません。

GENERIC_INVALID_DATA_FORMAT 要 求 は無 効 なデータを含 んでいます。例 えば、無 効 な

浮 動 小 数 点 数 値 が有 する浮 動 小 数 点 数 アドレスへ
(0x0004 | SEVERITY_ERROR) 書 き込 まれるなど。CitectSCADAデータベースをチェック
します。

GENERIC_INVALID_COMMAND サーバーは認 識 できなかったドライバへコマンドを送 信 し

ました。このエラーは通 常 の操 作 では発 生 しません。
(0x0005 | SEVERITY_ERROR)

GENERIC_INVALID_RESPONSE 通 信 チャネルは正 常 に作 動 していません、そのため送

信 データにエラーが生 じています。
(0x0006 | SEVERITY_ERROR)

GENERIC_UNIT_TIMEOUT デバイスは読 み込 みおよび書 き込 み要 求 に応 答 してい

ません。ドライバはデバイスにコマンドを送 信 しましたが、
(0x0007 | SEVERITY_ERROR) デバイスはタイムアウト 期 間 内 に応 答 しませんでした。

GENERIC_GENERAL_ERROR マップされていないドライバの特 定 のエラーは、汎 用 エ

ラーとしてレポート されます。使 用 されているプロト コルに
(0x0008 | SEVERITY_ERROR) 挙 げられているプロト コル特 有 のエラーをご参 照 くださ
い。

GENERIC_WRITE_PROTECT 無 許 可 修 正 から保 護 されている位 置 に、書 込 み操 作

が行 われようとしました。書 込 み操 作 を許 可 するため、こ
(0x0009 | SEVERITY_ERROR) の位 置 へのアクセス権 を変 更 してください。

GENERIC_HARDWARE_ERROR 通 信 チャネル、サーバーまたはデバイス ハードウェアが正

常 に作 動 していません。すべてのハードウェアコンポーネ
(0x000A | SEVERITY_ ント を調 べてください。サーバーの作 動 を点 検 して、適
UNRECOVERABLE) 切 に作 動 しているか検 査 してください。

GENERIC_UNIT_WARNING サーバーとデバイス間 の通 信 リンクは正 常 に機 能 してい

ます。しかし、デバイスではエラーが発 生 または作 動 して
(0x000B | SEVERITY_WARNING) いないマルチステート です。例 えば、デバイスがプログラム
モードにあるといったような場 合 など。

GENERIC_UNIT_OFFLINE デバイスはオフラインモードであり、外 部 通 信 を阻 止 して
います。このエラーはスタンバイユニット をアクティブマルチ
(0x000C | SEVERITY_SEVERE) ステート にします。CitectSCADAはユニット の再 初 期 化
を試 みます。

GENERIC_SOFTWARE_ERROR 内 部 ソフト ウェアエラーがドライバ内 で発 生 しました。この

エラーは通 常 の操 作 では発 生 しません。
(0x000D | SEVERITY_SEVERE)

GENERIC_ACCESS_VIOLATION 権 限 のないのユーザーが情 報 へアクセスしようとしまし

た。ユーザーのアクセス権 をチェックして下 さい。

86
 Chapter: 3 参照情報

(0x000E| SEVERITY_ERROR)

GENERIC_NO_MEMORY サーバーまたはドライバがメモリ不 足 しているため、実 行

を継 続 することができません。バッファおよびキュー割 り
(0x000F | SEVERITY_ 当 てを最 小 化 し、サーバーコンピュータのメモリー (物 理
UNRECOVERABLE) または仮 想 メモリ) を拡 張 してください。

GENERIC_NO_BUFFERS 割 り当 て可 能 な通 信 バッファが残 っていません。サー

バーの性 能 が落 ちたことが考 えられますが、操 作 を継 続
(0x0010 | SEVERITY_ERROR) することは可 能 です。通 信 バッファの数 を増 やしてくださ
い。

GENERIC_LOW_BUFFERS このエラーは、一 時 的 な高 負 荷 時 に発 生 する場 合 が

ありますが、悪 影 響 はありません。このエラーが頻 繁 に
(0x0011| SEVERITY_WARNING) 発 生 する場 合 は、通 信 バッファの数 を増 やしてください。

GENERIC_TOO_MANY_COMMANDS ドライバに送 信 されたコマンドが多 すぎます。

(0x0012| SEVERITY_WARNING)

GENERIC_DRIVER_TIMEOUT サーバーがドライバからのレスポンスを受 け取 っていませ

ん。このエラーは通 常 の操 作 では発 生 しません。
(0x0013 | SEVERITY_ERROR)

GENERIC_NO_MORE_CHANNELS それぞれのドライバは一 定 数 の通 信 チャネルのみをサ

ポート しています。制 限 を超 過 しました。コマンドまたは
(0x0014 | SEVERITY_SEVERE) データ要 求 は完 了 していません。

GENERIC_CHANNEL_OFFLINE 通 信 チャネルは現 在 オフラインであり、通 信 することがで

きません。サーバーが通 信 チャネルを初 期 化 することが
(0x0015 | SEVERITY_SEVERE) できない、またはチャネルが実 行 中 にオフラインになりまし
た。このチャネルを使 用 して接 続 されているすべてのデバ
イス (ユニット ) は、オフラインであると考 えられているた
め、これによってスタンバイデバイスがアクティブマルチス
テート になります。CitectSCADAによりチャネルの再 初
期 化 が試 行 されます。

(0x0016| SEVERITY_SEVERE) サーバーが開 いていないチャネルとの通 信 を試 行 しまし

た。
(0x0016| SEVERITY_SEVERE)

GENERIC_CHANNEL_NOT_INIT サーバーは、初 期 化 されていないチャネルで通 信 しよう

としています。このエラーは通 常 の操 作 では発 生 しませ
(0x0017 | SEVERITY_SEVERE) ん。コマンドまたはデータ要 求 は完 了 していません。エ
ラーが修 正 されない場 合 は、サポート にお問 い合 わせく
ださい。

GENERIC_TOO_MANY_UNITS チャネルに取 り付 けられたデバイスが多 すぎます。このエ

ラーは通 常 の操 作 では発 生 しません。
(0x0018 | SEVERITY_SEVERE)

87
Chapter: 3 参照情報

GENERIC_INVALID_DATA 要 求 されたデータは有 効 なフォーマット でないか、予 期

されたタイプではありません。
(0x0019 | SEVERITY_ERROR)

GENERIC_CANNOT_CANCEL サーバーがコマンドをキャンセルしようとしましたが、ドライ
バがコマンドを認 識 できませんでした。このエラーは通 常
(0x001A | SEVERITY_WARNING) の操 作 では発 生 しません。

GENERIC_STANDBY_ACTIVE 通 信 が、プライマリからスタンバイユニット へ切 り替 わりま

した。サーバーは、新 規 切 り替 えが発 生 した際 、このメッ
(0x001B | SEVERITY_WARNING) セージを戻 します。

GENERIC_MSG_OVERRUN 応 答 バッファより応 答 が長 いです。シリアル通 信 ドライバ

でこのエラーが発 生 した場 合 、文 字 化 けした文 字 が受
(0x001C | SEVERITY_ERROR) 信 される可 能 性 があります。通 信 のリンクと、ドライバの
ボー レート をチェックしてください。

GENERIC_BAD_PARAMETER 無 効 な特 殊 なオプションが設 定 されているなどの、設 定

エラーがあります。
(0x001D | SEVERITY_ERROR)

GENERIC_STANDBY_ERROR スタンバイユニット にエラーがあります。

(0x001E| SEVERITY_WARNING)

GENERIC_NO_RESPONSE 通 信 サーバーからの応 答 がありません。

(0x001F | SEVERITY_ERROR)

GENERIC_UNIT_REMOTE リモート ユニット (例 えば、ダイヤルアップI/Oデバイス) と

通 信 することができません。予 定 されたI/Oデバイスにの
(0x0020 | SEVERITY_ERROR) み使 用 されます。

GENERIC_GENERAL_WARNING ドライバは要 求 されたアクションを実 行 していますが、潜

在 的 な問 題 の存 在 を知 らせる必 要 があります。例 え
(0x0024 | SEVERITY_WARNING) ば、データが古 くなっていることを警 告 するためこれを使
用 する場 合 もあります。

プロト コル固 有 エラー

それぞれのプロト コルに、独 自 のエラーがいつくかありますが、最 初 の34のプロト コル固 有 エラー
は、すべてのプロト コルに標 準 的 なエラーです。上 記 のように、プロト コル固 有 エラーは、すべて
エラー番 号 1から31のエラーとして報 告 されます。これらのエラーには、それぞれ独 自 の (16進 法
の) 番 号 がありますが、表 記 法 としてのみ使 用 されます。

注 :プロト コル固 有 エラーは、各 プロト コルについて[プロト コル固 有 エラー] のヘルプ項 目 に

88
 Chapter: 3 参照情報

挙 げられています。エラーの詳 細 が突 き止 められない場 合 、I/Oデバイスに添 付 されている

マニュアルを参 照 してください。

エラー番 号 エラー タイト ル 説明

1 (0x01) 受 信 した文 字 を速 く処 理 受 信 した文 字 を速 く処 理 できません。ボー

できない レート を下 げるか、スピードの速 いコンピュー
タを使 います。エラーが続 く場 合 は、本 製 品
の技 術 サポート に連 絡 してください。

2 (0x02) パリティ エラー 受 信 したメッセージにパリティ エラーがありま

す。正 しいボー レート 、パリティ、スト ップ ビッ
ト 、およびデータ ビット が Citect ポート フ
ォームに指 定 されているかチェックしてくださ
い。このエラーの原 因 は、I/O デバイスへの
ケーブルが切 断 されているか、通 信 リンク上
のノイズが過 剰 である可 能 性 があります。

3 (0x03) 受 信 側 に故 障 が見 つかっ 受 信 側 に故 障 が見 つかりました。このエラー

た の原 因 は、I/O デバイスへのケーブルが切
断 されているため、または通 信 リンク上 のノイ
ズが過 剰 であるためである可 能 性 がありま
す。

4 (0x04) フレーミング エラー 間 違 ったボー レート が指 定 されている可 能

性 があります。正 しいボー レート が Citect
ポート フォームに指 定 されているかチェックし
てください。

5 (0x05) メッセージが長 すぎる I/O デバイスから受 信 したメッセージが長 過

ぎます。このエラーの原 因 は、I/O デバイスへ
のケーブルが切 断 されているため、または通
信 リンク上 のノイズが過 剰 であるためである
可 能 性 があります。エラーが続 く場 合 は、本
製 品 の技 術 サポート に連 絡 してください。

6 (0x06) 無 効 なチェックサム 受 信 したメッセージのチェックサムが計 算 値 と

一 致 しません。正 しいボー レート 、パリティ、
スト ップ ビット 、およびデータ ビット が Citect
ポート フォームに指 定 されているかチェックし
てください。このエラーの原 因 は、I/O デバイ
スへのケーブルが切 断 されているため、また
は通 信 リンク上 のノイズが過 剰 であるためで
ある可 能 性 があります。プロト コルのRetryパ
ラメータで、再 送 回 数 を増 やしてみることも
できます。

7 (0x07) テキスト の先 頭 がない 受 信 したメッセージにテキスト 先 頭 (STX)文

字 がありません。正 しいボー レート 、パリテ

89
Chapter: 3 参照情報

ィ、スト ップ ビット 、およびデータ ビット が

Citect ポート フォームに指 定 されているかチ
ェックしてください。このエラーの原 因 は、I/O
デバイスへのケーブルが切 断 されているた
め、または通 信 リンク上 のノイズが過 剰 であ
るためである可 能 性 があります。

8 (0x08) テキスト の終 わりがない 受 信 したメッセージにテキスト 終 了 (ETX)文

字 がありません。正 しいボー レート 、パリテ
ィ、スト ップ ビット 、およびデータ ビット が
Citect ポート フォームに指 定 されているかチ
ェックしてください。このエラーの原 因 は、I/O
デバイスへのケーブルが切 断 されているた
め、または通 信 リンク上 のノイズが過 剰 であ
るためである可 能 性 があります。

10 (0x0A) メッセージが送 信 できない CitectSCADA が、メッセージを発 信 できま

せん。このエラーの原 因 は、I/O デバイスへ
のケーブルが切 断 されているため、または通
信 リンク上 のノイズが過 剰 であるためである
可 能 性 があります。

11 (0x0B) シリアル ドライバがリセット で シリアル (COMxI、PCXI、または COMx) ド

きない ライバにエラーが発 生 しています。コンピュー
タを再 起 動 して、ドライバおよびハードウェア
をすべてリセット してください。

12 (0x0C) 要 求 の長 さの不 一 致 要 求 の長 さがドライバの要 求 する条 件 と一

致 しません。

15 (0x0F) サーバからのコマンドが無 サーバーからのコマンドが無 効 です。本 製 品

効 の技 術 サポート に連 絡 してください。

16 (0x10) ドライバにタイマー リソース ドライバにタイマー リソースが割 り当 てられま

が割 り当 てられない せん。本 製 品 の技 術 サポート に連 絡 してく
ださい。

17 (0x11) ドライバに指 定 したチャンネ デバイスに指 定 したチャンネルが多 すぎま

ルが多 すぎる す。本 製 品 の技 術 サポート に連 絡 してくださ
い。

18 (0x12) サーバからのチャンネル番 サーバからのチャンネル番 号 が開 きません。

号 が開 かない 本 製 品 の技 術 サポート に連 絡 してください。

19 (0x13) コマンドが取 り消 せない ドライバ コマンドが取 り消 せません。本 製 品

の技 術 サポート に連 絡 してください。

20 (0x14) チャンネルがオンラインでは チャンネルがオンラインではありません。このエ

ありません。 ラーの原 因 は、時 間 切 れが起 きているた
め、I/O デバイスへのケーブルが切 断 されて

90
 Chapter: 3 参照情報

いるため、または通 信 リンク上 のノイズが過

剰 であるためである可 能 性 があります。

21 (0x15) 時 間 切 れエラー 指 定 されたタイムアウト 時 間 内 にI/Oデバイ

スからの応 答 がありませんでした。このエラー
の原 因 は、I/O デバイスへのケーブルが切
断 されているため、または通 信 リンク上 のノイ
ズが過 剰 であるためである可 能 性 がありま
す。プロト コルのRetryパラメータで、再 送 回
数 を増 やしてみることができます。

22 (0x16) サーバからのI/Oデバイス番 サーバからのI/Oデバイス番 号 がアクティブで

号 がアクティブでないか範 ないか範 囲 外 にあります。本 製 品 の技 術 サ
囲外 ポート に連 絡 してください。

23 (0x17) I/Oデバイスがオンラインで Citect I/Oデバイス フォームで指 定 されてい

ない るI/Oデバイス アドレスが、I/Oデバイスに設
定 されている通 りであることを確 認 してくださ
い。

24 (0x18) サーバからのデータ型 がドラ サーバーからのデータ型 がドライバにはわかり

イバにわからない ません。本 製 品 の技 術 サポート に連 絡 して
ください。

25 (0x19) サーバからのI/Oデバイス型 サーバからのI/Oデバイス型 がドライバにわか

がドライバにわからない りません。本 製 品 の技 術 サポート に連 絡 し
てください。

26 (0x1A) チャンネルに指 定 されたI/O チャンネルに指 定 されたI/Oデバイスが多 す

デバイスが多 すぎる ぎます。本 製 品 の技 術 サポート に連 絡 してく
ださい。

27 (0x1B) ドライバに発 行 コマンドが多 ドライバに発 行 されたコマンドが多 すぎます。

すぎる 本 製 品 の技 術 サポート に連 絡 してください。

28 (0x1C) データ読 み取 り無 効 データの読 み取 りが無 効 です。本 製 品 の技

術 サポート に連 絡 してください。

29 (0x1D) コマンド取 り消 し ドライバ コマンドが取 り消 されました。本 製 品

の技 術 サポート に連 絡 してください。

30 (0x1E) アドレスが無 効 か範 囲 外 アクセスしようとしたアドレスに無 効 なデータ

型 があるか、範 囲 外 です。I/Oデバイスに有
効 なデータ型 およびアドレス範 囲 を使 用 して
いることを確 認 してください。

31 (0x1F) サーバからのデータの長 さ サーバーからのデータの長 さが正 しくありませ

が正 しくない ん。本 製 品 の技 術 サポート に連 絡 してくださ
い。

91
Chapter: 3 参照情報

32 (0x20) デバイスからのデータが読 み CitectSCADAが、I/Oデバイスからデータを

取 れない 読 み取 ることができません。本 製 品 の技 術
サポート に連 絡 してください。

33 (0x21) 指 定 したデバイスがない 指 定 したデバイスがありません。本 製 品 の技

術 サポート に連 絡 してください。

34 (0x22) 指 定 したデバイスが割 り込 指 定 したI/Oデバイスは割 り込 みの処 理 をサ

みをサポート しない ポート しません。中 断 をサポート しないハード
ウェア デバイスに、ボード フォーム、また
はPollTimeパラメータを0に設 定 して、割 り
込 みを指 定 しています。ボードに指 定 した割
り込 みを確 認 し、プロト コルのPollTimeパラ
メータを設 定 します。

標 準 ド ライバ エラー
次 のエラーは、すべてのド ライバに一 般 的 な下 位 レベルのエラーです。これらのエラーはすべて
汎 用 エラーにマップされるので、CitectSCADAはこれらを認 識 できます。これらのエラーに加 え
て、ほとんどのド ライバにも一 連 のド ライバ特 有 のエラーがあります。

エラー 説明

0 (0x00000000) エラー条 件 は存 在 しません。

NO_ERROR

1 (0x00000001) 送 信 された文 字 を十 分 な速 度 で受 信 することができません

でした。このエラーは、汎 用 エラー GENERIC_INVALID_
DRIVER_CHAR_OVERRUN RESPONSE にマップされます。

2 (0x00000002) 受 信 された文 字 のパリティ エラーです。このエラーは、汎 用

エラー GENERIC_INVALID_RESPONSE にマップされまし
DRIVER_CHAR_PARITY た。

3 (0x00000003) 受 信 側 に故 障 が見 つかりました。このエラーは、汎 用 エラー

GENERIC_INVALID_RESPONSE にマップされました。
DRIVER_CHAR_BREAK

4 (0x00000004) フレーム エラーです。ボー レート を確 認 してください。このエ

ラーは、汎 用 エラー GENERIC_INVALID_RESPONSE に
DRIVER_CHAR_FRAMING マップされました。

5 (0x00000005) デバイスから受 信 したメッセージが長 すぎます。このエラー

は、汎 用 エラーGENERIC_INVALID_RESPONSEにマップ
DRIVER_MSG_OVERRUN されました。

92
 Chapter: 3 参照情報

6 (0x00000006) 受 信 したメッセージのチェックサムが計 算 値 と一 致 しません。

エラーは汎 用 エラー GENERIC_INVALID_RESPONSE に
DRIVER_BAD_CRC マップされました。

7 (0x00000007) テキスト 先 頭 (STX)文 字 がありません。エラーは汎 用 エラー

GENERIC_INVALID_RESPONSE にマップされました。
DRIVER_NO_STX

8 (0x00000008) テキスト 終 了 (ETX)文 字 がありません。エラーは汎 用 エラー

GENERIC_INVALID_RESPONSE にマップされました。
DRIVER_NO_ETX

9 (0x00000009) ドライバーが初 期 化 されていません。このエラーは、汎 用 エ

ラー GENERIC_UNIT_OFFLINE にマップされました。
DRIVER_NOT_INIT

10 (0x0000000A) メッセージを送 信 できません。このエラーは、汎 用 エラー

GENERIC_UNIT_OFFLINE にマップされました。
DRIVER_BAD_TRANSMIT

11 (0X0000000B) シリアル ドライバをリセット できません。このエラーは、汎 用 エ

ラー GENERIC_CHANNEL_OFFLINE にマップされました。
DRIVER_CANNOT_RESET

12 (0X0000000C) 応 答 の長 さが正 しくありません。このエラーは、汎 用 エラー

GENERIC_GENERAL_ERROR にマップされました。
DRIVER_BAD_LENGTH

13 (0X0000000D) メッセージの長 さが短 かすぎます。このエラーは、汎 用 エラー

GENERIC_INVALID_RESPONSE にマップされました。
DRIVER_MSG_UNDERRUN

15 (0X0000000F) サーバーからのコマンドが無 効 です。このエラーは、汎 用 エ

ラー GENERIC_INVALID_COMMAND にマップされまし
DRIVER_INVALID_COMMAND た。

16 (0X00000010) ドライバ にタイマー リソースを割 り当 てできません。このエラー

は、汎 用 エラー GENERIC_HARDWARE_ERROR にマップ
DRIVER_NO_TIMER されました。

17 (0x00000011) デバイスに指 定 されたチャンネルが多 すぎます。このエラー

は、汎 用 エラー GENERIC_NO_MORE_CHANNELS にマ
DRIVER_NO_MORE_CHANNELS ップされました。

18 (0x00000012) サーバーからのチャンネル番 号 が開 けません。このエラーは、

汎 用 エラー GENERIC_BAD_CHANNEL にマップされまし
DRIVER_BAD_CHANNEL た。

19 (0x00000013) コマンドをキャンセルできません。このエラーは、汎 用 エラー

GENERIC_CANNOT_CANCEL にマップされました。

93
Chapter: 3 参照情報

DRIVER_CANNOT_CANCEL

20 (0x00000014) チャネルがオンラインではありません。このエラーは、汎 用 エ
ラー GENERIC_CHANNEL_OFFLINE にマップされました。
DRIVER_CHANNEL_OFFLINE

21 (0x00000015) ユーザ設 定 時 間 内 に応 答 が受 信 されませんでした。このエ

ラーは、汎 用 エラー GENERIC_UNIT_TIMEOUT にマップ
DRIVER_TIMEOUT されました。

22 (0x00000016) サーバーからのユニット 番 号 がアクティブでないか、または範

囲 外 です。このエラーは、汎 用 エラー GENERIC_UNIT_
DRIVER_BAD_UNIT OFFLINE にマップされました。

23 (0x00000017) ユニット がオンラインではありません。このエラーは、汎 用 エ

ラー GENERIC_UNIT_OFFLINE にマップされました。
DRIVER_UNIT_OFFLINE

24 (0x00000018) サーバーからのデータ型 がドライバにはわかりません。このエ

ラーは、汎 用 エラー GENERIC_INVALID_DATA_TYPE に
DRIVER_BAD_DATA_TYPE マップされました。

25 (0x00000019) サーバーからのユニット タイプがドライバにはわかりません。こ

のエラーは、汎 用 エラー GENERIC_INVALID_DATA_
DRIVER_BAD_UNIT_TYPE TYPE にマップされました。

26 (0x0000001A) チャネルに指 定 されたユニット が多 すぎます。このエラーは、

汎 用 エラー GENERIC_TOO_MANY_UNITS にマップされ
DRIVER_TOO_MANY_UNITS ました。

27 (0x0000001B) ドライバに発 行 されたコマンドが多 すぎます。このエラーが発

生 する可 能 性 があるのは、発 行 済 みのすべての読 み込 みと
DRIVER_TOO_MANY_COMMANDS 書 き込 みに、限 定 されたバージョンのドライバを実 行 している
場 合 です (例 えば、使 用 期 間 限 定 のドライバなどです)。こ
のエラーは、汎 用 エラー Generic Error GENERIC_TOO_
MANY_COMMANDS にマップされました。

29 (0x0000001D) コマンドがキャンセルされました。このエラーは、汎 用 エラー

GENERIC_COMMAND_CANCELLED にマップされました。
DRIVER_CMD_CANCELED

30 (0x0000001E) アドレス/長 さが範 囲 外 です。このエラーは、汎 用 エラー

GENERIC_ADDRESS_RANGE_ERROR にマップされまし
DRIVER_ADDRESS_RANGE_ た。
ERROR

31 (0x0000001F) サーバーからのデータの長 さが正 しくありません。このエラー

は、汎 用 エラー GENERIC_INVALID_RESPONSE にマッ
DRIVER_DATA_LENGTH_ERROR プされました。

94
 Chapter: 3 参照情報

32 (0x00000020) デバイスからデータを読 み込 めません。このエラーは、汎 用 エ

ラー GENERIC_INVALID_DATA にマップされました。
DRIVER_BAD_DATA

33 (0x00000021) 指 定 されたデバイスが存 在 しません。このエラーは、汎 用 エ

ラー GENERIC_HARDWARE_ERROR にマップされました。
DRIVER_DEVICE_NOT_EXIST

34 (0x00000022) 指 定 されたデバイスが割 り込 みをサポート していません。この

エラーは、汎 用 エラー GENERIC_HARDWARE_ERROR に
DRIVER_DEVICE_NO_INTERRUPT マップされました。

35 (0x00000023) ポート データベースの無 効 な特 殊 なオプションです。このエ

ラーは、汎 用 エラー GENERIC_BAD_PARAMETER にマッ
DRIVER_BAD_SPECIAL プされました。

36 (0x00000024) 変 数 に書 き込 みができません。このエラーは、汎 用 エラー

GENERIC_GENERAL_ERROR にマップされました。
DRIVER_CANNOT_WRITE

37 (0x00000025) ドライバがメモリ不 足 で、実 行 を継 続 できません。バッファと

キューの割 り当 てを最 小 化 するか、またはコンピュータのメモ
DRIVER_NO_MEMORY リ (物 理 または仮 想 メモリ) を拡 張 します。このエラーは、汎
用 エラー GENERIC_NO_MEMORY にマップされました。

95
Chapter: 3 参照情報

96
Chapter: 4 CtAPI関数
CitectSCADAAPI
CTAPI は、DLL インターフェースを通 じてCitectSCADA I/O 変 数 タグへのアクセスを可 能 にし
ます。これにより、サード パーティ開 発 者 はC言 語 (またはその他 の言 語 ) でアプリケーションを作
成 でき、I/Oデバイスへの読 み書 きも可 能 になります。
ファイルはctapi.dll ctapi.libおよびctapi.hを必 要 として、これらは [bin] ディレクト リにあります。
リモート コンピュータでのCTAPIの使 用
CitectSCADAをインスト ールせずにリモート コンピュータでCTAPIを使 用 するには、次 のファイル
を [bin] ディレクト リからお使 いのリモート コンピュータにコピーする必 要 があります。ctapi.dll、ct_
ipc.dll、cteng32.dll、ctres32.dll、ctutil32.dll、および CiDebugHelp.dll。リモート コンピュータ
からCTAPIに接 続 する前 に、プロジェクト のユーザーを定 義 する必 要 があるのでご注 意 くださ
い。
Windows 2000でのCTAPIの使 用
CTAPIを使 用 している Windows 2000上 でアプリケーションを実 行 する場 合 、次 のファイルを
[bin] ディレクト リからアプリケーションと同 じディレクト リにコピーする必 要 があります。ct_ipc.dll
、cidebughlp.dll 、dbghelp.dll および ctutil32.dll 。
上 位 互 換 性 の問 題
CitectSCADAの16ビット バージョンにはド キュメント に記 載 されていないAPIが用 意 されていま
す。16ビット APIは32ビット 環 境 と互 換 性 がありません。今 回 、新 しいAPIはこれを置 き換 えるよ
うに実 装 されました。また、CTAPIは従 来 のCT_VARおよ CTUSER APIとは互 換 性 がありませ
ん。32ビット 環 境 に変 更 が必 要 なため、CTAPIに互 換 性 を持 たせることはできません。アプリ
ケーションを古 いAPIから新 しいCTAPIに移 植 するために必 要 な変 更 はわずかです。
関連項目
I/Oポイント カウント
CtAPI同 期 操 作
CTAP 関 数 を使 用 したデータ読 み込 み
CitectSCADA または CitectSCADAド ライバからの CTAPI
エラー コード
デバッグ ト レース
関 数 リファレンス

97
Chapter: 4 CtAPI関数

I/Oポイント カウント
CTAPIを使 用 して読 み取 りまたは書 き込 みされている物 理 I/Oデバイス タグは、動 的 な
CitectSCADA ポイント としてカウント されます。このインターフェースの呼 び出 しによりポイント の
制 限 を越 えた場 合 は、その呼 び出 しは成 功 せず、動 的 ポイント は CitectSCADA にそれ以 上
割 り当 てられません。

注 : CitectSCADA のライセンスは使 用 したポイント 数 に基 づいています。お使 いのシステム

のすべてのタグがポイント カウント に追 加 される可 能 性 があります。このことを念 頭 において
システムの計 画 を適 切 に行 うことが重 要 です。そうしないと、ポイント 制 限 を超 えてしまう恐
れがあります。

ポイント 制 限 は、読 み取 り可 能 なI/Oデバイス アド レス (変 数 タグ) の最 大 数 であ

り、CitectSCADA ライセンスにより指 定 されています。CitectSCADA では、すべての I/O デバイ
ス アド レスを、ランタイムで動 的 にカウント します。この読 み取 りには、アラーム、ト レンド 、レポー
ト 、イベント 、ページ、スーパー ジニーで使 用 されるすべてのタグ、TagRead() およびTagWrite()
Cicode 関 数 の使 用 、DDE、ODBC、またはCTAPIを使 用 した読 み取 りまたは書 き込 みが含
まれます。
コンパイル時 の静 的 なポイント はカウント されません。
システムの実 行 中 は、スーパー ジニー、DDE、ODBC、または CTAPI は動 的 ポイント カウント
に追 加 される可 能 性 があります。
関連項目
CitectSCADA API同 期 操 作

CtAPI 同 期 操 作
CitectSCADA CTAPI では、同 期 および非 同 期 (または重 複 ) 操 作 の両 方 をサポート していま
す。ctCicode()、ctListRead()、およびctListWrite() の関 数 は、同 期 または非 同 期 で実 行 可
能 です。ctTagRead() および ctTagWrite() 関 数 は同 期 してのみで実 行 可 能 です。
関 数 が同 期 に実 行 される場 合 は、操 作 が完 了 するまで返 されません。つまり、スレッド の呼 び
出 しは、時 間 のかかる操 作 が終 了 するまで、無 期 限 でブロックされてしまいます。重 複 操 作 を
呼 び出 す関 数 の場 合 は、操 作 が完 了 していなくても直 ちに返 されます。これによって、時 間 の
かかる I/O 操 作 がバックグラウンド で実 行 されている間 に、呼 び出 しスレッド は他 のタスクを実
行 できます。例 えば、ひとつのスレッド が複 数 のハンド ルで同 時 に操 作 したり、同 じハンド ルで
同 時 に読 み取 りと書 込 み操 作 を行 ったりすることが可 能 です。オーバーラップされた操 作 の実
行 と完 了 を同 期 化 するために、呼 び出 しスレッド はctGetOverlappedResult() 関 数 または待
ち関 数 の 1 つを使 用 して、オーバーラップされた操 作 が完 了 する時 期 を判 断 しま
す。ctHasOverlappedIoCompleted() マクロを使 用 して操 作 を完 了 させることもできます。

98
 Chapter: 4 CtAPI関数

オーバーラップされた操 作 を実 行 するために関 数 を呼 び出 すには、呼 び出 しスレッド が

CTOVERLAPPED構 造 体 へのポインタを指 定 する必 要 があります。このポインタが NULL の
場 合 、関 数 が返 す値 が操 作 が完 了 したと誤 って表 示 する可 能 性 がありま
す。CTOVERLAPPED 構 造 体 には、自 動 リセット のイベント オブジェクト ではなく、手 動 による
リセット を行 うハンド ルが含 まれている必 要 があります。操 作 完 了 以 前 に I/O 関 数 への呼 び出
しが戻 されると、システムはイベント オブジェクト のマルチステート を非 通 知 に設 定 します。操 作
が完 了 すると、システムはイベント オブジェクト のマルチステート を通 知 済 みに設 定 します。
オーバーラップされた操 作 を実 行 するためにある関 数 が呼 び出 されても、関 数 が返 される前 に
操 作 が完 了 する場 合 があります。このことが起 こると、結 果 は操 作 が同 期 して実 行 されたもの
として扱 われます。操 作 が完 了 していない場 合 、関 数 の戻 り値 は FALSE( 偽 ) にな
り、GetLastError() 関 数 は ERROR_IO_PENDING を返 します。
スレッド は次 の2つのうちのいずれかの方 法 で重 複 操 作 を管 理 できます。
l ctGetOverlappedResult() 関 数 を使 用 してオーバーラップされた操 作 が完 了 するのを待 ち
ます。
l 待 ち関 数 のひとつから CTOVERLAPPED構 造 体 の手 動 リセット イベント オブジェクト にハ
ンド ルを指 定 し、待 ち関 数 が返 された後 で ctGetOverlappedResult() を呼 び出 しま
す。ctGetOverlappedResult() 関 数 が完 了 したオーバーラップされた操 作 の結 果 を返 し、
その情 報 に該 当 する関 数 には、転 送 された実 際 のバイト 数 を報 告 します。
複 数 のオーバーラップされた同 時 操 作 を実 行 する場 合 、呼 び出 しスレッド は、各 操 作 に対 し
て別 々 の手 動 リセット イベント オブジェクト を持 つ CTOVERLAPPED構 造 体 を指 定 する必
要 があります。オーバーラップされた操 作 のいずれかが完 了 するのを待 つために、スレッド は複 数
オブジェクト 待 ち関 数 の 1 つにすべての手 動 リセット イベント ハンド ルを待 ち条 件 として指 定 し
ます。複 数 オブジェクト 待 ち関 数 の戻 り値 がどの手 動 リセット イベント オブジェクト に通 知 され
たかを示 すことで、スレッド はどのオーバーラップされた操 作 が待 ち操 作 の完 了 を促 したかを判
断 できます。
ctCancelIO() 関 数 を使 用 している保 留 になっている非 同 期 操 作 をキャンセルできま
す。ctClose() を呼 び出 すと、保 留 になっている非 同 期 操 作 がキャンセルされます。
CTAP 関 数 を使 用 したデータ読 み込 み

CTAP 関 数 を使 用 したデータ読 み込 み
l I/Oタグ インターフェース
l タグ関 数
l リスト 関 数
l 配 列 サポート
l デジタル配 列 を読 み込 むときのビット シフト
関連項目
関 数 リファレンス

99
Chapter: 4 CtAPI関数

I/Oタグ インターフェース
CitectSCADA I/Oサーバーは、オンデマンド ベースで読 み取 るクライアント をベースに設 計 され
ています。CitectSCADAI/Oサーバーは、クライアント によってリクエスト された場 合 に、I/Oデバイ
スからI/Oタグを読 み取 ります。これによって I/Oデバイスへの負 荷 が軽 減 され、全 体 的 なシステ
ム パフォーマンスが向 上 します。
リアルタイム データへのクライアント インターフェースはより複 雑 です。クライアント は物 理 的 な
I/O サイクルが完 了 するのを待 ってからでないと、データを使 用 できません。クライアント は必 要
なデータを I/Oサーバーにリクエスト し数 秒 待 ちます。その間 に I/Oサーバーがリクエスト されたす
べてのデータを読 み取 ります。この設 計 は、CTAPI インターフェースの操 作 にも反 映 されていま
す。CTAPI を使 用 してタグの読 み取 るには、数 秒 間 かかります。このインターフェースを呼 び出
して設 計 の中 にこれを取 り入 れるかどうかは、呼 び出 し側 が判 断 します。
ポーリングのようなサービスを使 用 する必 要 がある場 合 は、ctList関 数 を使 用 します。
関連項目
タグ関 数

タグ関 数
データを読 み込 む方 法 で最 も簡 単 なのは、ctTagRead() 関 数 を使 用 する方 法 です。この関
数 は 1 つの変 数 値 を読 み込 み、フォーマット 済 みの換 算 された文 字 列 として結 果 を返 しま
す。

リスト 関 数
リスト 関 数 は、データの読 み取 りにおいて、タグベースのインターフェースよりも高 レベルなパフ
ォーマンスを提 供 します。リスト 関 数 はまた、重 複 する操 作 へのサポート も提 供 しています。
リスト 関 数 によってタグ グループが定 義 され、単 一 のリクエスト として読 み取 られます。リスト 関
数 は、フォーマット 済 みの換 算 されたデータにシンプルなタグ ベースのインターフェースを提 供 し
ます。複 数 のリスト を作 成 し、個 別 にコント ロール可 能 です。
読 み取 り操 作 がリスト 上 で保 留 になっていても、リスト に動 的 にタグを追 加 したり、削 除 したり
することができます。
関連項目
配 列 サポート

100
 Chapter: 4 CtAPI関数

配 列 サポート
配 列 は、タグ関 数 の ctTagWrite() および ctTagRead() でサポート されています。これらの関 数
は単 一 のタグ名 を「PV123」、配 列 シンタックスを「Recipe[10]」のように使 用 できます。例 えば、
配 列 シンタックスが「Recipe[10]」で使 用 される場 合 、単 一 の値 の読 み取 りまたは書 き込 みが
可 能 ですが、配 列 全 体 の読 み取 りまたは書 き込 みはできません。
関連項目
デジタル配 列 を読 み込 むときのビット シフト

デジタル配 列 を読 み込 むときのビット シフト

デジタル タイプを読 み取 る際 、CitectSCADA は最 初 のポイント の開 始 位 置 を調 整 する場 合
があります。これは、デジタル読 み取 りのパフォーマンスを向 上 するために行 われるものです。例
えば、デジタル値 の配 列 の読 み取 りを開 始 する場 合 、CitectSCADA は配 列 の開 始 前 のいく
つかのデジタルを読 み取 ることができ、データはオフセット されます。CitectSCADAによりビット が
移 動 されると、追 加 のデータは、I/O デバイスから読 み取 られます。CitectSCADAは、最 大 15
ビット までのデータを移 動 できます。その結 果 、読 み取 りにはさらに 2 バイト のバッファ容 量 が必
要 になります。したがって、2 バイト 余 分 に持 つデジタル バッファを常 に使 用 する必 要 がありま
す。

CitectSCADA または CitectSCADAドライバからのCTAPI

CTAPIは外 部 のアプリケーションから呼 び出 すことができるように設 計 されています。この API は
CitectSCADACicode DLL 関 数 または CitectSCADAプロト コル ド ライバから呼 び出 されるよう
に設 計 されていません。CTAPI を Cicode DLL 関 数 または CitectSCADAプロト コル ド ライバ
から呼 び出 すと、デッド ロックマルチステート になる場 合 があります。このことが原 因
で、CitectSCADAとプロト コル ド ライバがハングすることがあります。CTAPIをプロト コル ド ライバ
から呼 び出 す必 要 がある場 合 は、新 しい Win32 スレッド を作 成 して API を呼 び出 してくださ
い。CTAPIをCicode DLL インターフェースから呼 び出 すことはできません。
関連項目
関 数 リファレンス
エラー コード

エラー コード
CTAPI関 数 から返 されるエラー コード は、Microsoft WIN 32エラー コード です。これらのエラー
コード はMicrosoft SDKに記 載 されています。エラー コード がCitectSCADA の特 殊 コード の場
合 は、-ERROR_USER_DEFINED_BASEに追 加 されます。

101
Chapter: 4 CtAPI関数

注 : CTAPI 関 数 がエラー 233を返 した場 合 は、クライアント への接 続 が確 立 していないこと

を意 味 します。ただし、クライアント が正 しくログインされていないという場 合 もあります。両
方 のシナリオを確 認 してください。

int bRet = ctTagWrite(hCTAPI, "SP123", "12.34");

if (bRet == 0) {
dwStatus = GetLastError();
if (dwStatus < ERROR_USER_DEFINED_BASE) {
// Microsoft error codes see ERROR.H
} else {
short status;
// status is theCitectSCADA error codes, see CitectSCADA help
status = dwStatus - ERROR_USER_DEFINE_BASE;
}
}

確 認 を容 易 にするために、以 下 の定 義 を宣 言 しています。

IsCitectError(dwStatus) // test if CitectSCADA

error
WIN32_TO_CT_ERROR(dwStatus) // Convert to CitectSCADA
status

例:

if (IsCitectError(dwStatus)) {
short status;
// status is the CitectSCADA error codes, see CitectSCADA help
status = WIN32_TO_CT_ERROR(dwStatus);
}

アプリケーションと CitectSCADA間 の接 続 が失 われた場 合 は、この接 続 を終 了 し、再 開 する

必 要 があります。接 続 が動 作 不 能 になると、Microsoft エラー コード が返 されま
す。CitectSCADAのステータス エラーが返 された場 合 は、接 続 は失 われていません。リクエスト
されたコマンド は無 効 になり、接 続 を終 了 して再 試 行 する必 要 はありません。

int bRet = ctTagWrite(hCTAPI, "SP123", "12.34");

if (bRet == 0) {
dwStatus = GetLastError();
if (dwStatus < ERROR_USER_DEFINED_BASE) {
ctClose(hCTAPI);
hCTAPI = ctOpen(NULL, NULL, NULL, 0);
while (hCTAPI == NULL) {
Sleep(2000); // wait a while
hCTAPI = ctOpen(NULL, NULL, NULL, 0);
}

102
 Chapter: 4 CtAPI関数

}
}

アプリケーションと CitectSCADA 間 の接 続 が失 われた場 合 は、重 複 して保 留 となっているコマ

ンド はタイムアウト となり、CTAPI によって中 止 されます。この接 続 に関 連 するすべてのハンド ル
を削 除 する必 要 があります。
バージョン 5.10では、CT_OPEN_RECONNECTモード がctOpen()に追 加 されました。このモー
ド が有 効 になると、通 信 の中 断 が起 こった場 合 に CTAPI は CitectSCADA への接 続 の再 確
立 を試 みます。接 続 が再 確 立 しても、この接 続 で作 成 されたすべてのハンド ルは有 効 のまま
です。接 続 が失 われると、すべての関 数 は無 効 になり、エラーがレポート されます。
関連項目
デバッグ ト レース

デバッグ ト レース
CTAPIのデバッグのト レースがカーネルに追 加 されました。メインのカーネル ウィンド ウで、コマン
ド CTAPI 1を実 行 してト レースをデバッグできます。CTAPI 0はデバッグのト レースを無 効 にしま
す。CITECT.INIパラメータを設 定 してデバッグのト レースを有 効 にすることもできます。

[CTAPI]
Debug=1

デバッグ追 跡 は、CitectSCADA への各 クライアント CTAPIト ラフィックを表 示 します。この追 跡 に

より大 量 の通 信 が発 生 すると、CitectSCADAおよびCTAPIクライアント のパフォーマンスが遅 くな
る場 合 があります。
デバッグ追 跡 はメインのCitectSCADAカーネル ウィンド ウに表 示 され、syslog.datファイルに記
録 されます。

関 数 リファレンス
CTAPI 関 数 は、DLL インターフェースを通 じてCitectSCADA I/O 変 数 タグへのアクセスを可 能
にします。これにより、サード パーティ開 発 者 はC言 語 (またはその他 の言 語 ) でアプリケーショ
ンを作 成 でき、I/Oデバイスへの読 み書 きも可 能 になります。

関数 引数 タイプ 説明

ctCancelIO hCTAPI, ブール型 保 留 されている重 複 I/O

pctOverlapped 操 作 をキャンセルします。

103
Chapter: 4 CtAPI関数

ctCiCode hCTAPI, sCmd, DWORD Cicode関 数 を実 行 しま

hWin, nMode, す。
sResult,
dwLength,
pctOverlapped

ctClientCreate () 適 用 なし 新 しい CtAPI クライアント イ

ンスタンス用 にリソースを初
期 化 します。

ctClientDestroy hCTAPI ブール型 ctOpen() から返 される

CTAPI へのハンドル。

ctClose hCTAPI ブール型 CitectSCADAAPIへの接

続 を閉 じます。

ctCloseEx hCTAPI,bDestroy ハンドル ctOpen()から返 される

CTAPI へのハンドル。

ctEngToRaw pResult, dValue, ブール型 換 算 スケール変 数 を生

pScale, dwMode のI/Oデバイス スケールに
変 換 します。

ctFindClose hnd ブール型 ctFindFirst()によって開

始 された検 索 を終 了 しま
す。

ctFindFirst hCTAPI, ハンドル フィルタ文 字 列 に対 応 す

szTableName, る、指 定 されたデータ
szFilter, ベースの最 初 のオブジェ
pObjHnd, クト を検 索 します。
dwFlags

ctFindFirstEx hCTAPI, ハンドル クラスタが指 定 したフィル

szTableName, タ文 字 列 と一 致 する、指
szFilter, 定 されたデータベースの
szCluster, 最 初 のオブジェクト を検
pObjHnd, 索 します。
dwFlags

ctFindNext hnd, pObjHnd ブール型 ctFindFirst()によって開

始 された検 索 の次 のオブ
ジェクト を取 得 します。

ctFindPrev hnd, pObjHnd ブール型 ctFindFirst()によって開

始 された検 索 の前 のオブ
ジェクト を取 得 します。

ctFindScroll hnd, dwMode, ハンドル ctFindFirst()によって開

dwOffset, 始 された検 索 で、必 要 な
pObjHnd オブジェクト にスクロールし
ます。

104
 Chapter: 4 CtAPI関数

ctGetOverlappedResult hCTAPI, ブール型 重 複 操 作 の結 果 を返 し

lpctOverlapped, ます。
pBytes, bWait

ctGetProperty hnd, szName, ブール型 オブジェクト のプロパティを

pData, 取 得 します。
dwBufferLength,
dwResultLength,
dwType

ctHasOverlappedIoComplete- lpctOverlapped ブール型 未 完 了 のI/O操 作 が完

d 了 したかどうかのチェックを
します。

ctListAdd hList, sTag ハンドル タグをリスト に追 加 しま

す。

ctListAddEx hList, sTag, ハンドル タグと指 定 されたポーリン

bRaw, グ期 間 をリスト に追 加 し
nPollPeriodMS, ます。
dDeadband

ctListData hTag, pBuffer, ブール型 リスト 上 のタグの値 を取

dwLength, 得 します。
dwMode

ctListDelete タグ ブール型 ctListAdd()で作 成 され

たタグを解 放 します。

ctListEvent hCTAPI, dwMode ハンドル ctListRead()関 数 を使

用 して、前 回 読 み取 りさ
れてから変 更 されたリスト
の要 素 を返 します。

ctListFree hList ブール型 ctListNew()で作 成 され

たリスト を解 放 します。

ctListItem hTag, dwitem, ブール型 タグ要 素 アイテム データを取

pBuffer, dwLength, 得 します。
dwMode

ctListNew hCTAPI, dwMode ハンドル 新 規 リスト を作 成 しま

す。

ctListRead hList, ブール型 リスト 上 のすべてのタグを

pctOverlapped 読 み取 ります。

ctListWrite hTag, sValue, ブール型 リスト 上 の単 一 のタグに

pctOverlapped 書 き込 みます。

105
Chapter: 4 CtAPI関数

ctOpen sComputer, ハンドル CitectSCADAAPI への

sUser, 接 続 を開 きます。
sPassword,
nMode

ctOpenEx sComputer, ハンドル 任 意 のクライアント インス

sUser, タンスを使 用 してCtAPI
sPassword, サーバーへの接 続 を確
nMode, hCTAPI 立 します。

ctRawToEng pResult, dValue, ブール型 生 のI/Oデバイス スケー

pScale, dwMode ル変 数 を換 算 スケール
に変 換 します。

ctTagGetProperty hCTAPI, ブール型 任 意 のタグから任 意 のプ

szTagName, ロパティを取 得 します。
szProperty,
pData,
dwBufferLength,
dwType

ctTagRead hCTAPI, sTag, ブール型 任 意 のI/Oデバイス変 数

sValue, タグから現 在 の値 を読 み
dwLength 取 ります。

ctTagReadEx hCTAPI, sTag, ブール型 ctTagRead と同 じ動 作 です

sValue, dwLength, が、新 しい引 数 が追 加 され
pctTagvalueItems ます。

ctTagWrite hCTAPI, sTag, ブール型 I/Oデバイス変 数 タグに

sValue 任 意 の値 を書 き込 みま
す。

ctTagWriteEx hCTAPI, sTag, ブール型 ctTagWriteと同 じ動 作

sValue, を行 いますが、新 しい引
pctOverlapped 数 が追 加 されます。

ctCancelIO
保 留 されている重 複 I/O操 作 をキャンセルします。I/Oコマンド がキャンセルされると、コマンド が
完 了 したことを表 示 するようにイベント に通 知 されます。ステータスは CitectSCADAエラー CT_
ERROR_CANCELEDに設 定 されます。キャンセルする前 にコマンド が完 了 した場
合 、ctCancelIO()はFALSEを返 し、GetLastError()はGENERIC_CANNOT_CANCELを返
します。重 複 操 作 のステータスは、コマンド の完 了 ステータスになります。
ctClose() を呼 び出 すと、CTAPI インターフェースは自 動 的 にすべての保 留 の I/O コマンド をキ
ャンセルします。

106
 Chapter: 4 CtAPI関数

シンタックス
ctCancelIO(hCTAPI, pctOverlapped)
hCTAPI

タイプ: ハンドル
入 力 /出 力 :入 力
説 明 : ctOpen()から返 されるCTAPIへのハンドル。

pctOverlapped

タイプ: CTOVERLAPPED*
入 力 /出 力 :入 力
説 明 : キャンセルする重 複 するI/O操 作 のポインタです。NULL を指 定 すると、インターフェース上 で保 留
中 の、すべての重 複 する I/O 操 作 がキャンセルされます。

戻 り値
この関 数 が成 功 した場 合 、戻 り値 はTRUEになります。この関 数 が成 功 しなかった場 合 、戻 り
値 はFALSEになります。詳 細 なエラー情 報 を入 手 するには、GetLastErrorを呼 び出 します。

関連項目
ctOpen, ctClose

char sVersion[128];
CTOVERLAPPED ctOverlapped;
ctOverlapped.hEvent = CreateEvent(NULL, TRUE, TRUE, NULL);
ctCicode(hCTAPI, "Version(0)", 0, 0, sVersion, sizeof(sVersion),
&ctOverlapped);
ctCancelIO(hCTAPI, &ctOverlapped);

ctCiCode
Cicode関 数 を接 続 された CitectSCADAコンピュータで実 行 します。これにより CitectSCADA
の制 御 や Cicode 関 数 からの情 報 の入 手 が可 能 になります。また、ビルト インまたはユーザー
定 義 のCicode関 数 を呼 び出 すことが可 能 です。保 留 されている重 複 I/O操 作 をキャンセルしま
す。
関 数 名 とその関 数 に対 する引 数 は、単 一 の文 字 列 として渡 されます。スタンダー
ド CitectSCADA変 換 は、データを文 字 列 タイプから関 数 が期 待 するタイプに変 換 するために
適 用 されます。文 字 列 を送 る場 合 、CitectSCADAの文 字 列 の区 切 り文 字 の間 にに文 字 列
を挿 入 する必 要 があります。

107
Chapter: 4 CtAPI関数

ポインタまたは配 列 を期 待 する関 数 はサポート されていません。ポインタを期 待 する関 数 は、

引 数 を更 新 する関 数 です。これには、DspGetMouse()、DspAnGetPos()、StrWord()などの関
数 が含 まれます。配 列 を渡 すか返 すことを期 待 する関 数
(TableMath()、TrnSetTable()、TrnGetTable() など) はサポート されていません。これらの制 限
は、必 要 な関 数 を呼 び出 してくれるCicodeラッパー関 数 を呼 び出 すことで回 避 することもできま
す。
呼 び出 すCicode関 数 が、実 行 に時 間 がかかる場 合 、または先 取 りされていたりブロックされて
いる場 合 は、関 数 の結 果 をsResult引 数 に戻 すことはできません。ただし、Cicode関 数 は正 し
く実 行 されます。

シンタックス
ctCiCode(hCTAPI, sCmd, hWin, nMode, sResult, dwLength, pctOverlapped)
hCTAPI

タイプ：ハンドル
入 力 /出 力 ：入 力
説 明 ：ctOpen() から返 される CTAPI へのハンドル。

sCmd

タイプ：文 字 列
入 力 /出 力 ：入 力
説 明 ：実 行 するコマンドです。

vhWin

タイプ：Dword
入 力 /出 力 ：入 力
説 明 ：この関 数 を実 行 するCitectSCADAウィンドウ。これは、CitectSCADAの論 理 ウィンドウ (0、1、2、3
など)で、Windows Handleではありません。

nMode

タイプ：Dword
入 力 /出 力 ：入 力
説 明 ：Cicodeの呼 び出 しモード。これを0 (ゼロ)に設 定 します。

sResult

タイプ：LPSTR
入 力 /出 力 ：出 力
説 明 ：関 数 の呼 び出 し結 果 を保 存 するバッファ。これは文 字 列 として返 されます。関 数 の結 果 が必 要
ない場 合 は、NULLとして構 いません。

dwLength

108
 Chapter: 4 CtAPI関数

タイプ：Dword
入 力 /出 力 ：入 力
説 明 ：sResultバッファの長 さ。Cicode関 数 の結 果 がこの数 値 よりも長 い場 合 、結 果 は返 されず、関 数
の呼 び出 しは成 功 しません。ただし、Cicode関 数 は実 行 されます。sResult がNULLの場 合 は、この長
さは0でなければなりません。

pctOverlapped

タイプ：CTOVERLAPPED*
入 力 /出 力 ：入 力
説 明 ：CTOVERLAPPED構 造 。この構 造 体 は、重 複 する通 知 をコント ロールするために使 用 します。同
期 関 数 を呼 び出 したい場 合 は、NULLに設 定 します。

戻 り値
タイプ：Dword成 功 した場 合 はTRUE、そうでなければFALSEとなります。GetLastError()を使
用 して、詳 細 なエラー情 報 を入 手 します。

関連項目
ctOpen

char sName[32];
ctCicode(hCTAPI, "AlarmAck(0,)", 0, 0, NULL, 0, NULL);
ctCicode(hCTAPI, "PageInfo(0)", 0, 0, sName, sizeof(sName), NULL);
/* to call the Prompt function with the string "Hello Citect", the
C code would be:
*/

ctCicode(hCTAPI, "Prompt(\"Hello Citect\")", 0, 0, NULL, 0, NULL);

/* If the string does not contain any delimiters (for example spaces or commas) you
may omit the string delimiters. For example to display a page called "Menu" the C
code would be:
*/
ctCicode(hCTAPI, "PageDisplay(Menu)", 0, 0, NULL, 0, NULL);

ctClientCreate
CtClientCreateは、新 しいCtAPIクライアント インスタンス用 にリソースを初 期 化 します。いった
んCtClientCreateを呼 び出 すと、ハンド ルを ctOpenExに返 してCtAPIサーバーとの通 信 を確 立
できます。

109
Chapter: 4 CtAPI関数

CtAPIサーバーと通 信 しようとして、サーバーからの応 答 までに時 間 がかかっている (またはまった

く応 答 がない) 状 況 を想 像 してください。ctOpenを呼 び出 したところであれば、CtAPIインスタン
スへのハンド ルを渡 されていないので、ctCancelIOを呼 び出 してCtOpenをキャンセルすることは
できません。しかし、CtClientCreateを使 用 していてCtOpenExを呼 び出 した場 合
は、CtClientCreateから返 されたハンド ルを使 用 してCtOpenExをキャンセルできます。

シンタックス
ctClientCreate()

戻 り値
この関 数 が成 功 すると、戻 り値 がハンド ルを指 定 します。この関 数 が成 功 しなかった場 合 、戻
り値 はNULLになります。GetLastError()を使 用 して、詳 細 なエラー情 報 を入 手 します。

関連項目
ctOpen, ctOpenEx, ctClose, ctCloseEx, ctClientDestroy

DWORD dwStatus = 0;
HANDLE hCtapi = ctClientCreate();
if (hCtapi == NULL) {
dwStatus = GetLastError(); // An error has occurred, trap it.
} else {
if (TRUE == ctOpenEx(NULL, NULL, NULL, 0, hCtapi)) {
ctTagWrite(hCtapi, "Fred", "1.5");
if (FALSE == ctCloseEx(hCtapi, FALSE)) {
dwStatus = GetLastError(); // An error has occurred, trap it.
}
} else {
dwStatus = GetLastError(); // An error has occurred, trap it.
}
if (FALSE == ctClientDestroy(hCtapi)) {
dwStatus = GetLastError(); // An error has occurred, trap it
}
}

ctClientDestroy
任 意 のCtAPIインスタンスのリソースをクリーンアップします。ctClose, とは異 な
り、CtClientDestroyはCtAPIサーバーへの接 続 を終 了 しません。
ctClientDestroyを呼 び出 す前 に、FALSEに等 しいbDestroyでctCloseExを呼 び出 す必 要 があり
ます。

110
 Chapter: 4 CtAPI関数

シンタックス
ctClientDestroy(hCTAPI)
hCTAPI

タイプ: ハンドル
入 力 /出 力 :入 力
説 明 : ctOpen()から返 されるCTAPIへのハンドル。

戻 り値
成 功 した場 合 はTRUE、そうでなければFALSEとなります。GetLastError()を使 用 して、詳 細 な
エラー情 報 を入 手 します。

関連項目
ctCloseEx, ctClose, ctClientCreate, ctOpen, ctOpenEx

例
具 体 例 は、ctClientCreateを参 照 してください。

ctClose
接 続 アプリケーションとCtAPI間 の接 続 を終 了 します。呼 び出 されると、保 留 中 のすべてのコマ
ンド がキャンセルされます。ctClose()を呼 び出 す前 に、割 り当 てられているハンド ルをすべて解
放 する必 要 があります。これらのハンド ルは、ctClose()が呼 び出 されると解 放 されません。アプリ
ケーションは、シャット ダウン時 または接 続 に致 命 的 なエラーが発 生 した場 合 に、この関 数 を
呼 び出 す必 要 があります。

シンタックス
ctClose(hCTAPI)
hCTAPI

タイプ: ハンドル
入 力 /出 力 :入 力
説 明 : ctOpen()から返 されるCTAPIへのハンドル。

戻 り値
成 功 した場 合 はTRUE、そうでなければFALSEとなります。GetLastError()を使 用 して、詳 細 な
エラー情 報 を入 手 します。

111
Chapter: 4 CtAPI関数

関連項目
ctOpen

例
ctOpen()の例 を参 照 してください。

ctCloseEx
任 意 の CtAPIインスタンスで、CtAPIサーバーへの接 続 を終 了 します。これはctCloseと同 じ方
法 で接 続 を終 了 しますが、CtCloseEx関 数 呼 び出 しでCtAPIインスタンスを破 棄 するかどうかを
選 択 するオプションがあります。CtCloseは、関 数 呼 び出 しでCtAPIインスタンスを常 に破 棄 しま
す。
例 えば、CtAPI サーバーとの通 信 を切 断 しようとしている時 に、応 答 に時 間 がかかっている (ま
たはまったく応 答 がない) 状 況 を想 像 してください。CtCloseを呼 び出 している時 に
は、ctCancelIO を呼 び出 してCtCloseをキャンセルすることはできません。CtAPI インスタンスの
破 棄 プロセスが既 に始 まっているかどうかを保 証 できないからです。しかし、CtAPIインスタンスを
破 棄 しないというオプションを選 択 して CtCloseEx を呼 び出 す場 合 には、CtCancelIOを呼 び
出 して CtCloseEx をキャンセルできます。
bDestroyがFALSE と等 しい CtCloseExを呼 び出 す場 合 には、その後 でctClientDestroyを呼 び
出 し、CtAPIクライアント インスタンスを解 放 します。

シンタックス
ctCloseEx(hCTAPI,bDestroy);
hCTAPI

タイプ: ハンドル
入 力 /出 力 :入 力
説 明 : ctOpen()から返 されるCTAPIへのハンドル。

bDestroy

タイプ: ブール値
入 力 /出 力 :入 力
説 明 : TRUEの場 合 、ctCloseEx関 数 呼 び出 しにあるCtAPIインスタンスを破 棄 します。デフォルト
はFALSEです。

戻 り値
成 功 した場 合 はTRUE、そうでなければFALSEとなります。GetLastError()を使 用 して、詳 細 な
エラー情 報 を入 手 します。

112
 Chapter: 4 CtAPI関数

関連項目
ctClientDestroy, ctClose, ctClientCreate, ctOpen, ctOpenEx

例
具 体 例 は、ctClientCreateを参 照 してください。

ctEngToRaw
換 算 スケール変 数 を生 のI/Oデバイス スケールに変 換 します。タグ関 数 の場 合
はCitectSCADAがスケーリングを行 うので必 要 ありません。スケーリングはデジタルや文 字 列 に
は必 要 ありません。また、I/Oデバイスの値 と換 算 の値 との間 でスケーリングが発 生 しない場 合
も、スケーリングは不 要 です。CitectSCADAの変 数 タグ表 で指 定 された、各 変 数 のスケーリン
グを知 っておく必 要 があります。

シンタックス
ctEngToRaw(pResult, dValue, pScale, dwMode)
pResult

タイプ: ダブル
入 力 /出 力 :出 力
説 明 ：結 果 として返 されるスケールされた生 の変 数 。

dValue

タイプ: ダブル
入 力 /出 力 :入 力
説 明 : スケーリングのための換 算 値 。

pScale

タイプ: CTSCALE*
入 力 /出 力 :入 力
説 明 : 変 数 のスケーリング プロパティ。

dwMode

タイプ：Dword
入 力 /出 力 :入 力
説 明 : スケーリングのモード。

CT_SCALE_RANGE_CHECK:結 果 の範 囲 をチェックします。変 数 が範 囲 外 であ
る場 合 はエラーが生 成 されます。pResultには生 のスケール値 が含 まれていま
す。

113
Chapter: 4 CtAPI関数

CT_SCALE_CLAMP_LIMIT: 最 大 または最 小 のスケールに制 限 を固 定 します。

結 果 が範 囲 外 である場 合 は、結 果 を最 小 または最 大 スケール ( どちらか近
い方 ) に設 定 します。スケールが固 定 されている場 合 、エラーは生 成 されませ
ん。CT_SCALE_RANGE_CHECKまたはCT_SCALE_NOISE_FACTORオプ
ションと一 緒 に使 用 することはできません。
CT_SCALE_NOISE_FACTOR:範 囲 チェックの制 限 値 にノイズ要 因 を考 慮 しま
す。変 数 が範 囲 外 であってもそれが0.1 %以 内 である場 合 は、範 囲 エラーは
生 成 されません。

戻 り値
成 功 した場 合 はTRUE、そうでなければFALSEとなります。GetLastError()を使 用 して、詳 細
なエラー情 報 を入 手 します。

関連項目
ctOpen, ctRawToEng, ctTagRead

CTSCALE Scale = { 0.0, 32000.0, 0.0, 100.0};

double dSetPoint = 42.23;
double dRawValue;
ctEngToRaw(&dRawValue, dSetPoint, &Scale, CT_SCALE_RANGE_CHECK);

ctFindClose
ctFindFirstによって開 始 された検 索 を終 了 します。

シンタックス
ctFindClose(hnd)
hnd

タイプ: ハンドル
入 力 /出 力 :入 力
説 明 : ctFindFirst()から返 される検 索 へのハンドル。

戻 り値
この関 数 が成 功 すると、戻 り値 は「0」以 外 の値 になります。この関 数 が成 功 しなかった場 合 、
戻 り値 はゼロになります。詳 細 なエラー情 報 を入 手 するには、GetLastError()を呼 び出 しま
す。

114
 Chapter: 4 CtAPI関数

関連項目
ctOpen, ctFindNext, ctFindPrev, ctFindScroll, ctGetProperty

例
ctFindFirst を参 照 してください

ctFindFirst
フィルタ文 字 列 と一 致 する、指 定 された表 、デバイス、ト レンド 、または、アラーム データの最 初
のオブジェクト を検 索 します。検 索 されたオブジェクト へのハンド ルは、pObjHndを通 じて返 され
ます。オブジェクト ハンド ルはオブジェクト のプロパティを取 得 するために使 用 されます。次 のオブ
ジェクト を検 索 するには、返 された検 索 ハンド ルで ctFindNext関 数 を呼 び出 します。
ctFindFirst()を使 用 しているときにサーバー パフォーマンスに問 題 があった場 合
は、CPULoadCountおよびCpuLoadSleepMSを参 照 してください。

シンタックス
ctFindFirst(hCTAPI, szTableName, szFilter, pObjHnd,dwFlags)
hCTAPI

タイプ: ハンドル
入 力 /出 力 :入 力
説 明 : ctOpen()から返 されるCTAPIへのハンドル。

szTableName

タイプ: LPCTSTR
入 力 /出 力 :入 力
説 明 : 検 索 する表 、デバイス、ト レンド、またはアラーム データ。次 の表 またはフィールドを検 索 することが
できます。

l Trend - ト レンド タグ
CLUSTER, NAME/TAG, RAW_ZERO, RAW_FULL, ENG_ZERO, ENG_FULL, ENG_
UNITS, COMMENT, SAMPLEPER, TYPE
l DigAlm - デジタル アラーム タグ
CLUSTER, TAG, NAME, DESC, HELP, CATEGORY, STATE, TIME, DATE, AREA,
ALMCOMMENT
l AnaAlm - アナログ アラーム タグ
CLUSTER, TAG, NAME, DESC, HELP, CATEGORY, STATE, TIME, DATE, AREA,
VALUE, HIGH, LOW, HIGHHIGH, LOWLOW, DEADBAND, RATE, DEVIATION,
ALMCOMMENT
l AdvAlm - 高 機 能 アラーム タグ

115
Chapter: 4 CtAPI関数

CLUSTER, TAG, NAME, DESC, HELP, CATEGORY, STATE, TIME, DATE, AREA,
ALMCOMMENT
l HResAlm - タイムスタンプ付 アラーム タグ
CLUSTER, TAG, NAME, DESC, HELP, CATEGORY, STATE, TIME, MILLISEC, DATE,
AREA, ALMCOMMENT
l ArgDigAlm - アーガイル デジタル アラーム タグ
CLUSTER, TAG, NAME, DESC, HELP, CATEGORY, STATE, TIME, DATE, AREA,
ALMCOMMENT, PRIORITY, STATE_DESC, OLD_DESC
l ArgAnaAlm - アーガイル アナログ アラーム タグ
CLUSTER, TAG, NAME, HELP, ALMCOMMENT, CATEGORY, STATE, TIME,
DATE, AREA, VALUE, PRIORITY, HIGH, LOW, HIGHHIGH, LOWLOW,
DEADBAND, RATE, DEVIATION
l TsDigAlm - タイムスタンプ付 デジタル アラーム タグ
CLUSTER, TAG, NAME, DESC, CATEGORY, AREA, ALMCOMMENT
l TsAnaAlm - タイムスタンプ付 アナログ アラーム タグ
CLUSTER, TAG, NAME, DESC, CATEGORY, AREA, ALMCOMMENT
l ArgDigAlmStateDesc - アーガイル デジタル アラーム タグマルチステート 説 明
CLUSTER, TAG, STATE_DESC0, STATE_DESC1, STATE_DESC2, STATE_DESC3,
STATE_DESC4, STATE_DESC5, STATE_DESC6, STATE_DESC7
l Alarm - アラーム タグ
CLUSTER, TAG, NAME, DESC, HELP, CATEGORY, STATE, TIME, DATE, AREA,
ALMCOMMENT, VALUE, HIGH, LOW, HIGHHIGH, LOWLOW, DEADBAND,
RATE, DEVIATION, PRIORITY, STATE_DESC, OLD_DESC, ALARMTYPE
l AlarmSummary - アラーム サマリー
CLUSTER, TAG, NAME, DESC, HELP, CATEGORY, TIME, DATE, AREA, VALUE,
HIGH, LOW, HIGHHIGH, LOWLOW, DEADBAND, RATE, DEVIATION, PRIORITY,
STATE_DESC, OLD_DESC, ALARMTYPE, ONDATE, ONDATEEXT, ONTIME,
ONMILLI, OFFDATE, OFFDATEEXT, OFFTIME, OFFMILLI, DELTATIME, ACKDATE,
ACKDATEEXT, ACKTIME, ALMCOMMENT, USERNAME, FULLNAME,
USERDESC, SUMSTATE, SUMDESC, NATIVE_SUMDESC, COMMENT, NATIVE_
COMMENT
l Accum - アキュミュレータ
PRIV, AREA, CLUSTER, NAME, TRIGGER, VALUE, RUNNING, STARTS,
TOTALISER
l Tag - 変 数 タグ
l LocalTag - ローカル タグ
l Cluster - クラスタ
フィールド については、Cicode Reference Guideの「」関 数 フィールド の参 照 を参 照 してくださ
い。

116
 Chapter: 4 CtAPI関数

注 : CitectSCADAv7.20のマイグレーション ツールはすべてのメモリーPLC変 数 をローカル変

数 タグに変 換 し、それらは変 数 タグと別 の表 にあります。szTableName 「タグ」を使 って
ctFindFirst を呼 び出 しても、ローカル変 数 タグは戻 りません。ローカル変 数 タグを戻 すに
は、「LocalTag」の szTableName を使 ってctFindFirstを呼 び出 す必 要 があります。ローカル
変 数 はクラスタがなく、ゼロ / フルスケールが一 対 しかありません( 対 照 的 な変 数 タグの生 お
よびエンジニアリングスケールと比 べて) 。

ローカル変 数 タグのフィールド 名 は次 の通 りです。

NAME 、TYPE 、ASIZE ( 配 列 のサイズ) 、ZERO 、FULL 、UNITS 、COMMENT 。
配 列 のサイズ フィールド はローカル タグ用 にしかありません。
szFilter

タイプ: LPCTSTR
入 力 /出 力 :入 力
説 明 : フィルタ条 件 。これは文 字 列 に基 づいており、次 の形 式 に従 います。

「PropertyName1=FilterCriteria1;PropertyName2=FilterCriteria2」
ワイルド カード * を使 用 して、複 数 のエント リーに一 致 させるためのフィルタ条 件 の一
部 とすることもできます。空 の文 字 列 あるいは「*」をフィルタ文 字 列 として使 用
し、すべてのエント リーと一 致 させます。
pObjHnd

タイプ: ハンドル
入 力 /出 力 :出 力
説 明 ：検 索 されたオブジェクト ハンドルへのポインタ。これは、プロパティを取 得 するために使 用 されます。

dwFlags

この引 数 は現 在 使 用 されていません。この引 数 には0の値 が渡 される必 要 があります。

表 を検 索 する方 法 ：
szTableName で表 の名 前 を指 定 します。
デバイスを検 索 するには
szTableNameで CitectSCADAデバイス フォームで定 義 されている、名 前 を指 定 します。例 、プ
ロジェクト 例 の場 合 は「RECIPES」など。
ト レンド データを検 索 するには
szTableNameで次 の形 式 を使 ってト レンド を指 定 します( 引 用 符 を含 む) 。
`TRNQUERY,Endtime,EndtimeMs,Period,NumSamples,Tagname,Displaymode,Datamode'
構 文 の詳 細 はTrnQueryを参 照 してください。
アラーム データを検 索 するには
szTableNameで次 の形 式 を使 ってアラーム データを指 定 します( 引 用 符 を含 む) 。

117
Chapter: 4 CtAPI関数

`ALMQUERY,Database,TagName,Starttime,StarttimeMs,Endtime,EndtimeMs,Period'
構 文 の詳 細 は AlmQuery を参 照 してください。

戻 り値
関 数 が成 功 した場 合 、戻 り値 は ctFindNext() または ctFindClose() への次 の呼 び出 しで使
用 される検 索 ハンド ルです。この関 数 が成 功 しなかった場 合 、戻 り値 はNULLになります。詳
細 なエラー情 報 を入 手 するには、GetLastError()を呼 び出 します。

関連項目
ctOpen, ctFindNext, ctFindClose, ctGetProperty, ctFindFirstEx

HANDLE hSearch;
HANDLE hObject;
HANDLE hFind;
// Search the Tag table
hSearch = ctFindFirst(hCTAPI, "Tag", NULL, &hObject, 0);
if (hSearch == NULL) {
// no tags found
} else {
do {
char sName[32];
// Get the tag name
ctGetProperty(hObject, "Tag", sName, sizeof(sName), NULL,
DBTYPE_STR);
} while (ctFindNext(hSearch, &hObject));
ctFindClose(hSearch);
}
// Get Historical Trend data via CTAPI
// Get 100 samples of the CPU trend at 2 second
hFind = ctFindFirst(hCTAPI, "CTAPITrend(\"10:15:00 \", \"11/8/1998\", 2, 100, 0,
\"CPU\")", &hObject, 0);
while (hFind) {
char sTime[32], sDate[32], sValue[32];
ctGetProperty(hObject, "TIME", sTime, sizeof(sTime), NULL, DBTYPE_STR);
ctGetProperty(hObject, "DATE", sDate, sizeof(sDate), NULL, DBTYPE_STR);
ctGetProperty(hObject, "CPU", sValue, sizeof(sValue), NULL, DBTYPE_STR);
// do something with the trend data.
if (!ctFindNext(hFind, &hObject)) {
ctFindClose(hFind);
hFind = NULL;
break;
}
}

ctFindFirstEx

118
 Chapter: 4 CtAPI関数

ctFindFirstと同 じ動 作 を行 いますが、追 加 の引 数 が含 まれます。フィルタ文 字 列 と一 致 する、

指 定 された表 、デバイス、ト レンド 、または、アラーム データの最 初 のオブジェクト を検 索 しま
す。検 索 されたオブジェクト へのハンド ルは、pObjHndを通 じて返 されます。オブジェクト ハンド
ルはオブジェクト のプロパティを取 得 するために使 用 されます。次 のオブジェクト を検 索 するには、
返 された検 索 ハンド ルで ctFindNext関 数 を呼 び出 します。
ctFindFirst()を使 用 しているときにサーバー パフォーマンスに問 題 があった場 合
は、CPULoadCountおよび CpuLoadSleepMS を参 照 してください。
ctFindFirstEx ではなく ctFindFirst が呼 び出 された場 合 は、szCluster のデフォルト はNULLに
なります。

シンタックス
ctFindFirstEx(hCTAPI, szTableName, szFilter, szCluster, pObjHnd, dwFlags)
hCTAPI

タイプ: ハンドル
入 力 /出 力 :入 力
説 明 : ctOpen()から返 されるCTAPIへのハンドル。

szTableName

タイプ: LPCTSTR
入 力 /出 力 :入 力
説 明 : 検 索 する表 、デバイス、ト レンド、またはアラーム データ。次 の表 またはフィールドを検 索 することが
できます。

l Trend - ト レンド タグ
CLUSTER, NAME/TAG, RAW_ZERO, RAW_FULL, ENG_ZERO, ENG_FULL, ENG_
UNITS, COMMENT, SAMPLEPER, TYPE
l DigAlm - デジタル アラーム タグ
CLUSTER, TAG, NAME, DESC, HELP, CATEGORY, STATE, TIME, DATE, AREA,
ALMCOMMENT
l AnaAlm - アナログ アラーム タグ
CLUSTER, TAG, NAME, DESC, HELP, CATEGORY, STATE, TIME, DATE, AREA,
VALUE, HIGH, LOW, HIGHHIGH, LOWLOW, DEADBAND, RATE, DEVIATION,
ALMCOMMENT
l AdvAlm - 高 機 能 アラーム タグ
CLUSTER, TAG, NAME, DESC, HELP, CATEGORY, STATE, TIME, DATE, AREA,
ALMCOMMENT
l HResAlm - タイムスタンプ付 アラーム タグ
CLUSTER, TAG, NAME, DESC, HELP, CATEGORY, STATE, TIME, MILLISEC, DATE,
AREA, ALMCOMMENT
l ArgDigAlm - Argyle デジタル アラーム タグ

119
Chapter: 4 CtAPI関数

CLUSTER, TAG, NAME, DESC, HELP, CATEGORY, STATE, TIME, DATE, AREA,
ALMCOMMENT, PRIORITY, STATE_DESC, OLD_DESC
l ArgAnaAlm - Argyle アナログ アラーム タグ
CLUSTER, TAG, NAME, HELP, ALMCOMMENT, CATEGORY, STATE, TIME,
DATE, AREA, VALUE, PRIORITY, HIGH, LOW, HIGHHIGH, LOWLOW,
DEADBAND, RATE, DEVIATION
l TsDigAlm - タイムスタンプ付 デジタル アラーム タグ
CLUSTER, TAG, NAME, DESC, CATEGORY, AREA, ALMCOMMENT
l TsAnaAlm - タイムスタンプ付 アナログ アラーム タグ
CLUSTER, TAG, NAME, DESC, CATEGORY, AREA, ALMCOMMENT
l ArgDigAlmStateDesc - Argyle デジタル アラーム タグマルチステート 説 明
CLUSTER, TAG, STATE_DESC0, STATE_DESC1, STATE_DESC2, STATE_DESC3,
STATE_DESC4, STATE_DESC5, STATE_DESC6, STATE_DESC7
l Alarm - アラーム タグ
CLUSTER, TAG, NAME, DESC, HELP, CATEGORY, STATE, TIME, DATE, AREA,
ALMCOMMENT, VALUE, HIGH, LOW, HIGHHIGH, LOWLOW, DEADBAND,
RATE, DEVIATION, PRIORITY, STATE_DESC, OLD_DESC, ALARMTYPE
l AlarmSummary - アラーム サマリー
CLUSTER, TAG, NAME, DESC, HELP, CATEGORY, TIME, DATE, AREA, VALUE,
HIGH, LOW, HIGHHIGH, LOWLOW, DEADBAND, RATE, DEVIATION, PRIORITY,
STATE_DESC, OLD_DESC, ALARMTYPE, ONDATE, ONDATEEXT, ONTIME,
ONMILLI, OFFDATE, OFFDATEEXT, OFFTIME, OFFMILLI, DELTATIME, ACKDATE,
ACKDATEEXT, ACKTIME, ALMCOMMENT, USERNAME, FULLNAME,
USERDESC, SUMSTATE, SUMDESC, NATIVE_SUMDESC, COMMENT, NATIVE_
COMMENT
l Accum - アキュミュレータ
PRIV, AREA, CLUSTER, NAME, TRIGGER, VALUE, RUNNING, STARTS,
TOTALISER
l Tag - 変 数 タグ
l LocalTag - ローカル タグ
l Cluster - クラスタ
フィールド については、Cicode Reference Guideの「」関 数 フィールド の参 照 を参 照 してくださ
い。
szFilter

タイプ: LPCTSTR
入 力 /出 力 :入 力
説 明 : フィルタ条 件 。これは文 字 列 に基 づいており、次 の形 式 に従 います。

「PropertyName1=FilterCriteria1;PropertyName2=FilterCriteria2」\
「*」は同 じ結 果 を得 るためのフィルタです。

120
 Chapter: 4 CtAPI関数

szCluster

タイプ: LPCTSTR
入 力 /出 力 :入 力
説 明 : どのクラスタに最 初 に検 索 することを実 行 するか指 定 します。NULLまたは空 の文 字 列 の場 合 、1
つしかない場 合 はアクティブなクラスタ上 でctFindFirstが行 われます。

pObjHnd

タイプ: ハンドル
入 力 /出 力 :出 力
説 明 ：検 索 されたオブジェクト ハンドルへのポインタ。これは、プロパティを取 得 するために使 用 されます。

dwFlags

この引 数 は現 在 使 用 されていません。この引 数 には0の値 が渡 される必 要 があります。

表 を検 索 する方 法 ：
szTableName で表 の名 前 を指 定 します。
デバイスを検 索 するには
szTableNameで CitectSCADAデバイス フォームで定 義 されている、名 前 を指 定 します。例 、プ
ロジェクト 例 の場 合 は「RECIPES」など。
ト レンド データを検 索 するには
szTableNameで次 の形 式 を使 ってト レンド を指 定 します( 引 用 符 を含 む) 。
`TRNQUERY,Endtime,EndtimeMs,Period,NumSamples,Tagname,Displaymode,Datamode'
構 文 の詳 細 はTrnQueryを参 照 してください。
アラーム データを検 索 するには
szTableNameで次 の形 式 を使 ってアラーム データを指 定 します( 引 用 符 を含 む) 。
`ALMQUERY,Database,TagName,Starttime,StarttimeMs,Endtime,EndtimeMs,Period'
構 文 の詳 細 は AlmQuery を参 照 してください。

戻 り値
関 数 が成 功 した場 合 、戻 り値 はctFindNext()またはctFindClose()への次 の呼 び出 しで使 用
される検 索 ハンド ルです。この関 数 が成 功 しなかった場 合 、戻 り値 はNULLになります。詳 細
なエラー情 報 を入 手 するには、GetLastError()を呼 び出 します。

関連項目
ctOpen, ctFindNext, ctFindClose, ctGetProperty, ctFindFirst

ctFindNext
ctFindFirstによって開 始 された検 索 の次 のオブジェクト を取 得 します。

121
Chapter: 4 CtAPI関数

シンタックス
ctFindNext(hnd, pObjHnd)
hnd

タイプ: ハンドル
入 力 /出 力 :入 力
説 明 : ctFindFirst()から返 される検 索 へのハンドル。

pObjHnd

タイプ: ハンドル
入 力 /出 力 :出 力
説 明 ：検 索 されたオブジェクト ハンドルへのポインタ。これは、プロパティを取 得 するために使 用 されます。

戻 り値
この関 数 が成 功 した場 合 、戻 り値 はTRUE (1)になります。この関 数 が成 功 しなかった場 合 、
戻 り値 はFALSE (0)になります。詳 細 なエラー情 報 を入 手 するには、GetLastError()を呼 び出
します。検 索 結 果 の最 後 までいくと、GetLastError()がCT_ERROR_NOT_FOUNDを返 しま
す。検 索 結 果 の最 後 までいくと、ctFindNext()またはctFindPrev()コマンド を使 用 して検 索 結
果 をスクロールすることはできません。ctFindFirst()を使 用 して新 規 の検 索 を作 成 する
か、ctFindScroll()関 数 を使 用 してポインタを有 効 な位 置 に移 動 するかし、検 索 ポインタをリセ
ット する必 要 があります。

関連項目
ctOpen, ctFindFirst, ctFindPrev, ctFindClose, ctGetProperty

例
ctFindFirst を参 照 してください。

ctFindPrev
ctFindFirst によって開 始 された検 索 の前 のオブジェクト を取 得 します。

シンタックス
ctFindPrev(hnd, pObjHnd)
hnd

タイプ: ハンドル
入 力 /出 力 :入 力
説 明 : ctFindFirst()から返 される検 索 へのハンドル。

pObjHnd

122
 Chapter: 4 CtAPI関数

タイプ: ハンドル
入 力 /出 力 :出 力
説 明 ：検 索 されたオブジェクト ハンドルへのポインタ。これは、プロパティを取 得 するために使 用 されます。

戻 り値
この関 数 が成 功 した場 合 、戻 り値 はTRUE (1)になります。この関 数 が成 功 しなかった場 合 、
戻 り値 はFALSE (0)になります。詳 細 なエラー情 報 を入 手 するには、GetLastError()を呼 び出
します。検 索 結 果 の最 後 までいくと、GetLastError()がCT_ERROR_NOT_FOUNDを返 しま
す。検 索 結 果 の最 後 までいくと、ctFindNext()またはctFindPrev()コマンド を使 用 して検 索 結
果 をスクロールすることはできません。ctFindFirst()を使 用 して新 規 の検 索 を作 成 する
か、ctFindScroll()関 数 を使 用 してポインタを有 効 な位 置 に移 動 するかし、検 索 ポインタをリセ
ット する必 要 があります。

関連項目
ctOpen, ctFindFirst, ctFindNext, ctFindClose, ctGetProperty

例
ctFindFirst を参 照 してください

ctFindScroll
ctFindFirstによって開 始 された検 索 で、必 要 なオブジェクト にスクロールします。
現 在 のスクロール ポインタを見 つけるには、0オフセット からの相 対 (dwMode = CT_FIND_
SCROLL_RELATIVE) でスクロールします。検 索 で戻 されたレコード の数 を調 べるには、検 索
結 果 の最 後 までスクロールします。

シンタックス
ctFindScroll(hnd, dwMode, dwOffset, pObjHnd)
hnd

タイプ: ハンドル
入 力 /出 力 :入 力
説 明 : ctFindFirst()から返 される検 索 へのハンドル。

dwMode

タイプ: DWORD
入 力 /出 力 :
説 明 :スクロールのモード。以 下 のモードがサポート されています。

CT_FIND_SCROLL_NEXT: 次 のレコード にスクロールします。dwOffsetパラメータ

は無 視 されます。

123
Chapter: 4 CtAPI関数

CT_FIND_SCROLL_PREV:前 のレコード にスクロールします。dwOffsetパラメータは

無 視 されます。
CT_FIND_SCROLL_FIRST: 最 初 のレコード にスクロールします。dwOffsetパラメー
タは無 視 されます。
CT_FIND_SCROLL_LAST:最 後 のレコード にスクロールします。dwOffsetパラメー
タは無 視 されます。
CT_FIND_SCROLL_ABSOLUTE:絶 対 レコード 数 にスクロールします。レコード の
数 はdwOffsetパラメータで指 定 されます。レコード の数 は1から検 索 で返 され
るレコード の最 大 数 です。
CT_FIND_SCROLL_RELATIVE:相 対 レコード にスクロールします。スクロールする
レコード の数 はdwOffsetパラメータで指 定 されます。オフセット が正 の数 の場
合 は、この関 数 は次 のレコード にスクロールします。負 の場 合 は前 のレコード
にスクロールします。0 (ゼロ) の場 合 はスクロールしません。
dwOffset

タイプ: LONG
入 力 /出 力 :入 力
説 明 : スクロールのオフセット 。このパラメータの意 味 は、スクロール操 作 のdwModeによって変 化 します。

pObjHnd

タイプ: ハンドル
入 力 /出 力 :出 力
説 明 ：検 索 されたオブジェクト ハンドルへのポインタ。これは、プロパティを取 得 するために使 用 されます。

pObjHnd

タイプ: ハンドル
入 力 /出 力 :出 力
説 明 ：検 索 されたオブジェクト ハンドルへのポインタ。これは、プロパティを取 得 するために使 用 されます。

戻 り値
この関 数 が成 功 すると、戻 り値 は「0」以 外 の値 になります。この関 数 が成 功 しなかった場 合 、
戻 り値 はゼロになります。詳 細 なエラー情 報 を入 手 するには、GetLastError()を呼 び出 しま
す。一 致 するオブジェクト が見 つからない場 合 、GetLastError()関 数 がCT_ERROR_NOT_
FOUNDを返 します。この戻 り値 は、検 索 における現 在 のレコード 番 号 です。レコード 番 号
は1(第 1 番 目 のレコード ) で始 まり、検 索 結 果 の最 後 まで1ずつ増 分 します。0 (ゼロ) というレ
コード 番 号 は無 効 です。これは、関 数 が成 功 しなかったことを示 すものです。

関連項目
ctOpen, ctFindFirst, ctFindNext, ctFindPrev, ctFindClose, ctGetProperty

124
 Chapter: 4 CtAPI関数

HANDLE hSearch;
HANDLE hObject;
DWORD dwNoRecords;
// Search the Tag table
hSearch = ctFindFirst(hCTAPI, "Tag", NULL, &hObject, 0);
// Count number of records
dwNoRecords = ctFindScroll(hSearch, CT_FIND_SCROLL_LAST, 0, &hObject);
// scroll back to beginning
ctFindScroll(hSearch, CT_FIND_SCROLL_FIRST, 0, &hObject);
do {
char sName[32];
// Get the tag name
ctGetProperty(hObject, "Tag", sName, sizeof(sName), NULL, DBTYPE_STR);
} while (ctFindScroll(hSearch, CT_FIND_SCROLL_NEXT, 0, &hObject));
ctFindClose(hSearch);

ctGetOverlappedResult
重 複 操 作 の結 果 を返 します。ctGetOverlappedResult()関 数 がレポート した結 果 は、指 定 し
たCTOVERLAPPED構 造 体 が提 供 され、操 作 結 果 が保 留 になっている、指 定 したハンド ル
の最 後 の CTOVERLAPPED操 作 です。操 作 を開 始 した関 数 がFALSEを返 し、GetLastError
関 数 がERROR_IO_PENDINGを返 す時 は、操 作 が保 留 になっていることを示 します。I/O 操
作 が保 留 になっている場 合 、操 作 を開 始 した関 数 はCTOVERLAPPED構 造 のhEventメン
バーを、非 通 知 のマルチステート にリセット します。保 留 中 の操 作 が完 了 すると、システムはイ
ベント オブジェクト を通 知 済 みに設 定 します。
bWaitパラメータがTRUEの場 合 、ctGetOverlappedResult()はイベント オブジェクト が通 知 済
みのマルチステート になるのを待 って、保 留 中 の操 作 が完 了 したかどうかを判 断 します。
CTOVERLAPPED構 造 の手 動 リセット のイベント オブジェクト を指 定 します。自 動 リセット のイ
ベント オブジェクト が使 用 されている場 合 、イベント ハンド ルを CTOVERLAPPED の開 始
とctGetOverlappedResult()への呼 び出 しの間 の他 の待 ち操 作 に指 定 しないでください。例 え
ば、イベント オブジェクト は、待 ち関 数 の操 作 の完 了 まで待 ち関 数 の 1 つに指 定 される場 合
があります。待 ち関 数 が返 されると、システムは自 動 リセット イベント のマルチステート を非 通 知
に設 定 し、bWait パラメータが TRUE に設 定 された後 にctGetOverlappedResult()を呼 び出
すことで、この関 数 が無 期 限 にブロックされます。

シンタックス
ctGetOverlappedResult(hCTAPI, lpctOverlapped, pBytes, bWait)
hCTAPI

タイプ: ハンドル
入 力 /出 力 :入 力
説 明 : ctOpen()から返 されるCTAPIへのハンドル。

125
Chapter: 4 CtAPI関数

lpctOverlapped

タイプ: CTOVERLAPPED*
入 力 /出 力 :入 力
説 明 : 重 複 操 作 が開 始 されたときに使 用 されていたCTOVERLAPPED構 造 のアドレス。

pBytes

タイプ: DWORD*
入 力 /出 力 :入 力
説 明 : 転 送 された実 際 のバイト のアドレス。CTAPIではこの値 は未 定 義 です。

bWait

タイプ: BOOL
入 力 /出 力 :入 力
説 明 : 関 数 が保 留 中 の重 複 操 作 の完 了 を待 つべきかどうかを指 定 します。TRUEであれば、関 数 は操
作 が完 了 するまで返 されません。FALSEで 操 作 が保 留 中 の場 合 は、関 数 はFALSEを返
し、GetLastError関 数 はERROR_IO_INCOMPLETEを返 します。

戻 り値
この関 数 が成 功 した場 合 、戻 り値 はTRUEになります。この関 数 が成 功 しなかった場 合 、戻 り
値 はFALSEになります。GetLastError()を使 用 して、詳 細 なエラー情 報 を入 手 します。

関連項目
ctOpen, ctHasOverlappedIoCompleted

DWORD Bytes;
char sVersion[128];
CTOVERLAPPED ctOverlapped;
ctOverlapped.hEvent = CreateEvent(NULL, TRUE, TRUE, NULL);
ctCicode(hCTAPI, "Version(0)", 0, 0, sVersion, sizeof(sVersion), &ctOverlapped);
//..
// do something else.
//..
// wait for the ctCicode to complete
ctGetOverlappedResult(hCTAPI, &ctOverlapped, &Bytes, TRUE);

ctGetProperty
オブジェクト プロパティまたはオブジェクト のメタデータを取 得 します。この関 数 は、ctFindFirst()お
よびctFindNext()関 数 と連 携 して使 用 されなければなりません。つまり、オブジェクト を探 し、そ
れからそのプロパティを取 得 します。

126
 Chapter: 4 CtAPI関数

タイプやサイズなどのプロパティのメタデータを取 得 するには、以 下 のような szName 引 数 のシ

ンタックスを使 用 します。
l object.fields.count - レコード 内 のフィールド 数
l object.fields(n).name - レコード の第 nフィールド の名 前
l object.fields(n).type - レコード の第 nフィールド のタイプ
l object.fields(n).actualsize - レコード の第 nフィールド の実 際 のサイズ

シンタックス
ctGetProperty(hnd, szName, pData, dwBufferLength, dwResultLength, dwType)
hnd

タイプ: ハンドル
入 力 /出 力 :入 力
説 明 : ctFindFirst()から返 される検 索 へのハンドル。

szName

タイプ: LPCTSTR*
入 力 /出 力 :入 力
説 明 : 取 得 するプロパティ名 。以 下 のプロパティがサポート されています。

Name - タグの名 前 。.
FullName - クラスタフォームのタグのフルネーム。tagname 。
Network -一 意 のI/Oデバイス番 号 。
BitWidth - データ型 の幅 (バイト 単 位 )。例 えば、digital は 1、integer は 16、long
は 32 などのようになります。
UnitType - プロト コル固 有 のユニット タイプ。
UnitAddress - プロト コル固 有 のユニット アド レス。
UnitCount - プロト コル固 有 のユニット カウント 。
RawType - ポイント の生 データ型 。以 下 のような型 が返 されます。0 (Digital)、1
(Integer)、2 (Real)、3 (BCD)、4 (Long)、5 (Long BCD)、6 (Long Real)、7
(String)、8 (Byte)、9 (Void)、10 (Unsigned integer)。
Raw_Zero - 生 データ最 小 スケール。
Raw_Full - 生 データ最 大 スケール。
Eng_Zero - 最 小 換 算 スケール。
Eng_Full - 最 大 換 算 スケール。
pData

127
Chapter: 4 CtAPI関数

タイプ: VOID*
入 力 /出 力 :出 力
説 明 ：読 み取 ったデータを保 存 する結 果 バッファ。このデータは生 のバイナリ データで、データ変 換 やス
ケーリングは実 行 されません。このバッファのサイズがデータを受 信 するのに不 十 分 な場 合 、データは切 り
捨 てられ、関 数 はFALSEを返 します。

dwBufferLength

タイプ: DWORD
入 力 /出 力 :入 力
説 明 : 結 果 バッファの長 さ。結 果 バッファのサイズがデータを受 信 するのに不 十 分 な場 合 、データは切 り
捨 てられ、関 数 はFALSEを返 します。

dwResultLength

タイプ: DWORD*
入 力 /出 力 :出 力
説 明 ：返 される結 果 の長 さ。このパラメータを無 視 したい場 合 は、NULLを渡 します。

dwType

タイプ: DWORD
入 力 /出 力 :入 力
説 明 : 望 ましい戻 り値 のタイプは、以 下 のようなものです。

値 意味

DBTYPE_UI1 UCHAR

DBTYPE _I1 1 byte INT

DBTYPE _I2 2 byte INT

DBTYPE _I4 4 byte INT

DBTYPE _R4 4 byte REAL

DBTYPE _R8 8 byte REAL

DBTYPE _BOOL ブール型

DBTYPE_BYTES バイト スト リーム

DBTYPE _STR NULLによって終 了 した文 字 列

戻 り値
この関 数 が成 功 すると、戻 り値 は「0」以 外 の値 になります。この関 数 が成 功 しなかった場 合 、
戻 り値 はゼロになります。詳 細 なエラー情 報 を入 手 するには、GetLastError()を呼 び出 します。

128
 Chapter: 4 CtAPI関数

関連項目
ctOpen, ctFindFirst, ctFindNext, ctFindPrev, ctFindClose

例
ctFindFirst() も参 照 してください。

// get the property of the TAG field

ctGetProperty(hObject, "TAG", sName, sizeof(sName), NULL, DBTYPE_STR);
// Use the meta property fields to enumerate the entire row of data
// first get number of fields in the row
ctGetProperty(hObject, "object.fields.count", &dwFields, sizeof(dwFields),
NULL, DBTYPE_I4);
for (i = 0; i < dwFields; i++) {
sprintf(sObject, "object.fields(%d).name", i + 1);
// get name of field
if (ctGetProperty(hObject, sObject, sName, sizeof(sName), NULL, DBTYPE_STR)) {
// get value of field
if (ctGetProperty(hObject, sName, sData, sizeof(sData),
NULL, DBTYPE_STR)) {
printf("%8.8s ", sData);
}
}
}

ctHasOverlappedIoCompleted
保 留 中 のI/O操 作 の完 了 をポーリングするために使 用 可 能 な、高 パフォーマンス テスト 操 作 を
提 供 します。

シンタックス
ctHasOverlappedIoCompleted(lpctOverlapped)
lpctOverlapped

タイプ: CTOVERLAPPED*
入 力 /出 力 :入 力
説 明 : 重 複 操 作 が開 始 されたときに使 用 されていたCTOVERLAPPED構 造 のアドレス。

戻 り値
I/O 操 作 が完 了 していればTRUE、そうでなければFALSEになります。

戻 り値
ctOpen, ctGetOverlappedResult

ctListAdd

129
Chapter: 4 CtAPI関数

タグまたはタグ要 素 の値 をリスト に追 加 します。いったんタグがリスト に追 加 される

と、ctListRead()を使 用 した読 み取 りやctListWrite()を使 用 した書 き込 みが可 能 になります。
読 み取 りが既 に保 留 になっている場 合 、次 にctListRead()が呼 び出 されるまでこのタグが読 み
取 られることはありません。ctListAdd()関 数 が完 了 次 第 、ctListWrite()を呼 び出 すことが可 能
です。

シンタックス
ctListAdd(hList, sTag)
hList

タイプ: ハンドル
入 力 /出 力 :入 力
説 明 : ctListNew()から返 されるリスト へのハンドル。

sTag

タイプ: LPCSTR
入 力 /出 力 :入 力
説 明 : タグまたはタグ名 および要 素 名 。ドット で区 切 ってリスト に追 加 されます。要 素 名 が指 定 されていな
い場 合 、ランタイムで、完 全 修 飾 名 ではないタグ参 照 として扱 われます。

戻 り値
この関 数 が成 功 すると、戻 り値 がハンド ルを指 定 します。この関 数 が成 功 しなかった場 合 、戻
り値 はNULLになります。詳 細 なエラー情 報 を入 手 するには、GetLastError()を呼 び出 します。

システム上 で現 在 定 義 されていないタグをこの関 数 を使 用 して指 定 した場 合 、戻 り値 は有 効

なハンド ルを指 定 します。このタグに対 してctListReadを呼 び出 すと、このタグ関 して真 である(
関 数 が成 功 した) と認 識 します。この関 数 に空 のタグを渡 すと、直 ちに関 数 は終 了 し、NULL
を返 します。

関連項目
ctOpen, ctListNew, ctListFree, ctListRead, ctListWrite, ctListData, ctListAddEx

HANDLE hCTAPI;
HANDLE hList;
HANDLE hTagOne;
HANDLE hTagOneField;
HANDLE hTagOneControlMode;
HANDLE hTagOneStatus;
char sProcessValue[20];
char sProcessValueField[20];

130
 Chapter: 4 CtAPI関数

char sProcessValueControlMode[20];
char sProcessValueStatus[20];
hCTAPI = ctOpen(NULL, NULL, NULL, 0);
hList = ctListNew(hCTAPI, 0);
hTagOne = ctListAdd(hList, "TagOne");
hTagOneField = ctListAdd(hList, "TagOne.Field");
hTagOneControlMode = ctListAdd(hList, "TagOne.ControlMode");
hTagOneStatus = ctListAdd(hList, "TagOne.Status");
ctListRead(hList, NULL);

ctListData(hTagOne, sProcessValue, sizeof(sProcessValue), 0);

ctListData(hTagOneField, sProcessValueField, sizeof(sProcessValueField) , 0);
ctListData(hTagOneControlMode, sProcessValueControlMode,
sizeof(sProcessValueControlMode) , 0);
ctListData(hTagOneStatus, sProcessValueStatus, sizeof(sProcessValueStatus) , 0);
ctListFree(hList);

ctListAddEx
ctListAddと同 じ動 作 を行 いますが、2つの追 加 の新 しい引 数 が含 まれます。タグまたはタグ要
素 をリスト に追 加 します。いったんタグがリスト に追 加 されると、ctListRead()を使 用 した読 み取
りやctListWrite()を使 用 した書 き込 みが可 能 になります。読 み取 りが既 に保 留 になっている場
合 、次 にctListRead()が呼 び出 されるまでこのタグが読 み取 られることはありませ
ん。ctListAdd()関 数 が完 了 次 第 、ctListWrite()を呼 び出 すことが可 能 です。
ctListAddEx ではなく ctListAdd が呼 び出 されると、タグ読 み込 みのポーリング周 期 の初 期 値
が 500 ミリ秒 になり、bRaw フラグのデフォルト は換 算 値 の FALSE になります。

シンタックス
ctListAddEx(hList, sTag, bRaw, nPollPeriodMS)
hList

タイプ: ハンドル
入 力 /出 力 :入 力
説 明 : ctListNew()から返 されるリスト へのハンドル。

sTag

タイプ: LPCSTR
入 力 /出 力 :入 力
説 明 : タグまたはタグ名 および要 素 名 。ドット で区 切 ってリスト に追 加 されます。要 素 名 が指 定 されていな
い場 合 、ランタイムで、完 全 修 飾 名 ではないタグ参 照 として扱 われます。

bRaw

タイプ: BOOL
入 力 /出 力 :入 力
説 明 : TRUEの場 合 は生 モード、また FALSEの場 合 は換 算 モードを使 用 して、リスト 内 の任 意 のタグを
定 期 的 に取 得 するかどうかを指 定 します。

131
Chapter: 4 CtAPI関数

nPollPeriodMS

タイプ: INTEGER
入 力 /出 力 :入 力
説 明 : タグの定 期 的 な取 得 に使 用 されるポーリング周 期 を(ミリ秒 で) 記 録 します。

dDeadband

タイプ: DOUBLE
入 力 /出 力 :入 力
説 明 : アップデート がシステムに送 られるために、タグが変 更 されなければならない、変 数 タグの換 算 範 囲
のパーセンテージ。-1.0の値 は、タグ定 義 で指 定 したデッドバンドのデフォルト 値 が使 用 されていることを示
します。

戻 り値
この関 数 が成 功 すると、戻 り値 がハンド ルを指 定 します。この関 数 が成 功 しなかった場 合 、戻
り値 はNULLになります。詳 細 なエラー情 報 を入 手 するには、GetLastError()を呼 び出 します。

システム上 で現 在 定 義 されていないタグをこの関 数 を使 用 して指 定 した場 合 、戻 り値 は有 効

なハンド ルを指 定 します。このタグに対 してctListReadを呼 び出 すと、このタグ関 して真 である(
関 数 が成 功 した) と認 識 します。この関 数 に空 のタグを渡 すと、直 ちに関 数 は終 了 し、NULL
を返 します。

関連項目
ctOpen, ctListNew, ctListFree, ctListRead, ctListWrite, ctListData, ctListItem

例
ctListNewを参 照 してください

ctListDelete
ctListAddで作 成 されたタグを解 放 します。別 のスレッド の読 み取 りまたは書 き込 みが保 留 中
の場 合 に、ctListDelete()を呼 び出 すことができます。ctListWrite()およびctListRead()は、タグが
削 除 された時 点 で返 されます。

シンタックス
ctListDelete(hTag)
タグ

タイプ: ハンドル
入 力 /出 力 :入 力
説 明 : ctListAdd()から返 されるタグへのハンドル。

132
 Chapter: 4 CtAPI関数

戻 り値
この関 数 が成 功 した場 合 、戻 り値 はTRUEになります。この関 数 が成 功 しなかった場 合 、戻 り
値 はFALSEになります。詳 細 なエラー情 報 を入 手 するには、GetLastError()を呼 び出 します。

関連項目
ctOpen, ctListNew, ctListFree, ctListAdd, ctListRead, ctListWrite, ctListData, ctListItem

HANDLE hList;
HANDLE hTagOne;
HANDLE hTagTwo;
hList = ctListNew(hCTAPI, 0);
hTagOne = ctListAdd(hList, "TagOne");
hTagTwo = ctListAdd(hList, "TagTwo");
ctListRead(hList, NULL); // read TagOne and TagTwo
ctListData(hList, hTagOne, sBufOne, sizeof(sBufOne), 0);
ctListData(hList, hTagTwo, sBufTwo, sizeof(sBufTwo) , 0);
ctListDelete(hTagOne); // delete TagOne;
ctListRead(hList, NULL); // read TagTwo only
ctListData(hList, hTagTwo, sBufTwo, sizeof(sBufTwo) , 0);

ctListEvent
ctListRead()関 数 を使 用 して、前 回 読 み取 りされてから変 更 されたリスト の要 素 を返 します。
そのためには、ctListNew()関 数 でCT_LIST_EVEN モード のリスト が作 成 されている必 要 があ
ります。

シンタックス
ctListEvent(hCTAPI, dwMode)
hCTAPI

タイプ: ハンドル
入 力 /出 力 :入 力
説 明 : ctListNew()から返 されるCTAPIへのハンドル。

dwMode

タイプ: Dword
入 力 /出 力 :入 力
説 明 : リスト イベント のモード。ctListEvent()へのすべての呼 び出 しにはモードが変 更 される前 にNULLが
返 されるまでは、同 じモードを使 用 する必 要 があります。以 下 のモードがサポート されています。

133
Chapter: 4 CtAPI関数

CT_LIST_EVENT_NEW - タグがリスト に追 加 されると通 知 を取 得 します。このモー

ド を使 用 する場 合 、新 しいタグがリスト に追 加 されるとイベント メッセージを取
得 します。
CT_LIST_EVENT_STATUS - ステータスの変 更 の通 知 を取 得 します。I/O デバイ
スがオフラインになると、タグはステータスを変 更 します。このモード では、タグ
が#COMに入 ると通 知 を取 得 し、#COMから出 ると別 の通 知 を取 得 しま
す。ctListData()からそのタグに関 するエラーが返 されると、タグが#COMにある
かどうかを確 認 できます。

戻 り値
この関 数 が成 功 すると、戻 り値 は前 回 ctListReadが呼 び出 されてから変 更 されたタグのハンド
ルを指 定 します。関 数 が成 功 しないか、変 更 がない場 合 は、戻 り値 がNULLになります。詳
細 なエラー情 報 を入 手 するには、GetLastError()を呼 び出 します。

関連項目
ctListAdd, ctListDelete, ctListRead, ctListWrite, ctListData, ctListItem

HANDLE hList; HANDLE hTag[100];

hList = ctListNew(hCTAPI, CT_LIST_EVENT);
hTagArray[0] = ctListAdd(hList, "TagOne");
hTagArry[1] = ctListAdd(hList, "TagTwo");
and so on...
while (TRUE) {
ctListRead(hList, NULL);
hTag = ctListEvent(hList, 0);
while (hTag != NULL) {
// hTag has changed state, do whatever you need
hTag = ctListEvent(hList, 0);
}
}

ctListFree
ctListNewで作 成 されたリスト を解 放 します。リスト に追 加 されたすべてのタグが解 放 されるた
め、各 タグで ctListDelete() を呼 び出 す必 要 はありません。また、読 み取 り操 作 の保 留 中
は、ctListFree() を呼 び出 さないでください。読 み取 りが完 了 するのを待 ってからリスト を解 放 し
ます。

シンタックス
ctListFree(hList)
hList

134
 Chapter: 4 CtAPI関数

タイプ: ハンドル
入 力 /出 力 :入 力
説 明 : ctListNew() から返 されるリスト へのハンドル。

戻 り値
この関 数 が成 功 した場 合 、戻 り値 は TRUE になります。この関 数 が成 功 しなかった場 合 、戻
り値 は FALSE になります。詳 細 なエラー情 報 を入 手 するには、GetLastError() を呼 び出 しま
す。

関連項目
ctOpen、ctListNew、ctListAdd、ctListDelete、ctListRead、ctListWrite、ctListData

例
ctListNew を参 照 してください

ctListRead
リスト 上 のタグを読 み取 ります。この関 数 は、リスト に付 属 するタグを読 み取 ります。I/O デバイ
スからデータを読 み取 ったら、ctListData() を呼 び出 してタグの値 を取 得 できます。読 み取 りが
成 功 しなかった場 合 、ctListData() は読 み取 れなかったタグのエラーを返 します。
ctListRead() が保 留 中 でも、タグをリスト に追 加 したり、リスト から削 除 したりできま
す。ctListRead() の保 留 中 にリスト からタグを削 除 した場 合 、再 度 読 み取 りが行 われる場 合
があります。次 に ctListRead() が呼 び出 された時 には、タグは読 み取 られません。ctListRead()
の保 留 中 にリスト にタグを追 加 した場 合 、次 に ctListRead() が読 み取 られるまでタグは読 み
取 られません。追 加 が完 了 し次 第 、このタグに ctListData() を呼 び出 す場 合 があります。この
場 合 、ctListData() は成 功 せず、GetLastError() は GENERIC_INVALID_DATA を返 しま
す。
各 リスト で、読 み取 りコマンド を保 留 にできるのは一 つだけです。同 じリスト に再 び ctListRead()
を呼 び出 した場 合 、この関 数 は成 功 しません。
リスト を解 放 する前 に、保 留 になっている読 み取 りが他 にないことを確 認 します。現 在 の
ctListRead() がすべて返 されてから、リスト を削 除 してください。

シンタックス
ctListRead(hList, pctOverlapped)
hList

タイプ: ハンドル
入 力 /出 力 :入 力
説 明 : ctListNew() から返 されるリスト へのハンドル。

pctOverlapped

135
Chapter: 4 CtAPI関数

タイプ: CTOVERLAPPED*
入 力 /出 力 :入 力
説 明 : CTOVERLAPPED 構 造 。この構 造 は、重 複 する通 知 をコント ロールするために使 用 します。同 期
関 数 を呼 び出 したい場 合 は、NULL に設 定 します。

戻 り値
この関 数 が成 功 した場 合 、戻 り値 は TRUE になります。この関 数 が成 功 しなかった場 合 、戻
り値 は FALSE になります。詳 細 なエラー情 報 を入 手 するには、GetLastError() を呼 び出 しま
す。
I/O デバイスからのリスト データの読 み取 り中 にエラーが発 生 した場 合 は、戻 り値 は FALSE に
なり、GetLastError() は関 連 するCitectSCADAエラー コード を返 します。ひとつのリスト にたくさ
んのデータ ソースからのタグが含 まれている場 合 があるため、正 しく読 み取 られるタグもあれば、
読 み取 られないタグもあります。いずれかのタグが成 功 しなかった場 合 、ctListRead() は
FALSE を返 しますが、その他 のタグには有 効 なデータが含 まれます。ctListData() を呼 び出 し
て、リスト 上 の各 タグの値 および各 タグの個 別 のエラー ステータスを取 得 できます。

関連項目
ctOpen、ctListNew、ctListFree、ctListAdd、ctListWrite、ctListData、ctListItem

例
ctListNew を参 照 してください
ctListRead を使 用 してアラーム プロパティのページングを読 み取 るには

HANDLE hList;
HANDLE hAlarmOne;
HANDLE hAlarmTwo;
hList = ctListNew(hCTAPI, 0);
hTagOne = ctListAdd(hList, "AlarmOne.Paging");
hTagTwo = ctListAdd(hList, "AlarmTwo.Paging");
while (you want the data) {
ctListRead(hList, NULL);
ctListData(hAlarmOne, sBufOne, sizeof(sBufOne), 0);
ctListData(hAlarmTwo, sBufTwo, sizeof(sBufTwo) , 0);
}
ctListFree(hList);

ctOpen
CitectSCADAAPI への接 続 を開 きます。CTAPI.DL が初 期 化 され、CitectSCADA への接 続
が確 立 します。この関 数 が呼 び出 された場 合 にCitectSCADAが実 行 中 でなかった場 合 、関
数 は終 了 し、エラーがレポート されます。この関 数 は、他 のあらゆる CTAPI 関 数 が
CitectSCADA への接 続 を初 期 化 する前 に呼 び出 される必 要 があります。

136
 Chapter: 4 CtAPI関数

CT_OPEN_RECONNECT モード を使 用 していて接 続 が失 われた場 合 、CTAPI は

CitectSCADA 再 接 続 を試 みます。再 び接 続 が確 立 されたら、継 続 して CTAPI を使 用 するこ
とができます。ただし、接 続 が失 われている間 は、すべての関 数 はエラーを返 します。最 初 に
ctOpen() が呼 び出 された時 に接 続 が確 立 できない場 合 でもハンド ルは返 されます
が、GetLastError() はエラーを表 示 します。
CT_OPEN_RECONNECT モード を使 用 していない場 合 で CitectSCADA への接 続 が失 われ
た場 合 は、CTAPI は ctClose() を呼 び出 して接 続 を解 放 します。その後 、ctOpen() を呼 び出
して接 続 を再 確 立 し、すべてのハンド ルを作 成 し直 します。

注 : CitectSCADA をインスト ールせずにリモート コンピュータで CTAPI を使 用 するには、次

のファイルを[bin] ディレクト リからお使 いのリモート コンピュータにコピーする必 要 がありま
す。CTAPI.DLL、CT_IPC.DLL、CTENG32.DLL、CTRES32.DLL、CTUTIL32.DLL および
CIDEBUGHELP.DLL。

リモート コンピュータからこの関 数 を呼 び出 す場 合 は、有 効 なユーザー名 と空 白 でないパス

ワード を使 用 する必 要 があります。

シンタックス
ctOpen(sComputer, sUser, sPassword, nMode)
sComputer

タイプ: LPCSTR
入 力 /出 力 :入 力
説 明 : CTAPI を通 じて通 信 したいコンピュータ。ローカル接 続 では、コンピュータ名 を NULL に指 定 しま
す。[Windows コンピュータ名 ] は、Windows コント ロール パネルの [ネット ワーク] セクションの [識 別 ]
タブで指 定 された名 前 です。

sUser

タイプ: LPCSTR
入 力 /出 力 :入 力
説 明 : 接 続 したいコンピュータ上 で実 行 されているCitectSCADAプロジェクト で定 義 されたユーザー名 。こ
の引 数 は、リモート コンピュータからこの関 数 を呼 び出 す場 合 にのみ必 要 です。ローカルのコンピュータで
はこれはオプションです。

sPassword

タイプ: LPCSTR
入 力 /出 力 :入 力
説 明 : 接 続 したいコンピュータ上 で実 行 されているCitectSCADAプロジェクト で定 義 されたパスワード。こ
の引 数 は、リモート コンピュータからこの関 数 を呼 び出 す場 合 にのみ必 要 です。パスワードを空 白 にする
ことはできません。ローカルのコンピュータではこれはオプションです。

nMode

137
Chapter: 4 CtAPI関数

タイプ: DWORD
入 力 /出 力 :入 力
説 明 : Cicodeの呼 び出 しモード。これを0 (ゼロ)に設 定 します。以 下 のモードがサポート されています。

CT_OPEN_RECONNECT - エラーまたは通 信 が失 われた接 続 を再 開 しま

す。CitectSCADAへの接 続 が失 われた場 合 、CTAPI は継 続 し
てCitectSCADAに再 接 続 しようとします。
CT_OPEN_READ_ONLY - CTAPIを読 み取 り専 用 モード で開 きます。これにより、
データへの読 み取 り専 用 アクセスが可 能 になります。ただし、CitectSCADAに
変 数 を書 き込 むことや、Cicode関 数 を呼 び出 すことはできません。
CT_OPEN_BATCH - エラーが発 生 すると、メッセージ ボックスの表 示 を無 効 にしま
す。

戻 り値
この関 数 が成 功 すると、戻 り値 がハンド ルを指 定 します。この関 数 が成 功 しなかった場 合 、戻
り値 はNULLになります。GetLastError()を使 用 して、詳 細 なエラー情 報 を入 手 します。

関連項目
ctCiCode, ctClose, ctEngToRaw, ctGetOverlappedResult, ctHasOverlappedIoCompleted,
ctRawToEng, ctTagRead, ctTagWrite, ctTagWrite

HANDLE hCTAPI;
hCTAPI = ctOpen(NULL, NULL, NULL, 0);
if (hCTAPI == NULL) {
dwStatus = GetLastError(); // get error
} else {
ctTagWrite(hCTAPI, "SP123", "1.23");
ctClose(hCTAPI);
}
// example of open for remote TCP/IP connection.
hCTAPI = ctOpen("203.19.130.2", "ENGINEER", "CITECT", 0);

ctOpenEx
任 意 のクライアント インスタンスを使 用 してCtAPIサーバーへの接 続 を確 立 します。クライアント
インスタンスは、CtOpenExを呼 び出 す前 にCtClientCreate関 数 を使 用 して作 成 される必 要 が
あります。
CtOpenEx は、CtOpenとまったく同 じ接 続 機 能 を提 供 します。唯 一 の違 いは、CtOpen
はCtAPIクライアント インスタンスも作 成 する点 です。関 連 する接 続 のメ仕 組 みやパラメータに
ついての詳 細 は、ctOpen参 照 してください。

138
 Chapter: 4 CtAPI関数

シンタックス
ctOpenEx(sComputer, sUser, sPassword, nMode, hCTAPI);
sComputer

タイプ: LPCSTR
入 力 /出 力 :入 力
説 明 : CTAPIを通 じて通 信 したいコンピュータ。ローカル接 続 では、コンピュータ名 をNULLに指 定 しま
す。[Windows コンピュータ名 ] は、Windowsコント ロール パネルの [ネット ワーク] セクションの [識 別 ] タ
ブで指 定 された名 前 です。

sUser

タイプ: LPCSTR
入 力 /出 力 :入 力
説 明 : 接 続 したいコンピュータ上 で実 行 されているCitectSCADAプロジェクト で定 義 されたユーザー名 。こ
の引 数 は、リモート コンピュータからこの関 数 を呼 び出 す場 合 にのみ必 要 です。ローカルのコンピュータで
はこれはオプションです。

sPassword

タイプ: LPCSTR
入 力 /出 力 :入 力
説 明 : 接 続 したいコンピュータ上 で実 行 されているCitectSCADAプロジェクト で定 義 されたパスワード。こ
の引 数 は、リモート コンピュータからこの関 数 を呼 び出 す場 合 にのみ必 要 です。パスワードを空 白 にする
ことはできません。ローカルのコンピュータではこれはオプションです。

nMode

タイプ: Dword
入 力 /出 力 :入 力
説 明 ：:Cicodeの呼 び出 しモード。これを0 (ゼロ)に設 定 します。

hCTAPI

タイプ: ハンドル
入 力 /出 力 :入 力
説 明 : ctOpen()から返 されるCTAPIへのハンドル。

戻 り値
成 功 した場 合 はTRUE、そうでなければFALSEとなります。GetLastError()を使 用 して、詳 細 な
エラー情 報 を入 手 します。

関連項目
ctClientCreate, ctOpen, ctClose, ctCloseEx, ctClientDestroy

139
Chapter: 4 CtAPI関数

例
ctClientCreate を参 照 してください

ctRawToEng
生 のI/Oデバイス スケール変 数 を換 算 スケールに変 換 します。タグ関 数 の場 合
はCitectSCADAがスケーリングを行 うので必 要 ありません。スケーリングはデジタルや文 字 列 に
は必 要 ありません。また、I/Oデバイスの値 とエンジニアリングの値 との間 でスケーリングが発 生 し
ない場 合 も、スケーリングは不 要 です。CitectSCADAの変 数 タグ表 で指 定 された、各 変 数 の
スケーリングを知 っておく必 要 があります。

シンタックス
ctRawToEng(pResult, dValue, pScale, dwMode)
pResult

タイプ: ダブル
入 力 /出 力 :出 力
説 明 ：結 果 として返 されるスケールされた生 の変 数 。

dValue

タイプ: ダブル
入 力 /出 力 :入 力
説 明 : スケーリングのための換 算 値 。

pScale

タイプ: CTSCALE*
入 力 /出 力 :入 力
説 明 : 変 数 のスケーリング プロパティ。

dwMode

タイプ: Dword
入 力 /出 力 :入 力
説 明 : スケーリングのモード。以 下 のモードがサポート されています。

CT_SCALE_RANGE_CHECK - 結 果 の範 囲 をチェックします。変 数 が範 囲 外 で
ある場 合 はエラーが生 成 されます。pResultには生 のスケール値 が含 まれてい
ます。
CT_SCALE_CLAMP_LIMIT - 最 大 または最 小 のスケールに制 限 を固 定 します。
結 果 が範 囲 外 である場 合 は、結 果 を最 小 または最 大 スケール ( どちらか近
い方 ) に設 定 します。スケールが固 定 されている場 合 、エラーは生 成 されませ
ん。CT_SCALE_RANGE_CHECKまたはCT_SCALE_NOISE_FACTORオプ
ションと一 緒 に使 用 することはできません。

140
 Chapter: 4 CtAPI関数

CT_SCALE_NOISE_FACTOR - 範 囲 チェックの制 限 値 にノイズ要 因 を考 慮 しま

す。変 数 が範 囲 外 であってもそれが0.1 %以 内 である場 合 は、範 囲 エラーは
生 成 されません。

戻 り値
成 功 した場 合 はTRUE、そうでなければFALSEとなります。GetLastError()を使 用 して、詳 細 な
エラー情 報 を入 手 します。

関連項目
ctOpen, ctEngToRaw

// SP123 is type INTEGER and has raw scale 0 to 32000 and Eng scale
0 to 100
HANDLE hList = ctListNew(s_hCTAPI, 0);
HANDLE hTag = ctListAddEx(hList, "SP123", TRUE, 500, -1);
CTSCALE Scale = { 0.0, 32000.0, 0.0, 100.0};
CHAR valueBuf[256] = {0};
double dRawValue = 0.0;
double dSetPoint = 0.0;
ctListRead(hList, NULL);
ctListData(hTag, valueBuf, sizeof(valueBuf), 0);
dRawValue = strtod(valueBuf, NULL);
ctEngToRaw(&dSetPoint, dRawValue, &Scale, CT_SCALE_RANGE_CHECK);
// dSetPoint now contains the Engineering scaled setpoint.

ctTagGetProperty
任 意 のタグから任 意 のプロパティを取 得 します。

シンタックス
ctTagGetProperty( hCTAPI, szTagName, szProperty, pData, dwBufferLength, dwType)
hCTAPI

タイプ: ハンドル
入 力 /出 力 :入 力
説 明 : ctOpen()から返 されるCTAPIへのハンドル。

szTagName

タイプ: LPCSTR
入 力 /出 力 :入 力
説 明 : タグの名 前 。クラスタを指 定 するには、タグの前 に「ClusterName.」を追 加 します。例 え
ば、Cluster1.Tag1 (クラスタ名 の最 後 にピリオドがあることに注 意 してください) のようにします。

141
Chapter: 4 CtAPI関数

szProperty

タイプ: LPCSTR
入 力 /出 力 :入 力
説 明 : 読 み取 り用 プロパティ。プロパティ名 は、大 文 字 小 文 字 の区 別 をします。以 下 のプロパティがサ
ポート されています。

ArraySize: 関 連 するタグの配 列 サイズ。配 列 タイプ以 外 は1。

DataBitWidth: 値 を保 存 するために使 用 されるビット 数 。
説 明 ：タグの説 明 。
EngUnitsHigh: 最 大 スケール値 。
EngUnitsLow: 最 小 スケール値 。
フォーマット : ビット 文 字 列 フォーマット 。フォーマット 情 報 は以 下 のような整 数 値 で保
存 されます。
l Bits 0-7 - フォーマット 幅

l Bits 8-15 - 小 数 点 以 下 の桁 数

l Bits 16 - ゼロ埋 め

l Bit 17- 左 詰 め

l Bit 18 - 換 算 値 単 位 の表 示

l Bit 20 - 指 数 関 数 (科 学 的 ) 表 記

FormatDecPlaces: デフォルト のフォーマット での小 数 点 以 下 の桁 数

FormatWidth: デフォルト のフォーマット で使 用 される文 字 数
RangeHigh: 最 大 非 スケール値
RangeLow: 最 小 非 スケール値
タイプ：数 字 で示 すタグのタイプ
l 0 = デジタル

l 1 = バイト

l 2 = 整 数 16

l 3 = UInteger16

l 4 = ロング

l 5 = 実数

l 6 = 文字列

l 7 = ULong

l 8 = 未定義

単 位 ：% 、mm、ボルト などの換 算 値 単 位 。
pData

タイプ: VOID*
入 力 /出 力 :出 力
説 明 ：取 得 されたプロパティ値 の出 力 データバッファ。

dwBufferLength

142
 Chapter: 4 CtAPI関数

タイプ: DWORD
入 力 /出 力 :入 力
説 明 : バイト 単 位 の出 力 データバッファの長 さ。

dwType

タイプ: DWORD
入 力 /出 力 :入 力
説 明 : 返 すデータタイプ。

値 意味

DBTYPE_U11 UCHAR

DBTYPE _I1 1 byte INT

DBTYPE _I2 2 byte INT

DBTYPE _I4 4 byte INT

DBTYPE _R4 4 byte REAL

DBTYPE _R8 8 byte REAL

DBTYPE _BOOL ブール型

DBTYPE_BYTES バイト スト リーム

DBTYPE _STR NULL によって終 了 した文 字 列

戻 り値
この関 数 が成 功 すると、戻 り値 は「0」以 外 の値 になります。この関 数 が成 功 しなかった場 合 、
戻 り値 はゼロになります。詳 細 なエラー情 報 を入 手 するには、GetLastError()を呼 び出 します。

ctTagRead
値 だけではなく、値 、品 質 およびタイムスタンプを読 み取 ります。データは文 字 列 フォーマット で
戻 され、CitectSCADA スケールを使 用 してスケーリングされます。
この関 数 は、CitectSCADAI/Oサーバーから任 意 のタグをリクエスト します。タグがI/Oサーバー デ
バイスのキャッシュにある場 合 、データはキャッシュから返 されます。タグがデバイスのキャッシュに
ない場 合 は、そのタグはI/Oデバイスから読 み取 られます。この関 数 の完 了 までにかかる時 間
は、I/Oデバイスのパフォーマンスに依 存 します。読 み取 りが完 了 するまで、呼 び出 しスレッド は
ブロックされます。

143
Chapter: 4 CtAPI関数

シンタックス
ctTagRead(hCTAPI, sTag, sValue, dwLength)
hCTAPI

タイプ: ハンドル
入 力 /出 力 :入 力
説 明 : ctOpen()から返 されるCTAPIへのハンドル。

sTag

タイプ: LPCSTR
入 力 /出 力 :入 力
説 明 : タグ名 または、ドット で区 切 られたタグ名 と要 素 名 です。要 素 名 が指 定 されていない場 合 、ランタイ
ムで、完 全 修 飾 名 ではないタグ参 照 として扱 われます。配 列 シンタックス[]を使 用 して配 列 の要 素 を選
択 することもできます。

sValue

タイプ: LPCSTR
入 力 /出 力 :出 力
説 明 ：読 み取 ったデータを保 存 するバッファ。データは文 字 列 フォーマット で返 されます。

dwLength

タイプ: Dword
入 力 /出 力 :入 力
説 明 : 読 み取 りバッファの長 さ。データがdwLengthより長 い場 合 、関 数 は成 功 しません。

戻 り値
成 功 した場 合 はTRUE、そうでなければFALSEとなります。GetLastError()を使 用 して、詳 細 な
エラー情 報 を入 手 します。

関連項目
ctOpen, ctTagWrite, ctTagWriteEx

HANDLE hCTAPI = ctOpen(NULL, NULL, NULL, 0);

char sProcessValue[20];
char sProcessValueField[20];
char sProcessValueControlMode[20];
char sProcessValueStatus[20];
ctTagRead(hCTAPI,"PV123", sProcessValue, sizeof(sProcessValue));
ctTagRead(hCTAPI,"PV123.Field", sProcessValueField,
sizeof(sProcessValueField));

144
 Chapter: 4 CtAPI関数

ctTagRead(hCTAPI,"PV123.Field.V", sProcessValueField,
sizeof(sProcessValueField));
ctTagRead(hCTAPI,"PV123.ControlMode",sProcessValueControlMode,
sizeof(sProcessValueControlMode));
ctTagRead(hCTAPI, "PV123.Status", sProcessValueStatus,
sizeof(sProcessValueStatus));

ctTagWrite
任 意 のCitectSCADAI/Oデバイス変 数 タグに書 き込 みます。値 だけでなく、値 、品 質 およびタイ
ムスタンプが正 しいデータ型 に変 換 、スケーリングされた後 にタグに書 き込 まれます。ひとつの配
列 要 素 のみに書 き込 む場 合 は、その要 素 のみに書 き込 まれます。この関 数 は、I/Oサーバー
への書 き込 みリクエスト を生 成 します。この関 数 の完 了 までにかかる時 間 は、I/Oデバイスのパ
フォーマンスに依 存 します。書 き込 みが完 了 するまで、呼 び出 しスレッド はブロックされます。書
き込 み操 作 は、リード /ライト の権 限 を持 つタグ要 素 でのみ成 功 します。

シンタックス
ctTagWrite(hCTAPI, sTag, sValue)
hCTAPI

タイプ: ハンドル
入 力 /出 力 :入 力
説 明 : ctOpen()から返 されるCTAPIへのハンドル。

sTag

タイプ: LPCSTR
入 力 /出 力 :入 力
説 明 : タグ名 または、ドット で区 切 られたタグ名 と要 素 名 です。要 素 名 が指 定 されていない場 合 、ランタイ
ムで、完 全 修 飾 名 ではないタグ参 照 として扱 われます。配 列 シンタックス[]を使 用 して配 列 の要 素 を選
択 することもできます。

sValue

タイプ: LPCSTR
入 力 /出 力 :入 力
説 明 : 文 字 列 としてタグに書 き込 む値 。

戻 り値
成 功 した場 合 はTRUE、そうでなければFALSEとなります。GetLastError()を使 用 して、詳 細 な
エラー情 報 を入 手 します。

関連項目
ctOpen, ctTagWrite, ctTagRead

145
Chapter: 4 CtAPI関数

HANDLE hCTAPI = ctOpen(NULL, NULL, NULL, 0);

ctTagWrite (hCTAPI,"PV123", "123.12");

ctTagWrite (hCTAPI,"PV123.Field", "123.12");
ctTagWrite (hCTAPI,"PV123.Field.V", "123.12");
ctTagWrite (hCTAPI,"PV123.ControlMode", "1");
ctTagWrite (hCTAPI,"PV123.Status", "0");

ctTagWriteEx
ctTagWriteと同 じ動 作 を行 いますが、追 加 の新 しい引 数 が含 まれます。任 意
のCitectSCADAI/Oデバイス変 数 タグに書 き込 みます。値 だけでなく、値 、品 質 およびタイムス
タンプが正 しいデータ型 に変 換 、スケーリングされた後 にタグに書 き込 まれます。ひとつの配 列
要 素 のみに書 き込 む場 合 は、その要 素 のみに書 き込 まれます。この関 数 は、I/Oサーバーへの
書 き込 みリクエスト を生 成 します。この関 数 の完 了 までにかかる時 間 は、I/Oデバイスのパフォー
マンスに依 存 します。
pctOverlappedの値 がNULLの場 合 、関 数 はctTagWriteと同 じように動 作 し、スレッド の呼 び
出 しは書 き込 みが完 了 するまでブロックされます。pctOverlappedの値 がNULLでない場 合 、
書 き込 みは非 同 期 で行 われ、スレッド の呼 び出 しはブロックされません。

シンタックス
ctTagWriteEx(hCTAPI, sTag, sValue, pctOverlapped)
hCTAPI

タイプ: ハンドル
入 力 /出 力 :入 力
説 明 : ctOpen()から返 されるCTAPIへのハンドル。

sTag

タイプ: LPCSTR
入 力 /出 力 :入 力
説 明 : 書 き込 むためのタグ名 または、ドット で区 切 られたタグ名 と要 素 名 です。要 素 名 が指 定 されていな
い場 合 、ランタイムで、完 全 修 飾 名 ではないタグ参 照 として扱 われます。配 列 シンタックス[]を使 用 して
配 列 の要 素 を選 択 することもできます。

sValue

タイプ: LPSTR
入 力 /出 力 :入 力
説 明 : 文 字 列 としてタグに書 き込 む値 。

pctOverlapped

146
 Chapter: 4 CtAPI関数

タイプ: CTOVERLAPPED*
入 力 /出 力 :入 力
説 明 : ctTagWriteExが非 同 期 でも完 了 できるようにする、重 複 構 造 のパス。pctOverlapped構 造
がNULLの場 合 、関 数 はブロックされ、同 期 に完 了 します。

戻 り値
成 功 した場 合 はTRUE、そうでなければFALSEとなります。GetLastError()を使 用 して、詳 細 な
エラー情 報 を入 手 します。

関連項目
ctOpen, ctTagRead

AlmQuery
外 部 アプリケーションからアラーム サマリ アーカイブへのインターフェースを提 供 し、古
いCtAPIAlarm クエリーを置 き換 えます。AlmQueryはCtAPIAlarmと比 較 して非 常 に優 れて
います。
AlmQueryはCtAPIAlarm と同 様 なメカニズムで動 作 します。クエリーを確 立 して最 初 のレコー
ド を返 すには、ctFindFirstを呼 び出 します。その後 、残 りのレコード を参 照 するに
は、ctFindNextを呼 び出 します。現 在 のレコード からデータにアクセスするには、レコード の各 フ
ィールド に対 してctGetPropertyを呼 び出 します。
ctFindFirstは、以 下 のようなパラメータを指 定 して呼 び出 されます。
l hCtapi:有 効 な Ctapi クライアント インスタンスへのハンド ル。
l szTableName:almquery のコマンド 文 字 列 。以 下 を参 照 してください。
l szFilter:Almquery では使 用 されません。NULLを渡 します。
l hObject:クエリーで取 得 された最 初 のレコード へのハンド ル。
l dwFlags:Almquery では使 用 されません。0を渡 すのみです。
szTableName はクエリー用 のコマンド 文 字 列 です。これにはクエリー用 のパラメータが含 まれお
り、以 下 の形 式 にしなければなりません。

シンタックス
`ALMQUERY,Database,TagName,Starttime,StarttimeMs,Endtime,EndtimeMs,Period'

注 ：引 数 はコンマ (,) で区 切 る必 要 があります。引 数 間 のスペースはサポート されています

が不 要 です。引 数 にスペースを入 れると処 理 に時 間 を要 し、クエリー文 字 列 にさらにス
ペースが取 られるため、スペースを入 れないよう推 奨 しています。

データベース:

147
Chapter: 4 CtAPI関数

アラームが含 まれるアラーム データベース (アラーム タイプ)。以 下 のデータベースがサポート されていま

す。DigAlm (デジタル)、AnaAlm (アナログ)、AdvAlm (高 機 能 )、HResAlm (タイムスタンプつ
き)、ArgDigAlm (マルチデジタル)、ArgAnaAlm (アーガイル アナログ)、TsDigAlm (タイムスタンプ付 きデ
ジタル)、TsAnaAlm (タイムスタンプ付 きアナログ)。

TagName:

文 字 列 としてのアラーム タグ。このクエリーは、1 回 に 1 つのアラームのアラーム データの取 得 のみをサ

ポート します。CitectSCADA ではサポート されていますが、同 じタイプの同 じタグを使 って、2 つの異 なるア
ラームを宣 言 することはできません。このクエリーはアラーム タイプ (データベース) とタグの組 み合 わせが一
意 であることを期 待 するため、両 方 のアラーム データを取 得 することはできません。

Starttime:

アラーム クエリーの開 始 時 刻 を 1970 年 以 降 の整 数 の秒 単 位 で、UTC 時 刻 (協 定 世 界 時 ) を使 用 し

て表 示 します。

StarttimeMs:

開 始 時 刻 のミリ秒 部 分 を整 数 で表 示 します。この値 には 0 から 999 を使 用 します。

Endtime:

アラーム クエリーの終 了 時 刻 を 1970 年 以 降 の整 数 の秒 単 位 で、UTC 時 刻 (協 定 世 界 時 ) を使 用 し

て表 示 します。

EndtimeMs:

終 了 時 刻 のミリ秒 部 分 を整 数 で表 示 します。この値 には 0 から 999 を使 用 します。

Period:

浮 動 小 数 点 の値 として返 されたサンプル間 の時 間 を秒 で表 示 します。サポート されている小 数 点 記 号

は「.」のみですのでご注 意 ください。

戻 り値
返 されたサンプルの最 大 数 で、時 間 の範 囲 を周 期 で割 った値 + 3 です (終 了 時 刻 のサンプル
が 1 つ、前 および次 のサンプルがそれぞれ 1 つ)。

注 :周 期 は等 間 隔 に時 分 割 する必 要 があります。そうしないと、1 つ余 分 なサンプルが返 さ

れる場 合 があります。

Almqueryは、アラーム サンプルのない周 期 に補 完 されたサンプルを返 すことは決 してありませ

ん。ただし、返 されるサンプルの最 大 数 が適 用 されていることを確 認 するために、1 つの周 期 に
複 数 のサンプルが発 生 した場 合 、生 のアラーム サンプルは圧 縮 されます。
このような圧 縮 が発 生 した場 合 、返 されるサンプルは複 数 サンプルとしてフラグされます。タイム
スタンプは、その周 期 内 のサンプルの平 均 になります。返 される値 やコメント は、常 にその周 期
の最 後 のサンプルを反 映 します。
以 下 のプロパティがクエリーの各 データ レコード に返 されます。

148
 Chapter: 4 CtAPI関数

l DateTime：アラーム サンプルの時 刻 を 1970 年 以 降 の整 数 の秒 単 位 で表 示 します。この

時 刻 は、UTC 時 刻 (協 定 世 界 時 ) を使 用 します。
l MSeconds:ト レンド サンプルの時 刻 のミリ秒 部 分 を整 数 で表 示 します。この値 には 0 から
999 を使 用 します。
l Comment:文 字 列 のアラームサンプルに関 連 したコメント
l 値 ：サンプルのアラーム値 を符 号 なし整 数 で表 示 します。アラーム値 の詳 細 は以 下 を参 照
してください。アラーム値 には、サンプルを取 得 した時 のアラームのマルチステート を説 明 する
重 要 情 報 のすべてが含 まれています。
bGood (ビット 0)- 将 来 的 に使 用 するもので、アラーム データの品 質 が悪 化 した場
合 に表 示 するように意 図 されています。その際 、このビット を 1 に設 定 された
すべてのサンプルは正 常 であることを示 しています。
bDisabled (ビット 1)- サンプル使 用 時 にアラームが無 効 になっている場 合 は 1 、そう
でなければ 0 になります。
bMultiple (ビット 2)- アラーム サンプルが複 数 の生 サンプルをベースにしている場 合
は 1、単 一 の生 サンプルのみをベースにしている場 合 は 0 になります。
bOn (ビット 3)- サンプル使 用 時 にアラームがオンになっている場 合 は 1 、そうでなけ
れば 0 になります。
bAck (ビット 4)- サンプル使 用 時 にアラームが確 認 されれば 0 になります。
state (ビット 5 - 7)- サンプル使 用 時 のアラームのマルチステート に関 する情 報 が含 ま
れています。
アラームマルチステート は、アラームのタイプごとに異 なるマルチステート を示 します。こ
のマルチステート には、アラームがオンになっている場 合 の該 当 する情 報 のみ
が含 まれています。
アナログの場 合 、アーガイル アナログ、およびタイムスタンプ付 きアナログ アラーム の
マルチステート として以 下 があります。

l Expired (0)- アラームマルチステート の情 報 の期 限 が切 れています。アラームがど

のようなマルチステート かはわかりません。現 在 オンになっていることだけわかりま
す。citect.ini パラメータの [Alarm]SumStateFix を 0 に設 定 すると、このようにア
ラームマルチステート がわからなくなります。
l Deviation High (1)- アラームが指 定 された限 界 値 以 上 に高 くセット ポイント か
らそれています。
l Deviation Low (2)- アラームが指 定 された限 界 値 以 上 に低 くセット ポイント から
それています。
l Rate of Change (3)- アラームが予 想 以 上 に速 く変 化 しました。
l Low (4)- アラームが下 限 の値 の範 囲 に入 りました。
l High (5)- アラームが上 限 の値 の範 囲 に入 りました。
l Low Low (6)- アラームが下 下 限 の値 の範 囲 に入 りました。

149
Chapter: 4 CtAPI関数

l High High (7)- アラームが上 上 限 の値 の範 囲 に入 りました。

マルチ デジタル アラームでは、以 下 のようなマルチステート になります。

l 000 (0)- アラームのデジタル タグがオフです。

l 00A (1)- タグ Aはオンですが、B と Cはオフです。
l 0B0 (2)- タグ Bはオンですが、A と Cはオフです。
l 0BA (3)- タグ B と Aはオンですが、Cはオフです。
l C00 (4)- タグ Cはオンですが、B と Cはオフです。
l C0A (5)- タグ C と Aはオンですが、Bはオフです。
l CB0 (6)- タグ C と Bはオンですが、Aはオフです。
l CBA (7)- アラームのデジタル タグがオンです。
その他 のアラーム タイプについては、マルチステート に関 する情 報 は無 視 される必 要
があります。

TrnQuery
外 部 アプリケーションからト レンド アーカイブに強 力 なインターフェースを提 供 し、古
いCtAPITrend クエリーを置 き換 えます。TrnQuery では CtAPITrend よりかなりパーフォーマン
スが向 上 します。
TrnQuery は CtAPITrend と同 様 のメカニズムで動 作 します。クエリーを確 立 して最 初 のレコー
ド を返 すには、ctFindFirst を呼 び出 します。その後 、残 りのレコード を参 照 するに
は、ctFindNext を呼 び出 します。現 在 のレコード からデータにアクセスするには、レコード の各 フ
ィールド に ctGetProperty を呼 び出 します。
ctFindFirst は、以 下 のようなパラメータを指 定 して呼 び出 されます。

l hCtapi:有 効 な Ctapi クライアント インスタンスへのハンド ル。

l szTableName:Trnquery のコマンド 文 字 列 。以 下 を参 照 してください。
l szFilter:Trnquery では使 用 されません。NULL を渡 します。
l hObject:クエリーで取 得 された最 初 のレコード へのハンド ル。
l dwFlags:Trnquery では使 用 されません。0 を渡 すのみです。
szTableNameはクエリーで取 得 されたコマンド 文 字 列 です。クエリーで取 得 されたすべてのパラ
メータが含 まれています。

シンタックス
TRNQUERY
,
Endtime
,EndtimeMs,Period,NumSamples,Tagname,Displaymode,Datamode,InstantTrend,SamplePeriod'

150
 Chapter: 4 CtAPI関数

注 ：引 数 の分 類 はコンマ (,) で分 離 する必 要 があります。引 数 間 のスペースはサポート さ

れていますが、必 要 というわけではありません。引 数 にスペースを入 れると処 理 に時 間 を要
し、クエリー文 字 列 にさらにスペースが取 られるため、スペースを入 れないよう推 奨 していま
す。

Endtime:

ト レンド クエリーの終 了 時 刻 を 1970 年 以 降 の整 数 秒 単 位 で表 示 します。時 間 は UTC 時 間 (万 国 共

通 時 間 ) と予 測 されます。

EndtimeMs:

整 数 値 の終 了 時 刻 のミリ秒 の部 分 で、0～ 999 間 の数 字 と予 測 されます。

Period:

浮 動 小 数 点 の値 として返 されたサンプル間 の時 間 を秒 で表 示 します。サポート されている小 数 点 記 号

は「.」のみですのでご注 意 ください。

NumSamples:

整 数 値 としてリクエスト されたサンプル数 。リクエスト の開 始 時 刻 は、周 期 に NumSamples を乗 算 して 1

を減 算 し、これを EndTime から減 算 して計 算 します。

戻 された実 際 の最 大 サンプル数 は NumSamples+2 です。これはリクエスト 範 囲 の前 後 に先 および次 の

サンプルを返 すからです。リクエスト した前 後 に次 のデータがどこにあるかわかるので便 利 です。

TagName:

ト レンド タグの名 前 を文 字 列 として返 します。このクエリーは、1 回 に 1 つのト レンドのト レンド データの取

得 のみをサポート します。

DisplayMode:

符 号 なし整 数 として、クエリーのサンプルのフォーマット および計 算 に対 する異 なるオプションを指 定 しま

す。表 示 モードを参 照 してください。

DataMode:

整 数 値 としてのこのリクエスト のモード。完 全 な精 度 のタイムスタンプを返 す場 合 は 1。モード 1 は、値 が

ない場 合 、サンプルを補 間 しません。タイムスタンプを周 期 ごとに 1 回 計 算 する場 合 は 0。モード 0 は、値
がない場 合 、サンプルを補 間 しません。

InstantTrend:

クエリーがインスタント ト レンド用 かどうかを指 定 する整 数 。インスタント ト レンド用 であれば、1 です。イン

スタント ト レンド用 でなければ、0 です。

SamplePeriod:

インスタント ト レンドのタグ値 に対 する必 要 なサンプル周 期 をミリ秒 で指 定 する整 数 。

151
Chapter: 4 CtAPI関数

戻 り値
戻 り値 については、返 されたデータを参 照 してください。

表 示 モード
返 されたデータは、TrnQueryの表 示 モード により大 きく異 なります。表 示 モード は、次 の相 互
に排 他 的 なオプションに分 割 されます。
ト レンド サンプル オプションの順 序 付 け
l 0 - 返 されたサンプルを古 いものから順 番 に並 べる
l 1 - 返 されたサンプルを新 しいものから順 番 に並 べる生 データ オプションが指 定 されている
場 合 には、このモード はサポート されません。
縮 小 メソッド オプション
l 0 - 圧 縮 法 をサンプル平 均 値 を使 用 するためにに設 定 する
l 4 - 圧 縮 法 をサンプルの最 小 値 を使 用 するために設 定 する
l 8 - 圧 縮 法 をサンプルの最 大 値 を使 用 するために設 定 する
l 12 - 圧 縮 法 をサンプルの最 新 値 を使 用 するために設 定 する
拡 大 メソッド オプション
l 0 - 拡 張 法 をステップに設 定 する
l 128 - 拡 張 法 を比 率 を使 用 するために設 定 する
l 256 - 拡 張 法 を生 サンプルを使 用 するために設 定 する (補 間 なし)。
ギャップ 埋 め定 数 オプション
l n - ユーザがギャップ埋 めをしたい未 処 理 のサンプル数 ) x 4096。
最 終 有 効 値 オプション
l 0 - 品 質 の悪 いサンプルにより与 えられた値 を0としておく場 合 。
l 2097152 - 品 質 の悪 いサンプルの値 を最 終 有 効 値 に設 定 した場 合 (最 終 有 効 値 がない
場 合 はゼロ)。
生 データ オプション
l 0 - 生 データを返 さない場 合 、つまり縮 小 または拡 大 モード を使 用 してデータを圧 縮 または
補 間 する場 合 。
l 4194304 - 完 全 な生 データを返 す場 合 、つまり圧 縮 または補 間 なしの場 合 。このモード
はDataModeをquery = 1に指 定 した場 合 にのみサポート されます。このモード を使 用 する
と、時 間 範 囲 内 に最 大 値 より多 い生 データがあった場 合 には、上 で指 定 した最 大 値 より
多 いサンプルが返 されます。

152
 Chapter: 4 CtAPI関数

返 されたデータ
以 下 のプロパティがクエリーの各 データ レコード に返 されます。
l DateTime：ト レンド サンプルの時 刻 を 1970年 以 降 整 数 の秒 単 位 で、UTC時 刻 (協 定 世
界 時 ) を使 用 して表 示 します。
l MSeconds:ト レンド サンプルの時 刻 のミリ秒 部 分 を整 数 で表 示 します。この値 には0から999
を使 用 します。
l 値 ：サンプルのト レンド 値 を二 倍 値 で表 示 します。
l 品 質 ：ト レンド サンプルに関 連 する品 質 情 報 を符 号 なし整 数 で表 示 します。品 質 プロパ
ティには、以 下 のように符 号 なし整 数 の異 なるビット で異 なる情 報 が含 まれています。
値 のタイプ (ビット 0 - 3)
l ValueType_None (0):このサンプルには値 がありません。サンプル値 、時 刻 、品 質 はすべ
て無 視 されます。
l ValueType_Interpolated (1):値 はデータから補 間 されました。
l ValueType_SingleRaw (2):値 は、1つの生 サンプルに基 づきます。
l ValueType_MultipleRaw (3):値 は複 数 の生 サンプルから計 算 されました。

値 の品 質 (ビット 4 - 7)
l ValueQuality_Bad (0):サンプルの値 は無 視 する必 要 があります。基 となる生 のデータが
ないためです。
l ValueQuality_Good (1):サンプルの値 は有 効 であり、いくつかの生 データに基 づきます。

最 後 の値 の品 質 (ビット 8 - 11)
l LastValueQuality_Bad (0:サンプルの値 は無 視 する必 要 があります。基 となる生 のデー
タがないためです。
l LastValueQuality_Good (1):この期 間 での最 後 の生 サンプルの値 の品 質 は良 好 でし
た。
l LastValueQuality_NotAvailable (2):この期 間 での最 後 の生 サンプルの値 の品 質 は適
用 できませんでした。
l LastValueQuality_Gated (3):この期 間 での最 後 の生 サンプルの値 の品 質 はゲート され
ました。
部 分 フラグ (ビット 12)
部 分 フラグが「1」に設 定 されると、サンプルは次 回 読 み込 まれるときに変 更 する可 能 性 が
あることを示 します。これは、サンプルを今 取 得 したばかりの場 合 、また、この周 期 により多 く
のサンプルを取 得 できる可 能 性 があるため、返 されたサンプルが必 ずしも完 了 していない場
合 に起 こります。

CtAPIAlarm
外 部 アプリケーションからアラーム サマリー アーカイブにインターフェースを提 供 します。パフォーマ
ンスを改 善 するには、代 わりに AlmQuery関 数 を使 用 してください。

153
Chapter: 4 CtAPI関数

クエリーを確 立 して最 初 のレコード を返 すには、ctFindFirstを呼 び出 します。その後 、残 りのレ

コード を参 照 するには、ctFindNextを呼 び出 します。現 在 のレコード からデータにアクセスするに
は、レコード の各 フィールド にctGetPropertyを呼 び出 します。
ctFindFirstは、以 下 のようなパラメータを指 定 して呼 び出 されます。
l hCtapi:有 効 なCtapiクライアント インスタンスへのハンド ル。
l szTableName:almqueryのコマンド 文 字 列 。以 下 を参 照 してください。
l szFilter:Almqueryでは使 用 されません。NULLを渡 します。
l hObject:クエリーで取 得 された最 初 のレコード へのハンド ル。
l dwFlags:Almqueryでは使 用 されません。0を渡 すのみです。
szTableNameはクエリー用 のコマンド 文 字 列 です。これにはクエリー用 のすべてのパラメータが含
まれています。

シンタックス
CTAPIAlarm(Category,Type,Area)

注 : 引 数 はコンマ (,) で区 切 る必 要 があります。引 数 間 のスペースはサポート されています

が、必 要 というわけではありません。引 数 にスペースを入 れると処 理 に時 間 を要 し、クエリー
文 字 列 にさらにスペースが取 られるため、スペースを入 れないよう推 奨 しています。

カテゴリ：

適 合 するアラーム カテゴリまたはグループ番 号 。すべてのアラーム カテゴリに適 合 するには、カテゴリを0 ( ゼ

ロ) に設 定 します。

タイプ:

検 索 するアラームの種 類 ：

非 ハード ウェア アラーム

l 1. すべての未 確 認 のアラーム、オンおよびオフ。
l 2. すべての確 認 済 みオンのアラーム
l 3. すべての無 効 化 されたアラーム。
l 4. すべての構 成 済 みアラーム、つまり タイプ0～ タイプ3、さらに確 認 済 みオフのア
ラーム。

タイプを指 定 しないと、このフォーマット はデフォルト で0となります。

エリア:

アラームを検 索 するエリア。エリアを指 定 しない、またはエリアを-1に設 定 すると、現 在 のエリアだけが検 索

されます。

154
 Chapter: 4 CtAPI関数

この引 数 のパスを簡 単 にするには、最 初 にCTAPIAlarm()関 数 を文 字 列 として渡 し、次 にそ

の文 字 列 を szTableName引 数 ( 引 用 符 なし) として使 用 します。

CtAPITrend
外 部 アプリケーションからト レンド アーカイブにインターフェースを提 供 し、古 いCtAPITrendクエ
リーを置 き換 えます。パフォーマンスを改 善 するには、代 わりにTrnQuery関 数 を使 用 してくださ
い。
クエリーを確 立 して最 初 のレコード を返 すには、ctFindFirstを呼 び出 します。その後 、残 りのレ
コード を参 照 するには、ctFindNextを呼 び出 します。現 在 のレコード からデータにアクセスするに
は、レコード の各 フィールド にctGetPropertyを呼 び出 します。
ctFindFirstは、以 下 のようなパラメータを指 定 して呼 び出 されます。
l hCtapi:有 効 なCtapiクライアント インスタンスへのハンド ル。
l szTableName:Trnqueryのコマンド 文 字 列 。以 下 を参 照 してください。
l szFilter:Trnqueryでは使 用 されません。NULLを渡 します。
l hObject:クエリーで取 得 された最 初 のレコード へのハンド ル。
l dwFlags:Trnqueryでは使 用 されません。0を渡 すのみです。
szTableNameはクエリーで取 得 されたコマンド 文 字 列 です。クエリーで取 得 されたすべてのパラ
メータが含 まれています。

シンタックス
CTAPITrend(sTime,sDate,Period,Length,Mode,Tag)

注 : 引 数 はコンマ (,) で区 切 る必 要 があります。引 数 間 のスペースはサポート されています

が、必 要 というわけではありません。引 数 にスペースを入 れると処 理 に時 間 を要 し、クエリー
文 字 列 にさらにスペースが取 られるため、スペースを入 れないよう推 奨 しています。

sTime:

ト レンドの開 始 時 間 。最 新 のト レンド サンプルを検 索 するには時 間 を空 の文 字 列 に設 定 します。

sDate:

ト レンドの日 付 です。

Period:

検 索 したい期 間 ( 秒 単 位 、この期 間 は実 際 のト レンド期 間 と異 なってもかまいません) 。

この関 数 が EVENT ト レンド クエリーを取 得 するために ctFindFirst() への引 数 として使 用 された場

合 、CTAPITrend() 関 数 の期 間 引 数 は 0 ( ゼロ) にしてください。

長 さ:

データ表 の長 さ、つまり検 索 するサンプルの行 数 。

155
Chapter: 4 CtAPI関数

モード :

使 用 するフォーマット モード：

周 期 ト レンド
l 1 - 日 付 および時 間 で検 索 、次 にタグで検 索 。
l 2 - 時 間 のみで検 索 、次 にタグで検 索 。
l 3 - 無 効 あるいはゲート 値 をすべて無 視 します。( このモード は周 期 ト レンド に対
してのみサポート されています。)

イベント ト レンド
l 1 - 時 間 、日 付 およびイベント 番 号 で検 索 、次 にタグで検 索 。
l 2 - 時 間 およびイベント 番 号 で検 索 、次 にタグで検 索 。
タグ:

検 索 するデータのト レンド タグ名 。

この引 数 のパスを簡 単 にするには、最 初 にCTAPITrend()関 数 を文 字 列 として渡 し、次 にその

文 字 列 をszTableName引 数 ( 引 用 符 なし) として使 用 します。

156
Chapter: 5 CSV_include リファレンス
このセクションでは、以 下 について説 明 します。
CSV_Include Cicode 関 数

CSV_include パラメータ
CSV_Include プロジェクト のみで使 用 される Citect.ini ファイルがいくつかあります。これらのパラ
メータについては、「CSV_Include パラメータ」セクションの CitectSCADA オンライン ヘルプのパ
ラメータ ト ピックを参 照 してください。

CSV_include 関 数
次 の表 で、関 数 の CSV_Include カテゴリを示 します。
関 数 のカテゴリ 関数
CSV_Include Alarms CSV_Alarms_Ack
CSV_Alarms_AckHardware
CSV_Alarms_AckPage
CSV_Alarms_AckRec
CSV_Alarms_AdvFilter
CSV_Alarms_AdvFilterConfig
CSV_Alarms_AdvFilterQuery
CSV_Alarms_AdvFilterSetDateTime
CSV_Alarms_CheckSound
CSV_Alarms_ClearGroupFilter
CSV_Alarms_Disable
CSV_Alarms_DisableRec
CSV_Alarms_DspGroupFilter
CSV_Alarms_DspGroupList
CSV_Alarms_DspInfo
CSV_Alarms_DspInfoRec
CSV_Alarms_DspLast
CSV_Alarms_Enable
CSV_Alarms_EnableRec
CSV_Alarms_GetAckPrivilege()
CSV_Alarms_GetDisablePrivilege()
CSV_Alarms_GetGroupFilter
CSV_Alarms_GetGroupFilterID
CSV_Alarms_GetUniqueGroupName
CSV_Alarms_GroupAdd
CSV_Alarms_GroupConfig()
CSV_Alarms_GroupRemove

157
Chapter: 5 CSV_include リファレンス

関 数 のカテゴリ 関数
CSV_Alarms_GroupEdit
CSV_Alarms_GroupFilter
CSV_Alarms_GroupSelect
CSV_Alarms_GroupsInit()
CSV_Alarms_Help
CSV_Alarms_HelpRec
CSV_Alarms_ListHeading
CSV_Alarms_ListHeadingFont()
CSV_Alarms_PopupMenu
CSV_Alarms_Sound()
CSV_Alarms_SoundActive()
CSV_Alarms_Silence()
CSV_Include Database CSV_DB_BOF
CSV_DB_Close
CSV_DB_EOF()
CSV_DB_Execute
CSV_DB_GetExecuteError
CSV_DB_GetFieldCount
CSV_DB_GetFieldIndex
CSV_DB_GetFieldName
CSV_DB_GetFieldText
CSV_DB_GetRowCount
CSV_DB_GetRowCurrent
CSV_DB_GetRowFieldText
CSV_DB_MoveFirst
CSV_DB_MoveLast
CSV_DB_MoveNext
CSV_DB_MoveOffset
CSV_DB_MovePrev
CSV_DB_StandbyConnectionActive
CSV_DB_StrToSQL
CSV_Include Display CSV_Display_Display_Logo
CSV_Display_Display_ServicePack()
CSV_Display_Title()
CSV_Display_Version()
CSV_Include File CSV_File_Display
CSV_File_Print
CSV_File_Save
CSV_Include Form CSV_Form_Centre
CSV_Form_Login()
CSV_Form_NumPad
CSV_Form_Position
CSV_Form_Shutdown()
CSV_Form_UserCreate()
CSV_Form_UserEdit()
CSV_Form_UserPassword()
CSV_Include ListBox CSV_ListBox_AddItem
CSV_ListBox_Clear
CSV_ListBox_Create()
CSV_ListBox_Destroy
CSV_ListBox_GetCategory
CSV_ListBox_GetItem
CSV_ListBox_GetItemID
CSV_ListBox_GetSelectedItem

158
 Chapter: 5 CSV_include リファレンス

関 数 のカテゴリ 関数
CSV_ListBox_GetSelectedItemCategory
CSV_ListBox_GetSelectedItemID
CSV_ListBox_GetTagComment
CSV_ListBox_GetTagDescFromTag
CSV_ListBox_GetTagName
CSV_ListBox_GetTrendDescFromTag()
CSV_ListBox_Hide
CSV_ListBox_RemoveItem
CSV_ListBox_SelectCategories
CSV_ListBox_SelectTags()
CSV_ListBox_SelectTrends()
CSV_ListBox_SetText
CSV_ListBox_Show
CSV_ListBox_TagFormat
CSV_ListBox_Visible
CSV_Include Math CSV_Math_RoundDown
CSV_Math_Truncate
CSV_Include MenuConfig CSV_MenuConfig_Close()
CSV_MenuConfig_Display()
CSV_MenuConfig_LoadDflt()
CSV_MenuConfig_UserPages()
CSV_Include MessageBox CSV_MessageBox

CSV_Include Misc CSV_Misc_CheckNumPadValue

CSV_Misc_IntRange
CSV_Misc_MouseOver
CSV_Include MultiMonitors CSV_MM_BackEmpty()
CSV_MM_ConfigInit()
CSV_MM_FwdEmpty()
CSV_MM_GetMonitor()
CSV_MM_GetMonitors()
CSV_MM_GetMouseX
CSV_MM_GetMouseY
CSV_MM_GetOffset
CSV_MM_GetScreenWidth()
CSV_MM_ListLastPages
CSV_MM_MonitorFromPoint
CSV_MM_MonitorFromWindow
CSV_MM_MonitorGoto
CSV_MM_NextEmpty()
CSV_MM_PageDisplay
CSV_MM_PageLast
CSV_MM_PageNext()
CSV_MM_PagePrev()
CSV_MM_PagesInit()
CSV_MM_PreviousEmpty()
CSV_MM_StoreLastPage
CSV_MM_WinDrag()
CSV_MM_WinDragEnd()
CSV_MM_WinFree()
CSV_MM_WinNewAt
CSV_MM_WinPopup
CSV_MM_WinTitle

159
Chapter: 5 CSV_include リファレンス

関 数 のカテゴリ 関数
CSV_Include Navigation CSV_Nav_Alarms()
CSV_Nav_AlarmsDisabled()
CSV_Nav_AlarmsHardware()
CSV_Nav_AlarmsSummary()
CSV_Nav_CloseWindow()
CSV_Nav_DisableMenuItem
CSV_Nav_DisplayMenuBar
CSV_Nav_DisplayPopupMenu
CSV_Nav_File
CSV_Nav_GetEngToolsPrivilege()
CSV_Nav_Home()
CSV_Nav_Login()
CSV_Nav_LoginMenu()
CSV_Nav_MenuBar_MenuClick
CSV_Nav_Network()
CSV_Nav_NetworkBtnEnabled()
CSV_Nav_PageExists
CSV_Nav_PagePrint()
CSV_Nav_Parent()
CSV_Nav_ParentBtnEnabled()
CSV_Nav_Report()
CSV_Nav_ReportBtnEnabled()
CSV_Nav_ReportMenu
CSV_Nav_Tools()
CSV_Nav_ToolsBtnEnabled()
CSV_Nav_ToolsMenu()
CSV_Nav_Trend()
CSV_Nav_TrendBtnEnabled()
CSV_Nav_TrendMenu()
CSV_Nav_TrendX()
CSV_Nav_TickMenuItem
CSV_Include Security CSV_Sec_ShowLoginMenu

CSV_Include Strings CSV_String_GetField

CSV_String_GetLines
CSV_String_Replace
CSV_Include Tags CSV_Tag_Debug

CSV_Include Tag CSV_Trend_AutoScale

CSV_Trend_DspGroup
CSV_Trend_DspGroupList
CSV_Trend_DspPopupMenu
CSV_Trend_DspScaleRange
CSV_Trend_DspTrendText
CSV_Trend_GetCursorPos
CSV_Trend_GetCursorTypeStr
CSV_Trend_GetCursorValueStr
CSV_Trend_GetDate
CSV_Trend_GetMode
CSV_Trend_GetPen
CSV_Trend_GetPenFocus
CSV_Trend_GetSettings
CSV_Trend_GetSettings
CSV_Trend_GetSpan

160
 Chapter: 5 CSV_include リファレンス

関 数 のカテゴリ 関数
CSV_Trend_GetTime
CSV_Trend_GroupConfig()
CSV_Trend_Page
CSV_Trend_Popup
CSV_Trend_ScaleDigital
CSV_Trend_SelectGroup
CSV_Trend_SelectPen
CSV_Trend_SetCursor
CSV_Trend_SetDate
CSV_Trend_SetDateTime
CSV_Trend_SetPens
CSV_Trend_SetRange
CSV_Trend_SetScale
CSV_Trend_SetSpan
CSV_Trend_SetTime
CSV_Trend_SetTimebase
CSV_Trend_UpdatePens
CSV_Trend_Win
CSV_Include TrendX CSV_TrendX_AddVariable
CSV_TrendX_AgeTrends()
CSV_TrendX_ClearTrend
CSV_TrendX_Close
CSV_TrendX_DeletePen()
CSV_TrendX_Display()
CSV_TrendX_DspPopupMenu
CSV_TrendX_GenericToTag
CSV_TrendX_GenericToTagStr
CSV_TrendX_GetComment
CSV_TrendX_GetCursor
CSV_TrendX_GetDuration()
CSV_TrendX_GetSamplePeriod
CSV_TrendX_GetScale
CSV_TrendX_GetTrendName
CSV_TrendX_GetTrigger
CSV_TrendX_GetVal
CSV_TrendX_InitClient()
CSV_TrendX_InitSrvr()
CSV_TrendX_MapTrendTags()
CSV_TrendX_RefreshTrendPage
CSV_TrendX_SetDuration
CSV_TrendX_SetDuration
CSV_TrendX_SetPen()
CSV_TrendX_SetSamplePeriod
CSV_TrendX_SetScale
CSV_TrendX_TagSelect
CSV_TrendX_TagSelectFrmCursor()
CSV_TrendX_TagToGeneric
CSV_TrendX_TrendTimeout
CSV_Include WinUtilities CSV_WinUtl_DestroyCursor()
CSV_WinUtl_GetColourRes()
CSV_WinUtl_GetCpuUsage
CSV_WinUtl_GetSystemDir()
CSV_WinUtl_GetTotalCpuUsage()
CSV_WinUtl_GetWindowsDir()
CSV_WinUtl_GetWinMode()

161
Chapter: 5 CSV_include リファレンス

関 数 のカテゴリ 関数
CSV_WinUtl_LoadCursor
CSV_WinUtl_LockWindowUpdate
CSV_WinUtl_NormalCursor
CSV_WinUtl_ShellExec
CSV_WinUtl_UpdateTotalCpuUsage()
CSV_WinUtl_WaitCursor

CSV_Alarms_Ack
アラーム リスト で指 定 したアニメーションポイント でのアラームを確 認 します。

シンタックス
CSV_Alarms_Ack(iAN)
iAN:

確 認 するアラームのアニメーション基 準 点 番 号 。

戻 り値
成 功 した場 合 は 0、それ以 外 の場 合 は、-1 となります。

CSV_Alarms_AckHardware
アラーム リスト で指 定 したアニメーションポイント でのハード ウェア アラームを確 認 します。

シンタックス
CSV_Alarms_AckHardware(iAN)
iAN:

確 認 するアラームのアニメーションポイント 番 号 。

注 : ハード ウェア アラームは標 準 アラームと異 なる方 法 で保 存 されます。そのた

め、AlarmGetDsp() はハード ウェア アラームの情 報 を返 しません。従 って、CSV_Alarms_
Ack はハード ウェア アラームでは正 常 に機 能 しません。

戻 り値
成 功 した場 合 は 0、そうでなければ -1 となります。

CSV_Alarms_AckPage
ページ内 のアラームを、指 定 したアニメーションポイント から開 始 して確 認 します。アラーム音 を
停 止 します。

162
 Chapter: 5 CSV_include リファレンス

シンタックス
CSV_Alarms_AckPage(iAN)
iAN:

確 認 するアラームのページに関 するアニメーション基 準 点 の開 始 番 号 。

CSV_Alarms_AckRec
レコード 番 号 を指 定 してアラームを確 認 し、アラーム音 を消 音 します。

シンタックス
CSV_Alarms_AckRec(iRecNo)
iRecNo:

確 認 するアラームのレコード番 号 。

戻 り値
成 功 した場 合 は 0、そうでなければ -1 となります。

CSV_Alarms_AdvFilter
指 定 した AN で表 示 するアラーム リスト に、高 機 能 フィルタを適 用 します。高 機 能 フィルタを
使 用 すると、アラームを、日 付 、タグ、名 前 、説 明 、エリア、カテゴリ、優 先 順 位 、マルチステー
ト 、タイプ (あるいはこれらの組 み合 わせ) に基 づいてフィルタできます。

シンタックス
CSV_Alarms_AdvFilter(iAN,iAlarmType,iMonitor)
iAN:

アラーム リスト が表 示 されるアニメーションポイント 。

iAlarmType:

フィルタに関 連 付 けられたアラーム リスト のタイプ。次 のタイプがあります。

l 0 = 最 新 のアラーム リスト
l 1 = アクティブなアラーム リスト
l 2 = アラーム サマリー リスト
l 3 = ハード ウェア アラーム リスト
l 4 = 無 効 なアラーム リスト
iMonitor:

163
Chapter: 5 CSV_include リファレンス

フィルタに関 連 付 けられたモニターの番 号 (各 モニターは異 なるフィルタを表 示 および保 存 することができ

ます)。

戻 り値
0

CSV_Alarms_AdvFilterConfig
ポップアップ ウィンド ウを表 示 することによって、アド バンスト アラーム フィルタのフィルタリングを設
定 します。

シンタックス
CSV_Alarms_AdvFilterConfig(iAlarmType,iMonitor)
iAlarmType:

フィルタに関 連 付 けられたアラーム リスト のタイプ。次 のタイプがあります。

l 0 = 最 新 のアラーム リスト
l 1 = アクティブなアラーム リスト
l 2 = アラーム サマリー リスト
l 3 = ハード ウェア アラーム リスト
l 4 = 無 効 なアラーム リスト
iMonitor:

フィルタに関 連 付 けられたモニターの番 号 (各 モニターは異 なるフィルタを表 示 および保 存 することができ

ます)。

戻 り値
アド バンスト フィルタが適 用 された場 合 は 0、そうでなければ -1 を返 します。

CSV_Alarms_AdvFilterQuery
ユーザー定 義 のアド バンスト フィルタが適 用 された場 合 に、各 アラームに対 して呼 び出 され 、
表 示 するアラームを決 定 します。

シンタックス
CSV_Alarms_
AdvFilterQuery
(
iRecNo
,

164
 Chapter: 5 CSV_include リファレンス

nVer
,sFromDate,sFromTime,sToDate,sToTime,sTag,sName,sArea,sCategory,sPriority,sState,sType)
iRecNo:

アラームのレコード番 号 。

nVer:

バージョン (未 使 用 )。

sFromDate:

この日 付 以 前 のアラームは表 示 されません (""にすると FromDate を最 も古 い日 付 に設 定 します)。

sFromTime:

この時 刻 以 前 のアラームは表 示 されません (""にすると FromTime を 12:00 (午 前 0時 ) に設 定 します)。

sToDate:

この日 付 以 降 のアラームは表 示 されません (""にすると ToDate を現 在 の日 付 に設 定 します)。

sToTime:

この時 刻 以 降 のアラームは表 示 されません (""にすると sToTime を現 在 の時 刻 に設 定 します)。

sTag:

アラーム タグは、sTag と同 様 であることが必 要 です。つまり、「*sTag*」のようなタグです。。

sName:

アラーム 名 は、sName と同 様 であることが必 要 です。つまり、「*sName*」のような名 前 です 。

sArea:

アラームのエリア (またはエリアのグループ)。

sCategory:

アラーム カテゴリ (またはカテゴリのグループ)。

sPriority:

アラーム優 先 順 位 (または優 先 順 位 のグループ)。

sState:

アラームのマルチステート 。

sType):

アラーム タイプ。

注 : フィルタ引 数 のいずれかを "" に設 定 すると、フィルタ条 件 が無 効 になります。

165
Chapter: 5 CSV_include リファレンス

戻 り値
アラームを表 示 する場 合 (条 件 に一 致 する場 合 ) は 1、そうでなければ 0 を返 します。

CSV_Alarms_AdvFilterSetDateTime
キーパッド フォームから入 力 した日 付 と時 刻 を、指 定 のテキスト ボックスに書 き出 します。(アド
バンスト アラーム フィルタ フォームで使 用 )。

シンタックス
CSV_Alarms_AdvFilterSetDateTime(iDateAN, iTime)
iDateAN:

[日 付 ] テキスト ボックスの AN 番 号 。

iTime:

[時 刻 ] テキスト ボックスの AN 番 号 。

戻 り値
成 功 した場 合 は 0、そうでなければ -1 となります。

CSV_Alarms_CheckSound
指 定 の優 先 順 位 より高 い順 位 の (特 定 の領 域 に対 して) 未 確 認 アラームが見 つかるまで、
指 定 のインデックスと現 在 のインデックス間 のアラーム サマリー レコード をチェックします。

注 : この機 能 は、アラーム サーバーからのみ呼 び出 してください。

シンタックス
CSV_Alarms_CheckSound(iAlarmIndexPrevious,iPriorityPrevious,sArea)
iAlarmIndexPrevious:

確 認 を開 始 するアラーム サマリーのインデックス (最 後 に確 認 したアラームのインデックス)。

iPriorityPrevious:

比 較 する優 先 順 位 。

sArea:

現 在 ログインしているエリア (これらのエリア内 のアラームのみをチェックします)。

166
 Chapter: 5 CSV_include リファレンス

戻 り値
関 数 は、スペースで区 切 った 3 つの値 を含 む文 字 列 を返 します。
l アラームの優 先 順 位 :指 定 したよりも優 先 順 位 の高 いアラームが見 つかった場 合 はこの優
先 順 位 、それ以 外 の場 合 は あるいは関 数 に最 初 に渡 された iPriorityPrevious。
l アラーム インデックス前 回 に確 認 したアラームのインデックス。
l 確 認 済 みのアラーム:アラームが確 認 され、それ以 降 1 つもアラームが発 生 しなかった場 合
は 1、そうでなければ 0 を返 します。

CSV_Alarms_ClearGroupFilter
指 定 のアラーム リスト に適 用 したフィルタをクリアします。

シンタックス
CSV_Alarms_ClearGroupFilter(iAN,iAlarmType, iMonitor)
iAN:

アラーム リスト のアニメーションポイント の開 始 番 号 。

iAlarmType:

フィルタに関 連 付 けられたアラーム リスト のタイプ。次 のタイプがあります。

l 0 = 最 新 のアラーム リスト
l 1 = アクティブなアラーム リスト
l 2 = アラーム サマリー リスト
l 3 = ハード ウェア アラーム リスト
l 4 = 無 効 なアラーム リスト
iMonitor:

アラーム リスト を表 示 するモニターの番 号 (-1 = アクティブなモニター)。

CSV_Alarms_Disable
アラーム リスト で指 定 したアニメーションポイント でのアラームを無 効 にします。

シンタックス
CSV_Alarms_Disable(iAN)
iAN:

無 効 にするアラームのアニメーションポイント 番 号 。

167
Chapter: 5 CSV_include リファレンス

戻 り値
成 功 した場 合 は 0、そうでなければ -1 となります。

CSV_Alarms_DisableRec
レコード 番 号 に基 づき、アラームを無 効 にします。

シンタックス
CSV_Alarms_DisableRec(iRecNo)
iRecNo:

無 効 にするアラームのレコード番 号 。

戻 り値
成 功 した場 合 は 0、そうでなければ -1 となります。

CSV_Alarms_DspGroupFilter
アラーム グループ リスト ボックスを表 示 し、指 定 のアラーム ページおよび指 定 のモニター用 に選
択 したフィルタを保 存 します。

シンタックス
CSV_Alarms_AdvFilterConfig(iAlarmType,iMonitor)
iAlarmType:

フィルタに関 連 付 けられたアラーム リスト のタイプ。次 のタイプがあります。

l 0 = 最 新 のアラーム リスト
l 1 = アクティブなアラーム リスト
l 2 = アラーム サマリー リスト
l 3 = ハード ウェア アラーム リスト
l 4 = 無 効 なアラーム リスト
iMonitor:

アラーム リスト を表 示 するモニターの番 号 (-1 = アクティブなモニター)。

戻 り値
選 択 したアラーム グループの名 前 または、選 択 がキャンセルされた場 合 は "" を返 します。

CSV_Alarms_DspGroupList
アラーム グループ リスト ボックスを表 示 します。

168
 Chapter: 5 CSV_include リファレンス

シンタックス
CSV_Alarms_DspGroupList
sSelectedGroup:

リスト で選 択 済 みのグループ名 。

sAreas:

リスト で有 効 にするエリア。これらのエリアに所 属 するアラーム グループのみが表 示 されます。

戻 り値
リスト から選 択 されたアラーム グループ (説 明 )、または [キャンセル] ボタンを押 した場 合 "" を
返 します。

CSV_Alarms_DspInfo
アラーム リスト で指 定 したアニメーションポイント でのアラームの情 報 をポップアップで表 示 しま
す。

シンタックス
CSV_Alarms_DspInfo(iAN)
iAN:

情 報 を表 示 するアラームのアニメーションポイント 番 号 。

CSV_Alarms_DspInfoRec
指 定 したレコード 番 号 のアラームの情 報 をポップアップ表 示 します。

シンタックス
CSV_Alarms_DspInfoRec(iRecNo)
iRecNo:

情 報 を表 示 するアラームのレコード番 号 。

戻 り値
成 功 した場 合 は 0、そうでなければ -1 となります。

CSV_Alarms_DspLast
最 近 発 生 したアラームを指 定 した数 だけ、指 定 したアニメーションポイント から開 始 して表 示 し
ます。

169
Chapter: 5 CSV_include リファレンス

シンタックス
CSV_Alarms_DspLast(iAN,iAlarmCount,iType)
iAN:

アラーム リスト のアニメーションポイント の開 始 番 号 。

iAlarmCount:

表 示 するアラーム数 。

iType:

表 示 するアラームのタイプ。

非 ハード ウェア アラーム

l -1 =[Alarm] LastAlarmType パラメータによって指 定 されたアラーム
l 0 = すべてのアクティブなアラーム。タイプ 1 および 2。
l 1 = すべての未 確 認 アラーム。オンおよびオフ。
l 2 = すべての確 認 済 みのオンのアラーム。
l 3 = すべての無 効 なアラーム。
l 4 = すべての設 定 済 み (非 ハード ウェア) アラーム。タイプ 0 ～ 3および確 認 済 み
のオフのアラーム。
ハード ウェア アラーム
l 5 = すべてのアクティブなアラーム。タイプ 6 および 7。
l 6 = すべての未 確 認 アラーム。オンおよびオフ。
l 7 = すべての確 認 済 みのオンのアラーム。
l 8 = すべての無 効 なアラーム。
l 9 = すべての設 定 アラーム。タイプ 5 ～ 8。
アラーム サマリー
l 10 = すべてのサマリー アラーム。
アラーム全 般
l 11 = すべてのオンのアラーム。
l 12 = すべてのオフのアラーム。
l 13 = すべてのオンのハード ウェア アラーム。
l 14 = すべてのオフのハード ウェア アラーム。

CSV_Alarms_Enable
アラーム リスト で指 定 したアニメーションポイント でのアラームを有 効 にします。

170
 Chapter: 5 CSV_include リファレンス

シンタックス
CSV_Alarms_Enable(iAN)
iAN:

有 効 にするアラームのアニメーションポイント 番 号 。

戻 り値
成 功 した場 合 は 0、そうでなければ -1 となります。

CSV_Alarms_EnableRec
レコード 番 号 を基 にアラームを有 効 にします。

シンタックス
CSV_Alarms_EnableRec(iRecNo)
iRecNo:

有 効 にするアラームのレコード番 号 。

戻 り値
成 功 した場 合 は 0、そうでなければ -1 となります。

CSV_Alarms_GetAckPrivilege()
ユーザーがアラームを確 認 する権 限 レベルを持 っているかチェックします。

戻 り値
権 限 レベルをもっている場 合 は 1、そうでなければ 0 を返 します。

CSV_Alarms_GetDisablePrivilege()
アラームを無 効 にする権 限 レベルがあるかチェックします。

戻 り値
特 権 レベルをもっている場 合 は 1、そうでなければ 0 を返 します。

CSV_Alarms_GetGroupFilter
アラーム リスト に現 在 適 用 されているフィルタの説 明 を返 します。

171
Chapter: 5 CSV_include リファレンス

シンタックス
CSV_Alarms_GetGroupFilter(iAlarmType,iMonitor,iChars)
iAlarmType:

フィルタに関 連 付 けられたアラーム リスト のタイプ。次 のタイプがあります。

l 0 = 最 新 のアラーム リスト
l 1 = アクティブなアラーム リスト
l 2 = アラーム サマリー リスト
l 3 = ハード ウェア アラーム リスト
l 4 = 無 効 なアラーム リスト
iMonitor:

アラーム リスト を表 示 するモニターの番 号 (-1 = アクティブなモニター)。

iChars:

1 行 の文 字 数 (-1 = 1 行 )。

戻 り値
指 定 されたアラーム リスト に現 在 適 用 されているフィルタの説 明 。1 行 の最 大 文 字 数 が指 定
されている場 合 、複 数 の行 として返 されます。

CSV_Alarms_GetGroupFilterID
特 定 のアラーム リスト に現 在 適 用 されているフィルタに関 連 するグループの名 前 を返 します。

シンタックス
CSV_Alarms_AdvFilterConfig(iAlarmType,iMonitor)
iAlarmType:

フィルタに関 連 付 けられたアラーム リスト のタイプ。次 のタイプがあります。

l 0 = 最 新 のアラーム リスト
l 1 = アクティブなアラーム リスト
l 2 = アラーム サマリー リスト
l 3 = ハード ウェア アラーム リスト
l 4 = 無 効 なアラーム リスト
iMonitor:

アラーム リスト を表 示 するモニターの番 号 (-1 = アクティブなモニター)。

172
 Chapter: 5 CSV_include リファレンス

戻 り値
グループの名 前 。または、高 機 能 フィルタが適 用 されている場 合 は "_AdvFilter_"、フィルタが
適 用 されない場 合 は、"" を返 します。

CSV_Alarms_GetUniqueGroupName
指 定 した名 前 のグループが存 在 するかチェックします。指 定 した名 前 のグループが存 在 する場
合 、元 の名 前 に数 字 を付 けた新 しい名 前 を作 成 します。

シンタックス
CSV_Alarms_GetUniqueGroupName(sGroupName)
sGroupName:

チェックするグループ名 。

注 : グループを作 成 する前 に、この関 数 を呼 び出 し、新 規 グループを指 定 の名 前 を付 けて

作 成 できるように確 認 します。

戻 り値
新 しいグループに付 けることのできるグループ名 (= sGroupName、または sGroupName の修
正 バージョン)。

CSV_Alarms_GroupAdd
アラーム グループを [アラーム グループ] リスト ボックスに追 加 し、関 連 したアラーム カテゴリを保
存 するためのグループを作 成 します。アラーム グループは AlarmGrp.dbf に追 加 されます。グ
ループ名 は、リスト ボックスの 2 つめのフィールド (非 表 示 のフィールド ) と、AlarmGrp.dbf の
Name フィールド に保 存 されます。

注 : アラーム グループはアラーム ページでのアラームのフィルタに使 用 します。グループがリス

ト から選 択 されると、関 連 したカテゴリを持 つアラームのみがアラーム ページに表 示 されま
す。

シンタックス
CSV_Alarms_GroupAdd(sGroupName, sDesc, sCategories, sArea)
sGroupName:

アラーム グループの名 前 /ID (一 意 でなければなりません)。

sDesc:

173
Chapter: 5 CSV_include リファレンス

リスト ボックスに表 示 される、アラーム グループを説 明 するテキスト 。

sCategories:

アラーム グループで表 されるカテゴリをリスト する文 字 列 。標 準 CitectSCADA グループと同 じフォーマット

にする必 要 があります。例 えば、「1,5,7..9」はカテゴリ 1,5,7,8,9 になります。

sArea:

グループを適 用 するエリア。空 の文 字 列 は、すべての領 域 を表 します。

戻 り値
作 成 したグループの名 前 、または失 敗 した場 合 は、"" を返 します。

CSV_Alarms_GroupConfig()
ポップアップ ウィンド ウを表 示 して、ランタイム時 に AlarmGrp.dbf のレコード を参 照 /編 集 /追
加 /削 除 します。

注 : ランタイム時 にアラーム グループを変 更 することができ、この変 更 は、フィルタリングに使

用 できるアラーム グループを表 示 するリスト ボックスに反 映 されます。

CSV_Alarms_GroupRemove
[アラーム グループ] リスト ボックスからアラーム グループを削 除 し、同 じ名 前 の CitectSCADA グ
ループを削 除 します。AlarmGrp.dbf からもアラーム グループが削 除 されます。

注 : アラーム グループはアラーム ページでのアラームのフィルタに使 用 します。グループをリス

ト から選 択 すると、関 連 付 けられたカテゴリのアラームのみがアラーム ページに表 示 されま
す。

シンタックス
CSV_Alarms_GroupRemove (sGroupName)
sGroupName:

アラーム グループの一 意 の名 前 /ID (=アラーム グループ リスト ボックスの 2 番 目 のフィールド (非 表 示 )。

これは CSV_ListBox_GetSelectedItemID を呼 び出 すことによって取 得 できます。)

戻 り値
成 功 した場 合 は 0、そうでなければ -1 となります。

CSV_Alarms_GroupEdit

174
 Chapter: 5 CSV_include リファレンス

[アラーム グループ] リスト ボックスで既 存 のアラーム グループを編 集 し、AlarmGrp.dbf を更 新 し

ます。

注 : アラーム グループはアラーム ページでのアラームのフィルタに使 用 します。グループをリス

ト から選 択 すると、関 連 付 けられたカテゴリのアラームのみがアラーム ページに表 示 されま
す。

シンタックス
CSV_Alarms_GroupEdit(sGroupName,sDesc,sCategories,sArea)
sGroupName:

アラーム グループの名 前 /ID (一 意 でなければなりません)。

sDesc:

リスト ボックスに表 示 される、アラーム グループを説 明 するテキスト 。

sCategories:

アラーム グループで表 されるカテゴリをリスト する文 字 列 。標 準 CitectSCADA グループと同 じフォーマット

にする必 要 があります。例 えば、「1,5,7..9」はカテゴリ 1,5,7,8,9 になります。

sArea:

グループを適 用 するエリア。空 の文 字 列 は、すべての領 域 を表 します。

戻 り値
成 功 した場 合 は 0、そうでなければ -1 となります。

CSV_Alarms_GroupFilter
カテゴリ グループの指 定 したアニメーションポイント から始 めて、アラーム リスト のフィルタを行 いま
す。

注 : グループ名 が「_AllAlarms_」の場 合 、すべてのアラームが表 示 されます。つまり、フィル

タは解 除 されます。グループ名 が「_AdvFilter_」の場 合 、選 択 したアド バンスト フィルタがア
ラーム リスト に適 用 されます。

シンタックス
CSV_Alarms_GroupFilter(iAN,sGroupName,iAlarmType,iMonitor)
iAN:

アラーム リスト のアニメーションポイント の開 始 番 号 。

175
Chapter: 5 CSV_include リファレンス

sGroupName:

フィルタするアラーム グループの名 前 /ID。

iAlarmType:

フィルタに関 連 付 けられたアラーム リスト のタイプ。

l 0 = 最 新 のアラーム リスト
l 1 = アクティブなアラーム リスト
l 2 = アラーム サマリー リスト
l 3 = ハード ウェア アラーム リスト
l 4 = 無 効 なアラーム リスト
iMonitor:

アラーム リスト を表 示 するモニターの番 号 (-1 = アクティブなモニター)。

戻 り値
グループへのハンド ル、そうでなければ –1 を返 します。

CSV_Alarms_GroupSelect
カテゴリ グループの指 定 したアニメーションポイント から始 めて、アラーム リスト のフィルタをを行 い
ます。アラーム グループは、グループ名 またはグループの説 明 のいずれかによって指 定 できま
す(AlarmGrp.dbf を参 照 )。指 定 したモニターおよび指 定 したアラーム ページ タイプに適 用 さ
れたフィルタを保 存 します。

シンタックス
CSV_Alarms_GroupSelect(iAN,sGroupID,sGroupIDType,iAlarmType, iMonitor)
iAN:

アラーム リスト のアニメーションポイント の開 始 番 号 。

sGroupID:

フィルタするアラーム グループの名 前 /説 明 。sGroupID = ""の場 合 、フィルタがクリアされます。

sGroupIDType:
l 0 = sGroupID アラーム グループ名 を指 定 します。
l 1 = sGroupID アラーム グループの説 明 を指 定 します。
iAlarmType:

フィルタに関 連 付 けられたアラーム リスト のタイプ。次 のタイプがあります。

l 0 = 最 新 のアラーム リスト
l 1 = アクティブなアラーム リスト

176
 Chapter: 5 CSV_include リファレンス

l 2 = アラーム サマリー リスト

l 3 = ハード ウェア アラーム リスト
l 4 = 無 効 なアラーム リスト
iMonitor:

アラーム リスト を表 示 するモニターの番 号 (-1 = アクティブなモニター)。

CSV_Alarms_GroupsInit()
AlarmGrp.dbf で指 定 されたグループがある [アラーム グループ] リスト ボックスを初 期 化 しま
す。AlarmGrp.dbf にリスト されている各 アラーム グループに対 し、グループが作 成 され、このア
ラーム グループに割 り当 てられているアラーム カテゴリが保 管 されます。アラーム リスト のフィルタ
リングにグループが使 用 されます。グループをリスト から選 択 すると、これらのカテゴリを持 つアラー
ムのみがアラーム ページに表 示 されます。

戻 り値
成 功 した場 合 は 0、そうでなければ -1 となります。

CSV_Alarms_Help
アラーム リスト で指 定 したアニメーションポイント でのアラームに対 して:アラーム dbf のヘルプ フ
ィールド に指 定 されたページを表 示 するか、ヘルプ フィールド が「?」で始 まる場 合 は、フィールド
で指 定 された関 数 を呼 び出 します (つまり「?」に続 くテキスト )。

戻 り値
CSV_Alarms_Help (iAN)
iAN:

ヘルプを表 示 するアラームのアニメーションポイント 番 号 。

戻 り値
成 功 した場 合 は 0、そうでなければ -1 となります。

CSV_Alarms_HelpRec
指 定 されたレコード 番 号 でのアラームに対 して:アラーム dbf のヘルプ フィールド に指 定 された
ページを表 示 するか、ヘルプ フィールド が「?」で始 まる場 合 は、フィールド で指 定 された関 数 を
呼 び出 します (つまり、「?」に続 くテキスト )。

シンタックス
CSV_Alarms_HelpRec(iAN)
iAN:

177
Chapter: 5 CSV_include リファレンス

ヘルプを表 示 するアラームのアニメーションポイント 番 号 。

戻 り値
成 功 した場 合 は 0、そうでなければ -1 となります。

CSV_Alarms_ListHeading
指 定 したアラーム リスト タイプのフォーマット された見 出 しを返 します。見 出 しのフォーマット は
次 の ini パラメー
タ、
[Alarm]ActiveHeading
、[Alarm]SummaryHeading、[Alarm]DisabledHeading、[Alarm]HardwareHeading によって指 定 され
ます。

シンタックス
CSV_Alarms_ListHeading (iAlarmType)
iAlarmType:

フィルタに関 連 付 けられたアラーム リスト のタイプ。

l 0 = 最 新 のアラーム リスト
l 1 = アクティブなアラーム リスト
l 2 = アラーム サマリー リスト
l 3 = ハード ウェア アラーム リスト
l 4 = 無 効 なアラーム リスト

戻 り値
アラーム リスト の見 出 し。見 出 しが指 定 されていない場 合 、"" を返 します。

例
[Alarm]
ActiveHeading = {DATE,12}^t{TIME,14}^t{NAME,15}^t{DESC,40}^t{STATE,10}

CSV_Alarms_ListHeadingFont()
アラーム リスト の見 出 しに使 用 するフォント を返 します。フォント は、ini パラメー
タ、[Alarm]HeadingFont で指 定 します。フォント を指 定 しない場 合 は、デフォルト 値 (Tahoma、
太 字 、9 青 色 ) が使 用 されます。

戻 り値
アラーム リスト の見 出 しフォント

CSV_Alarms_PopupMenu

178
 Chapter: 5 CSV_include リファレンス

アラーム リスト で指 定 したアニメーションポイント で、アラームのポップアップ メニューを表 示 しま

す。使 用 できるメニュー項 目 は次 のとおりです。
l アラーム情 報
l 確認
l 無効
l 有効
l ヘルプ

注 : 無 効 /有 効 オプションは、[Privilege] DisableAlarms パラメータで指 定 した特 権 レベル

を持 つユーザーのみが使 用 できます。確 認 オプションは、[Privilege] AckAlarms パラメータ
で指 定 した特 権 レベルを持 つユーザーのみが使 用 できます。

シンタックス
CSV_Alarms_PopupMenu(iAN,iAlarmType,iPreserveWinNo)
iAN:

メニューを表 示 するアラームのアニメーションポイント 番 号 。

iAlarmType:

次 のアラーム リスト のタイプ。

l 0 = 最 新 のアラーム リスト
l 1 = アクティブなアラーム リスト
l 2 = アラーム サマリー リスト
l 3 = ハード ウェア アラーム リスト
l 4 = 無 効 なアラーム リスト
iPreserveWinNo:
オプションの引 数 で、1 に設 定 すると、機 能 が終 了 する時 に、選 択 した元 のウィンド ウを復 元 し
ます。

許容値:

0 = 元 の動 作 を保 持 します (デフォルト )。

1 = 選 択 した元 のウィンドウを復 元 します。

戻 り値
成 功 した場 合 は 0、そうでなければ -1 となります。

CSV_Alarms_Sound()

179
Chapter: 5 CSV_include リファレンス

未 確 認 のアラームがシステムに存 在 するかチェックし、もし存 在 する場 合 は、対 応 したアラーム

を鳴 らします。

CSV_Alarms_SoundActive()
アラームが鳴 っているかチェックします。この関 数 は、テンプレート などでサイレンをアニメーション
を再 生 するのに使 用 します。

戻 り値
アラーム音 がアクティブの場 合 は 1、そうでなければ 0 を返 します。

CSV_Alarms_Silence()
miResetAlarmSound を設 定 してアラーム音 を消 音 します。

CSV_DB_BOF
レコード セット のファイルの始 めを示 すフラグをチェックします。

シンタックス
CSV_DB_BOF(hRecordSet)
hRecordSet:

レコードセット へのハンドル (CSV_DB_Execute() から返 されるハンドル)

戻 り値
ファイルの始 まりでない場 合 、0 を返 します。

CSV_DB_Close
指 定 されたレコード セット を閉 じます。

シンタックス
CSV_DB_Close(hRecordSet)
hRecordSet:

レコードセット へのハンドル (CSV_DB_Execute() から返 されるハンドル)

戻 り値
成 功 した場 合 は 0、そうでなければ -1 となります。

CSV_DB_EOF()
レコード セット のファイルの終 わりを示 すフラグをチェックします。

180
 Chapter: 5 CSV_include リファレンス

戻 り値
ファイルの終 わりでない場 合 、0 を返 します。

CSV_DB_Execute
指 定 されたデータベースでコマンド を実 行 します。接 続 文 字 列 を使 用 して、データベースへの
接 続 方 法 を指 定 します。プライマリ パスがオフラインで、スタンバイ接 続 文 字 列 が指 定 されて
いる場 合 、スタンバイ パスが使 用 されます。このコマンド は、次 のような、SQL タイプのコマンド
でなければなりません。

"SELECT * FROM MyTable WHERE TimeValue(Time) > #10:00:00#" etc.

接 続 文 字 列 の例 :
SQL サーバーの場 合

"Provider=sqloledb;Data Source=MySQLServerName;Initial
Catalog=MyDatabase;User Id=MyUserID;Password=MyPassword;"

Access の場 合

"Provider=Microsoft.Jet.OLEDB.4.0;Data
Source=\somepath\mydb.mdb;User Id=MyUserID;Password=MyPassword;"

Oracle の場 合

"Provider=OraOLEDB.Oracle;Data Source=MyOracleDB;User
Id=MyUserID;Password=MyPassword;"

Excel の場 合

"Provider=Microsoft.Jet.OLEDB.4.0;Data
Source=C:\somepath\MyExcel.xls; Extended Properties=Excel
8.0;HDR=Yes;IMEX=1"

この場 合 、
HDR=Yes は、最 初 の行 にデータではなく列 名 が含 まれていることを示 します。
IMEX=1 は、常 に「intermixed」データ列 をテキスト として読 み取 るようド ライバに伝 えます。
テキスト の場 合

"Provider=Microsoft.Jet.OLEDB.4.0;Data
Source=c:\somepath\MyTxtFilesFolder\;Extended
Properties=text;HDR=Yes;FMT=Delimited"

181
Chapter: 5 CSV_include リファレンス

この場 合 、
"HDR=Yes は、最 初 の行 にデータではなくコラム名 が含 まれていることを示 します。
DBF の場 合

"Provider=Microsoft.Jet.OLEDB.4.0;Data
Source=c:\somepath\MyDbfFolder;Extended Properties=dBASE IV;User
ID=Admin;Password="

DSN の場 合

"DSN=MyDsn;Uid=MyUserID;Pwd=MyPassword;"

UDL の場 合

"File Name=c:\somepath\myDataLink.udl;"

シンタックス
CSV_DB_Execute(sCommand,sPrimaryConnection,sStandbyConnection)
#sCommand:

実 行 するコマンド。

#sPrimaryConnection:

プライマリ接 続 パス用 接 続 文 字 列 。

#sStandbyConnection:

スタンバイ接 続 パス用 接 続 文 字 列 。

戻 り値
正 常 に実 行 した場 合 は結 果 のレコード セット へのハンド ル、そうでなければ -1 を返 します。

CSV_DB_GetExecuteError
最 後 の CSV_DB_Execute コマンド の呼 び出 しで起 こったエラーの説 明 を返 します。

シンタックス
CSV_DB_GetExecuteError(nMode)
#nMode

182
 Chapter: 5 CSV_include リファレンス

戻 り値
エラーの説 明 。

CSV_DB_GetFieldCount
指 定 したレコード セット に含 まれるフィールド 数 を返 します。

シンタックス
CSV_DB_GetFieldCount(hRecordSet)

戻 り値
正 常 に実 行 された場 合 はフィールド の数 、そうでなければ -1 を返 します。

CSV_DB_GetFieldIndex
指 定 したレコード セット の指 定 したフィールド のインデックスを返 します。

シンタックス
CSV_DB_GetFieldIndex(hRecordSet,sField)
#sField:

フィールドの名 前 。

戻 り値
正 常 に実 行 した場 合 はフィールド のインデックス、そうでなければ -1 を返 します。

CSV_DB_GetFieldName
指 定 したレコード セット に含 まれるフィールド の名 前 を返 します。フィールド は、フィールド インデ
ックスによって識 別 されます。

シンタックス
CSV_DB_GetFieldName(hRecordSet,nFieldIndex)
#nFieldIndex:

フィールドのインデックス (最 初 のフィールドは、nFieldIndex=0 となります)。

戻 り値
正 常 に実 行 した場 合 はフィールド の名 前 、そうでなければ "" を返 します。

CSV_DB_GetFieldText

183
Chapter: 5 CSV_include リファレンス

指 定 したレコード セット に含 まれるフィールド の値 を、文 字 列 として返 します。フィールド は、フ

ィールド インデックスによって識 別 されます。

シンタックス
CSV_DB_GetFieldText(hRecordSet,sField,nFieldIndex,sNullValue)
#sField:

フィールドの名 前 。(nFieldIndex を代 わりに使 用 する場 合 は、空 白 "" のままにしておきます。)

#nFieldIndex:

フィールドのインデックス。最 初 のフィールドは、nFieldIndex=0 となります。(sField = ""の場 合 のみに使

用)

#sNullValue:

フィールド値 が NULL の場 合 に返 される値 。

注 : フィールド の値 が NULL の場 合 、この関 数 は、引 数 の sNullValue で指 定 された文

字 列 を返 します。

戻 り値
正 常 に実 行 した場 合 はフィールド の値 、そうでなければ sNullValue を返 します。

CSV_DB_GetRowCount
指 定 したレコード セット に含 まれる行 数 を返 します。

シンタックス
CSV_DB_GetRowCount(hRecordSet)

戻 り値
正 常 に実 行 された場 合 は行 数 、そうでなければ -1 を返 します。

CSV_DB_GetRowCurrent
指 定 したレコード セット に含 まれる現 在 のレコード の行 数 を返 します。

シンタックス
CSV_DB_GetRowCurrent(hRecordSet)

184
 Chapter: 5 CSV_include リファレンス

戻 り値
正 常 に実 行 された場 合 は行 数 、そうでなければ -1を返 します。

CSV_DB_GetRowFieldText
指 定 したレコード セット の指 定 行 に含 まれる、指 定 したフィールド の値 を取 得 します。

シンタックス
CSV_DB_GetRowFieldText(hRecordSet,nRowOffset,sField,nFieldIndex, sNullValue)
#nRowOffset:

行 のオフセット (現 在 の位 置 から)

CSV_DB_MoveFirst
指 定 したレコード セット の、最 初 のレコード を検 索 します。

シンタックス
CSV_DB_MoveFirst(hRecordSet)

戻 り値
正 常 に実 行 した場 合 は最 初 のレコード 、そうでなければ -1 を返 します。

CSV_DB_MoveLast
指 定 したレコード セット の最 後 のレコード を検 索 します。

シンタックス
CSV_DB_MoveLast(hRecordSet)

戻 り値
正 常 に実 行 した場 合 は最 後 のレコード 、そうでなければ -1 を返 します。

CSV_DB_MoveNext
指 定 したレコード セット の次 のレコード を検 索 します。

シンタックス
CSV_DB_MoveNext(hRecordSet)

185
Chapter: 5 CSV_include リファレンス

戻 り値
正 常 に実 行 した場 合 は次 のレコード 、そうでなければ -1 を返 します。

CSV_DB_MoveOffset
指 定 したレコード セット で、現 在 のレコード から指 定 したオフセット の位 置 にあるレコード を検 索
します。

シンタックス
CSV_DB_MoveOffset(hRecordSet)

戻 り値
正 常 に実 行 した場 合 は指 定 したオフセット のレコード 、そうでなければ -1 を返 します。

CSV_DB_MovePrev
指 定 したレコード セット で、前 のレコード を検 索 します。

シンタックス
CSV_DB_MovePrev(hRecordSet)

戻 り値
正 常 に実 行 した場 合 は前 のレコード 、そうでなければ -1 を返 します。

CSV_DB_StandbyConnectionActive
指 定 したプライマリ接 続 および指 定 したスタンバイ接 続 の、最 後 の接 続 マルチステート をチェッ
クします。

シンタックス
CSV_DB_StandbyConnectionActive(sPrimaryConnection, sStandbyConnection)

戻 り値
プライマリ接 続 マルチステート がオフラインで、スタンバイ接 続 マルチステート がオンラインの場 合
は 1、そうでなければ 0 を返 します。

CSV_DB_StrToSQL
1 つの一 重 引 用 符 を 2 つの一 重 引 用 符 に置 換 し、SQL が一 重 引 用 符 をテキスト のみとして
解 釈 するようにします。

186
 Chapter: 5 CSV_include リファレンス

シンタックス
CSV_DB_StrToSQL(sText)
#sText:

SQL フォーマット に変 換 するテキスト 。

戻 り値
変 換 されたテキスト 。

CSV_Display_Logo
会 社 ロゴを、指 定 した XY 座 標 で表 示 します。ロゴは 256 色 (最 大 ) のビット マップ ファイルに
する必 要 があります。デフォルト のファイルは 「RUN」ディレクト リにある「logo.bmp」です。代 わり
のファイル名 とパスを指 定 することができます。

注 : ロゴはページの最 初 の scanupdate のみに表 示 されます。

シンタックス
CSV_Display_Logo(iX,iY,sLogoFile)
#iX:

ロゴの左 上 を表 示 する X 座 標 。

#iY:

ロゴの左 上 を表 示 する Y 座 標 。

#sLogoFile:

表 示 するファイル名 (パスを含 む)。

CSV_Display_ServicePack()
「Service Pack A」のフォームで、CitectSCADA サービス パックを取 得 します。この関 数 は、正
式 にリリースされているサービス パックの値 のみを返 します。ホット フィックスが適 用 されている場
合 、この関 数 は「Unknown」を返 します。

戻 り値
CitectSCADA のサービス パック (文 字 列 )。

CSV_Display_Title()
タイト ル バーに表 示 されるウィンド ウ タイト ルを取 得 します。

187
Chapter: 5 CSV_include リファレンス

戻 り値
ウィンド ウ タイト ル。

CSV_Display_Version()
フォーム 5.41.128 の CitectSCADA バージョン番 号 を取 得 します。

戻 り値
CitectSCADA バージョン番 号 (文 字 列 )。

CSV_File_Display
テキスト ボックス オブジェクト AN に textRich テキスト ファイルを表 示 します。

シンタックス
CSV_File_Display(sFile,iAN,iMode,sFontName,sFontSize,
iFontColour,iBackColour,iWordWrap,iScrollbars)
#sFile:

表 示 するファイル名 。

#iAN:

テキスト ボックス オブジェクト のアニメーションポイント 番 号 。

#iMode:
l 1 = ロック (編 集 を許 可 しない)。
l 2 = 保 存 を許 可 (ポップアップ コンテキスト メニューで保 存 オプションを有 効 にす
る)。
l 4 = 作 成 を許 可 (存 在 しない場 合 は、ファイルを作 成 する)。
l 8 = 開 くことを許 可 (ポップアップ コンテキスト メニューで開 くオプションを有 効 にし、
別 のファイルをブラウズして開 くことを可 能 にする)。
#sFontName:

フォント 名 。

#sFontSize:

フォント サイズ。

#iFontColour:

フォント の色 。

#iBackColour:

テキスト ボックスの色 。

188
 Chapter: 5 CSV_include リファレンス

#iWordWrap:

テキスト の折 り返 し (テキスト ファイルのみ。Rtf ファイルは対 応 しません)。

#iScrollbars:

スクロールバーの表 示 。
l 0 = なし
l 1 = 水平
l 2 = 垂直
l 3 = 両方

CSV_File_Print
テキスト /リッチ テキスト ファイルを印 刷 します。

シンタックス
CSV_File_Print(Name)
#Name:

印 刷 するファイル名 。

戻 り値
成 功 した場 合 は 0、そうでなければ -1 となります。

CSV_File_Save
テキスト /リッチ テキスト ファイルを保 存 します。

シンタックス
CSV_File_Save(sFile)
#sFile:

保 存 するファイル名 。

戻 り値
成 功 した場 合 は 0、そうでなければ -1 となります。

CSV_Form_Centre
現 在 のモニター画 面 の中 央 にフォームを表 示 します。

189
Chapter: 5 CSV_include リファレンス

シンタックス
CSV_Form_Centre(iFormX, iFormY)
#iFormX:

フォームの幅 。

#iFormY:

フォームの高 さ

CSV_Form_Login()
ログイン フォームを表 示 してユーザー名 とパスワード を取 得 し、ユーザーのログインを試 みます。
ログインに失 敗 すると、ログインが OK になるか、ユーザーが [キャンセル] ボタンを押 すまで再 試
行 します。

戻 り値
正 常 にログインした場 合 は 0、そうでなければエラー(298) が返 されます。

CSV_Form_NumPad
ユーザーが数 値 パッド から値 を入 力 できるようにするフォームを生 成 します。フォームは現 在 の (
アクティブな) モニターで現 在 カーソルがある位 置 に表 示 されます。

シンタックス
CSV_Form_NumPad(sTitle,sInput,iMode)
#sTitle:

数 値 パッド フォームのタイト ル。

#sInput:

デフォルト の初 期 値 。

#iMode:

入 力 モードを示 します。次 のモードがあります。

l 0 = 標 準 のキーパッド 。
l 1 = パスワード スタイルの編 集 フィールド 付 き。
l 2= このモード はまだ使 用 されていません。
l 4 = 「+ -」のボタン付 き。
l 8 = 「""」のボタン付 き。
l 16 = 「.」のボタン付 き。
l 32 = 「:」付 き。ボタン付 き、モード 「+-」との併 用 は不 可 。

190
 Chapter: 5 CSV_include リファレンス

l 64 = 「AM」と「PM」のボタン付 き、モード 「""」または「.」との併 用 は不 可 。

l 128 = 「Now」のボタン付 き。
l 512 = 「1hr」、「2hr」、「8hr」、「24hr」のボタン付 き、モード 「Now」との併 用 は不
可。

戻 り値
承 認 ボタンを押 して閉 じた場 合 、キーパッド から入 力 した値 の文 字 列 を返 します。他 の方 法
で閉 じた場 合 、NULL 文 字 列 を返 します。

CSV_Form_Position
指 定 した X、Y 座 標 でフォームを表 示 し、すべてのフォームが現 在 のモニターの画 面 内 で表 示
されるように指 定 します。(つまり、必 要 に応 じて、X、Y 座 標 が自 動 的 に調 整 されます)。

シンタックス
CSV_Form_Position(iX, iY, iFormX, iFormY)
#iX:

表 示 したいフォームの左 上 のX 位 置 。

#iY:

表 示 したいフォームの左 上 のＹ位 置 。

#iFormX:

フォームの幅 。

#iFormY:

フォームの高 さ。

CSV_Form_Shutdown()
CitectSCADA システムを本 当 にシャット ダウンするか確 認 するダイアログ ボックスを表 示 しま
す。[はい] を選 択 した場 合 、CitectSCADA はシャット ダウンします。

戻 り値
シャット ダウンを確 認 すると、0 (ゼロ) が、それ以 外 の場 合 はエラー(298) が返 されます。

CSV_Form_UserCreate()
新 規 ユーザーのレコード を作 成 するためのフォームを表 示 します。指 定 したタイプの新 規 ユー
ザーが作 成 されます。ユーザーの名 前 は一 意 でなければなりません。

191
Chapter: 5 CSV_include リファレンス

戻 り値
新 規 ユーザーが正 常 に作 成 された場 合 0 (ゼロ) が、それ以 外 の場 合 はエラーが返 されます。

CSV_Form_UserEdit()
データベースのユーザー レコード の作 成 または削 除 できるフォームを表 示 します。この関 数 はア
クセス制 限 を行 ってください。メモリーのユーザー データベースおよびランタイム データベースの両
方 に、変 更 が書 き込 まれます。

戻 り値
正 常 に実 行 された場 合 は 0、そうでなければエラーが返 されます。

CSV_Form_UserPassword()
ユーザーが自 分 のパスワード を変 更 できるフォームを表 示 します。メモリーのユーザー データベー
スおよびランタイム データベースの両 方 に、変 更 が書 き込 まれます。

戻 り値
正 常 に実 行 された場 合 は 0、そうでなければエラーが返 されます。

CSV_ListBox_AddItem
ActiveX タグ リスト オブジェクト のコンボ ボックスに項 目 を追 加 します。

シンタックス
CSV_ListBox_AddItem(hList,sItem,sCategory,sItemID)
#hList:

リスト オブジェクト へのハンドル。

#sItem:

リスト に追 加 する項 目 のテキスト 。

#sCategory:

アイテムのカテゴリ (リスト はカテゴリ別 にフィルタすることができます)。

#sItemID:

アイテムのID (オプションですが、使 用 する場 合 は、それぞれの項 目 ごとに一 意 である必 要 があります。)

戻 り値
成 功 した場 合 は 0、そうでなければ -1 となります。

192
 Chapter: 5 CSV_include リファレンス

CSV_ListBox_Clear
ActiveX リスト オブジェクト をクリアします。

シンタックス
CSV_ListBox_Clear(hList)
#hList:

リスト オブジェクト へのハンドル。

戻 り値
成 功 した場 合 は 0、そうでなければ -1 となります。

CSV_ListBox_Create()
ActiveX リスト オブジェクト を作 成 します。

注 : このオブジェクト では、コンボ ボックスを含 むフォームを表 示 します。フォームはいつでも表

示 /非 表 示 にできます。コンボ ボックスが現 在 表 示 されているかどうかにかかわらず、項 目 を
コンボ ボックスに追 加 したり削 除 したりできます。コンボ ボックスは、CSV_List_Destroy() 関
数 がそのコンボ ボックスに対 して呼 び出 されるまで、メモリーに残 ります。

戻 り値
リスト ボックスが正 常 に作 成 された場 合 は 0、それ以 外 の場 合 はエラーが返 されます。

CSV_ListBox_Create()
新 規 リスト を作 成 します。

戻 り値
リスト ボックスが正 常 に作 成 された場 合 は作 成 したリスト へのハンド ル; そうでなければ –1 が
返 されます。

CSV_ListBox_Destroy
ActiveX リスト オブジェクト を破 棄 します。

注 : リスト ボックスの必 要 がなくなり、メモリを解 放 する必 要 がある場 合 に、この関 数 を呼 び

出 します。

193
Chapter: 5 CSV_include リファレンス

シンタックス
CSV_ListBox_Destroy(hList)
#hList:

リスト オブジェクト へのハンドル。

戻 り値
成 功 した場 合 は 0、そうでなければ -1 となります。

CSV_ListBox_GetCategory
指 定 された ItemID に関 連 した項 目 のカテゴリを返 します。

シンタックス
CSV_ListBox_GetCategory(hList,sItemID)
#hList:

オブジェクト のリスト へのハンドル。

#sItemID:

項 目 の ItemID。

戻 り値
sItemID と同 じ ItemID を持 つ項 目 のカテゴリ。

CSV_ListBox_GetItem
与 えられた ItemID に関 連 したアイテム テキスト を返 します。

シンタックス
CSV_ListBox_GetItem(hList,sItemID)
#hList:

オブジェクト のリスト へのハンドル。

#sItemID:

項 目 の ItemID。

戻 り値
sItemID と同 じ ItemID を持 つ項 目 のカテゴリ。

194
 Chapter: 5 CSV_include リファレンス

CSV_ListBox_GetItemID
指 定 された項 目 のテキスト に関 連 付 けられた項 目 ID を返 します。

シンタックス
CSV_ListBox_GetItemID(hList,sItem)
#hList:

オブジェクト のリスト へのハンドル。

#sItem:

項 目 のテキスト (リスト ボックスに表 示 されているテキスト )。

戻 り値
ItemID。

CSV_ListBox_GetSelectedItem
リスト が表 示 されるときに呼 び出 されます。選 択 した項 目 を返 します。

シンタックス
CSV_ListBox_GetSelectedItem(hList)
#hList:

オブジェクト のリスト へのハンドル。

戻 り値
リスト から選 択 された項 目 。

CSV_ListBox_GetSelectedItemCategory
リスト から選 択 された後 に呼 び出 されます。選 択 した項 目 のカテゴリを返 します。

シンタックス
CSV_ListBox_GetSelectedItemCategory(hList)
#hList:

オブジェクト のリスト へのハンドル。

戻 り値
リスト から選 択 された項 目 のカテゴリ。

195
Chapter: 5 CSV_include リファレンス

CSV_ListBox_GetSelectedItemID
項 目 がリスト から選 択 された後 に呼 び出 されて、項 目 ID を取 得 します。

シンタックス
CSV_ListBox_GetSelectedItemID(hList)
#hList:

オブジェクト のリスト へのハンドル。

戻 り値
リスト から選 択 された項 目 の ItemID。

CSV_ListBox_GetTagComment
括 弧 で囲 まれたタグ コメント と名 前 を含 む文 字 列 からタグ コメント を抽 出 します。

シンタックス
CSV_ListBox_GetTagComment(sItem)
#sItem:

タグ名 とコメント を含 む文 字 列 。

戻 り値
文 字 列 sItem に含 まれるタグのコメント

CSV_ListBox_GetTagDescFromTag
タグ名 からタグ名 とコメント を抽 出 します。

シンタックス
CSV_ListBox_GetTagDescFromTag(sTrendTag)
#sTrendTag:

タグ名 。

戻 り値
フォーマット されたタグ名 とコメント を含 む文 字 列 。

CSV_ListBox_GetTagName
括 弧 で囲 まれたタグ コメント と名 前 を含 む文 字 列 から、タグ名 を抽 出 します。

196
 Chapter: 5 CSV_include リファレンス

シンタックス
CSV_ListBox_GetTagName(sItem)
#sItem:

タグ名 とコメント を含 む文 字 列 。

戻 り値
文 字 列 sItem followed byに含 まれるタグ名 。

CSV_ListBox_GetTrendDescFromTag()
ActiveX リスト オブジェクト のコンボ ボックスから項 目 を削 除 します。

シンタックス
CSV_ListBox_GetTrendDescFromTag(#sTrendTag)
#sTrendTag:

ト レンド タグの名 前 。

戻 り値
フォーマット されたト レンド タグ名 とコメント を含 む文 字 列 。

CSV_ListBox_RemoveItem
ActiveX リスト オブジェクト のコンボ ボックスから項 目 を削 除 します。

注 : 次 の 2 つの選 択 肢 があります。1) sItem および sCategory を指 定 する。2) sItem =

""、sCategory = "" を設 定 し てsItemID のみを指 定 する。

シンタックス
CSV_ListBox_RemoveItem(hList,sItem,sCategory,sItemID)
#hList:

オブジェクト のリスト へのハンドル。

#sItem:

リスト から削 除 するアイテム。

#sCategory:

アイテムのカテゴリ。

197
Chapter: 5 CSV_include リファレンス

#sItemID:

アイテムのID。

戻 り値
成 功 した場 合 は 0、そうでなければ -1 となります。

CSV_ListBox_Hide
リスト を非 表 示 にします。

シンタックス
CSV_ListBox_Hide(hList)
#hList:

オブジェクト のリスト へのハンドル。

戻 り値
成 功 した場 合 は 0、そうでなければ -1 となります。

CSV_ListBox_SelectCategories
リスト (指 定 のカテゴリを持 つ項 目 のみを表 示 するフィルタ リスト ) に表 示 される項 目 のカテゴリ
を選 択 します。複 数 のカテゴリは、コンマ (カテゴリ間 にスペースをいれません) で区 切 って表 示
することができます。
注 : Categories を "" に指 定 すると、カテゴリ フィルタを削 除 します。

シンタックス
CSV_ListBox_SelectCategories(hList, sCategories)
#hList:

オブジェクト のリスト へのハンドル。

#sCategories:

リスト をフィルタするカテゴリ。

戻 り値
成 功 した場 合 は 0、そうでなければ -1 となります。

CSV_ListBox_SelectTags()

198
 Chapter: 5 CSV_include リファレンス

コンボ ボックスを備 えた ActiveX オブジェクト を作 成 すると、タグをリスト から選 択 できるようにな

ります。タグ リスト オブジェクト が既 に存 在 する場 合 、新 しいインスタンスが作 成 されます。

戻 り値
タグ リスト オブジェクト へのハンド ル。

CSV_ListBox_SelectTrends()
コンボ ボックスを備 えた ActiveX オブジェクト を作 成 すると、ト レンド タグをリスト から選 択 できる
ようになります。ト レンド タグ リスト オブジェクト が既 に存 在 する場 合 、新 しいインスタンスが作
成 されます。

戻 り値
ト レンド リスト オブジェクト へのハンド ル。

CSV_ListBox_SetText
ActiveX リスト オブジェクト のタイト ル、説 明 、[OK] ボタン、または [キャンセル] ボタンのテキスト
を設 定 します。

シンタックス
CSV_ListBox_SetText(hList,sTitle,sDesc,sOK,sCancel)
#hList:

オブジェクト のリスト へのハンドル。

#sTitle:

フォームに表 示 するタイト ル。

#sDesc:

フォームに表 示 する説 明 。

#sOK:

[OK] ボタンに表 示 されるテキスト 。

#sCancel:

[キャンセル] ボタンに表 示 されるテキスト 。

戻 り値
成 功 した場 合 は 0、そうでなければ -1 となります。

CSV_ListBox_Show

199
Chapter: 5 CSV_include リファレンス

タグのリスト を表 示 します。

シンタックス
CSV_ListBox_Show(hList,sTitle,sDesc,sOK,sCancel,iX,iY)
#hList:

オブジェクト のリスト へのハンドル。

#sTitle:

フォームに表 示 するタイト ル。

#sDesc:

フォームに表 示 する説 明 。

#sOK:

[OK] ボタンに表 示 されるテキスト 。

#sCancel:

[キャンセル] ボタンに表 示 されるテキスト 。

#iX:

左 隅 の X 座 標 、または、-9999 を指 定 するとアクティブなモニタで水 平 方 向 の中 央 に配 置 されます。

#iY:

上 部 隅 の Y 座 標 、また、9999 を指 定 するとアクティブなモニタで垂 直 方 向 の中 央 に配 置 されます。

戻 り値
リスト から選 択 された項 目 (項 目 が選 択 されない場 合 は空 白 を返 します)

CSV_ListBox_TagFormat
括 弧 で囲 まれた変 数 に関 連 付 けられたコメント と指 定 された変 数 の名 前 を含 む文 字 列 をフ
ォーマット します。変 数 をト レンディングに使 用 できる変 数 のド ロップダウン リスト に追 加 する前
に、呼 び出 されます。ド ロップダウン リスト の各 項 目 をフォーマット します。

シンタックス
CSV_ListBox_TagFormat(sVariable)
#sVariable:

フォーマット する変 数 名 。

CSV_ListBox_Visible

200
 Chapter: 5 CSV_include リファレンス

リスト ボックスが現 在 表 示 されているかどうかを確 認 します。

シンタックス
CSV_ListBox_Visible(hObject)
#hObject:

オブジェクト のリスト へのハンドル。

戻 り値
リスト が現 在 、表 示 されている場 合 は 1、そうでなければ 0 を返 します。

CSV_Math_RoundDown
実 数 を指 定 した小 数 点 以 下 の位 置 で( ０に) 切 り捨 てます。

シンタックス
CSV_Math_RoundDown(rValue, iDecPlaces)
#rValue:

切 り捨 てる値 。

#iDecPlaces:

切 り捨 てを実 行 する小 数 点 以 下 の位 置 。

CSV_Math_RoundDown(4.328, 2) = 4.32
CSV_Math_RoundDown(4.321, 2) = 4.32
CSV_Math_RoundDown(-4.321, 2) = -4.32
CSV_Math_RoundDown(512.3, -2) = 500

戻 り値
切 り捨 てられた値 。

CSV_Math_Truncate
実 数 値 を整 数 値 に切 り捨 てます。

シンタックス
CSV_Math_Truncate(rValue)

201
Chapter: 5 CSV_include リファレンス

CSV_Math_Truncate(4.328) = 4
CSV_Math_Truncate(5.867) = 5

戻 り値
切 捨 てられた値 (整 数 )。

CSV_MenuConfig_Close()
メニューの設 定 ポップアップを閉 じます。変 更 を保 存 しなかった場 合 、設 定 の保 存 を促 すプロン
プト が表 示 されます。

戻 り値
成 功 した場 合 は 0、そうでなければ -1 となります。

CSV_MenuConfig_Display()
メニューの設 定 ポップアップウィンド ウを表 示 して、ユーザーがランタイム時 にメニューを設 定 する
ことができます。

戻 り値
成 功 した場 合 は 0、そうでなければ -1 となります。

CSV_MenuConfig_LoadDflt()
「Bin」ディレクト リからデフォルト のメニュー設 定 を読 み込 みます。

戻 り値
成 功 した場 合 は 0、そうでなければ -1 となります。

CSV_MenuConfig_UserPages()
メニュー設 定 を更 新 して、[ページ] メニューからシステム以 外 のすべての ページを選 択 できるよ
うにします (ページ最 大 数 は25)。

戻 り値
成 功 した場 合 は 0、そうでなければ -1 となります。

CSV_MessageBox

202
 Chapter: 5 CSV_include リファレンス

アクティブなモニター画 面 の中 央 にメッセージ ボックスを表 示 し、ユーザーがボタンを選 択 するま

で、待 機 します。チェックボックスに加 え、最 高 3 つのボタンを表 示 できます。指 定 したタイムア
ウト の後 に非 表 示 にすることができます。使 用 する場 合 、最 大 タイムアウト は 30 秒 です。0 を
指 定 すると、タイムアウト は適 用 されません。
注 : 例 えば、カスタムボタン 1、2、3を使 用 する場 合 。基 となるウィジェット の動 作 により、1 また
は 2 のボタンのカスタム ポップアップには、キャンセルまたはタイムアウト 機 能 はありません。3 の
ボタンには、タイムアウト があります。2 つのボタンを使 用 する際 は、次 のシンタックスを使 用 する
ことを推 奨 します。
"button1", "button2", "Cancel"
このシンタックスを使 用 すると、2 のボタンでタイムアウト 機 能 を選 択 できるようになります。この
例 では、Cicode で「2」ボタンでの応 答 を、キャンセル (299) の意 味 で使 用 する必 要 がありま
す。
2 つ目 のポップアップが同 じタイト ルを表 示 しようとすると、エラー 359 が返 されます。このメッセー
ジ ボックスの配 置 が同 じため、ポップアップボックスが複 数 表 示 されると、問 題 が起 こる場 合 が
あります。

シンタックス
CSV_
MessageBox
(sTitle,sPrompt,iMode,iTimeout,sButton1Text,sButton2Text,sButton3Text,sCheckboxText)
#sTitle:

メッセージ ボックスのタイト ル

#sPrompt:

メッセージ ボックス プロンプト

#iMode:
l 0 - [OK] ボタンのみ (デフォルト )
l 1 –[OK] および [キャンセル] ボタン
l 2 – [中 止 ] 、[再 試 行 ] 、[無 視 ] ボタン
l 3 – [はい] 、[いいえ] 、[キャンセル] ボタン
l 4 – [はい] および [いいえ] ボタン
l 5 – [再 試 行 ] および [キャンセル] ボタン
l 16 – 重 要 なメッセージ
l 32 – 警 告 クエリー
l 48 – 警 告 メッセージ
l 64 – 情 報 メッセージ
l 0 – 最 初 のボタンがデフォルト (デフォルト )

203
Chapter: 5 CSV_include リファレンス

l 256 – 2 番 目 のボタンがデフォルト
l 512 – 3 番 目 のボタンがデフォルト
l 768 – 4 番 目 のボタンがデフォルト
l 0 – アプリケーション モーダル メッセージ ボックス (デフォルト )
l 4096 – システム モーダル メッセージ ボックス
l 16384 – メッセージ ボックスにヘルプボタンを追 加
l 65536 – メッセージ ボックスのウィンド ウを、一 番 手 前 に表 示
l 524288 = テキスト を右 揃 えにする
l 1048576 – ヘブライ語 およびアラブ語 のシステムでテキスト を右 から左 に表 示 する
ように指 定
#iTimeout:

メッセージ ボックスが閉 じるまでの秒 数 。

#sButton1Text:

最 初 のボタンのテキスト

#sButton2Text:

2 番 目 のボタンのテキスト

#sButton3Text:

3 番 目 のボタンのテキスト

#sCheckBoxText:

チェックボックスのテキスト

戻 り値
sButtonText1が "" または 3 つのテキスト ボックスがすべて使 用 されている場 合

戻 り値 説明

0 [OK] ボタンが押 されています

299 [キャンセル] ボタンが押 されています

359 同 じタイト ルのポップアップが既 に表 示 されています

512 タイムアウト が発 生 しました

3 [中 止 ] ボタンが押 されています

4 [再 試 行 ] ボタンが押 されています

5 [無 視 ] ボタンが押 されています

6 [はい] ボタンが押 されています

7 [いいえ] ボタンが押 されています

204
 Chapter: 5 CSV_include リファレンス

それ以 外 の場 合

戻 り値 説明

0 最 初 のボタン

1 2 番 目 のボタンが押 されています

2 3 番 目 のボタンが押 されています

359 同 じタイト ルのポップアップが既 に表 示 されています

sCheckBoxText <> ""の場 合 、1024が上 の戻 り値 に追 加 されます。

CSV_Misc_CheckNumPadValue
MultiMonitor Numpad を使 用 して値 を取 得 し、値 の範 囲 を確 認 して、新 しい値 を返 しま
す。範 囲 が正 しくない場 合 は、元 の値 を返 します。

シンタックス
CSV_Misc_CheckNumPadValue(sDESC, rValue, rUpLimit, rLowLimit)
#sDESC:

数 字 パッドのフォーム タイト ルに表 示 される説 明 (文 字 列 )

#rValue:

変 更 される元 の値 (実 数 または整 数 )

#rUpLimit:

元 の値 が変 更 される上 限 (実 数 または整 数 )

#rLowLimit:

元 の値 が変 更 される下 限 (実 数 または整 数 )

戻 り値
新 しい値 、または範 囲 外 の場 合 は元 の値 。

例
Tag = CSV_Misc_CheckNumPadValue("change Value", Tag, 190, 10)
! This will means that Tag can only have values of 10 - 190 written to it via the
formNumPad.

CSV_Misc_IntRange
整 数 として指 定 された範 囲 が有 効 であるかチェックします。もし有 効 でない場 合 、メッセージが
表 示 され、正 しい範 囲 を提 示 します。

205
Chapter: 5 CSV_include リファレンス

シンタックス
CSV_Misc_IntRange(LowerRange,UpperRange,OriginalValue,NewValue)
#LowerRange:

要 求 された範 囲 の下 限

#UpperRange:

要 求 された範 囲 の上 限

#Original Value:

元 に戻 す値 ; 値 が無 効 または範 囲 外 である場 合 、この値 が使 用 されます。

#New Value:

変 更 する新 しい値 。

戻 り値
新 しい値 。または、範 囲 外 の場 合 は元 の値 。

CSV_Misc_MouseOver
マウスが「hAN」にあるオブジェクト の範 囲 で定 義 されたエリア内 にある場 合 TRUE が返 されま
す。

シンタックス
CSV_Misc_MouseOver(hAN)
#hAN:

表 示 するオブジェクト のアニメーション番 号 。

戻 り値
l マウスが指 定 の表 示 オブジェクト の範 囲 で定 義 されたエリア内 にある場 合 TRUE (1) が返 さ
れます。
l そうでなければ、FALSE(0) を返 します。

CSV_MM_BackEmpty()
前 に戻 るナビゲーションが可 能 であるかチェックします。
注 : CSV_MM_BackEmpty() =1 の場 合 、前 に戻 るナビゲーションを無 効 にします (現 在 位 置
から、前 に戻 る方 向 にナビゲート するページがページスタックにない) 。

206
 Chapter: 5 CSV_include リファレンス

戻 り値
前 に戻 るナビゲーションが可 能 ではない場 合 は 1、そうでなければ 0 を返 します。

CSV_MM_ConfigInit()
複 数 モニター機 能 に必 要 なパラメータを初 期 化 します。前 に表 示 したページを保 管 するキュー
(前 のページのスタック) を初 期 化 します。次 のパラメータ値 が .ini file [MultiMonitors] セクショ
ンから読 み込 まれます。
l モニター数 (パラメータ= 「Monitors」、デフォルト = 1) 。
l モニターの画 面 幅 (パラメータ= 「ScreenWidth」、デフォルト = 1024)。
l 各 モニターの開 始 ページ (パラメータ= 「Startup1」、「Startup2」、... 等 、モニター数 によって
異 なります。デフォルト = 「Startup」) 。
前 のページのスタックサイズ (パラメータ= 「LastPageStackSize」、デフォルト = 10)。

CSV_MM_FwdEmpty()
次 に進 むナビゲーションが可 能 であるかチェックします (前 に戻 るナビゲーションを使 用 した場 合
のみに可 能 )。

戻 り値
次 に進 むナビゲーションが可 能 ではない場 合 は1、そうでなければ0を返 します。

注 : CSV_MM_FwdEmpty() = 1の場 合 、順 方 向 へのナビゲーションを無 効 にします (現 在

位 置 から、次 に進 む方 向 にナビゲート するページがページスタックにない) 。

CSV_MM_GetMonitor()
現 在 、アクティブなモニターの番 号 を取 得 します。「アクティブな」モニターとは、現 在 アクティブな
ウィンド ウで一 番 大 きな面 積 を占 めているモニターを示 します。

戻 り値
現 在 アクティブなモニターの番 号 。

CSV_MM_GetMonitors()
ini ファイルの [MultiMonitors] セクションのMonitorsパラメータによって設 定 されるモニター番 号
を取 得 します。

戻 り値
モニターの番 号 。

207
Chapter: 5 CSV_include リファレンス

CSV_MM_GetMouseX
デスクト ップ、モニター、またはウィンド ウに対 するマウス位 置 のX 座 標 を取 得 します。

シンタックス
CSV_MM_GetMouseX(iMode)
#iMode:
l 0 =デスクト ップの左 上 に対 するマウス位 置 を取 得 します。
l 1 =アクティブなモニターの左 上 に対 するマウス位 置 を取 得 します。
l 2 =アクティブなウィンド ウの左 上 に対 するマウス位 置 を取 得 します。

CSV_MM_GetMouseY
デスクト ップ、モニター、またはウィンド ウに対 するマウス位 置 のY座 標 を取 得 します。

シンタックス
CSV_MM_GetMouseY(iMode)
#iMode:
l 0 =デスクト ップの左 上 に対 するマウス位 置 を取 得 します。
l 1 =アクティブなモニターの左 上 に対 するマウス位 置 を取 得 します。
l 2 =アクティブなウィンド ウの左 上 に対 するマウス位 置 を取 得 します。

CSV_MM_GetOffset
選 択 したモニターのXオフセット を取 得 します。選 択 したモニターにページを表 示 するには、その
ページのX座 標 をこの値 を設 定 する必 要 があります。

シンタックス
CSV_MM_GetOffset(iMonitorNo)
#iMonitorNo:

Xオフセット を取 得 するモニターの番 号 。

戻 り値
モニターのオフセット 。

CSV_MM_GetScreenWidth()
iniファイルのScreenWidthパラメータ[MultiMonitors]によって設 定 される、画 面 の幅 を取 得 しま
す。

208
 Chapter: 5 CSV_include リファレンス

戻 り値
画面幅。

CSV_MM_ListLastPages
アクティブなモニターに現 在 のページから前 後 にナビゲート するページをリスト するメニューを表 示
します。スタックは、最 近 表 示 されたページを表 示 された順 に保 存 します。この関 数 は、これら
のページを選 択 し、表 示 できるようにします。

シンタックス
CSV_MM_ListLastPages(Mode)
#Mode :
l 0 =前 に戻 ってナビゲート されるページをリスト します。
l 1 =前 に進 んでナビゲート されるページをリスト します。

戻 り値
成 功 した場 合 は 0、そうでなければ -1 となります。

CSV_MM_MonitorFromPoint
指 定 したポイント を含 むモニターの番 号 を取 得 します。

シンタックス
CSV_MM_MonitorFromPoint(iX, iY)
#iX:

ポイント のX座 標 。

#iY:

ポイント のY座 標 。

戻 り値
指 定 したポイント を含 むモニターの番 号 。

CSV_MM_MonitorFromWindow
指 定 したウィンド ウの最 大 エリアで重 なっているモニターの番 号 を取 得 します。

シンタックス
CSV_MM_MonitorFromWindow(iWindowNo)

209
Chapter: 5 CSV_include リファレンス

#iWindowNo:

モニター番 号 を取 得 するウィンドウ番 号 。

戻 り値
ウィンド ウに関 連 したモニターの番 号 。

CSV_MM_MonitorGoto
指 定 したモニターのメイン ウィンド ウに移 動 します。

シンタックス
CSV_MM_MonitorGoto(iMonitor)
#iMonitor:

移 動 するモニターの番 号 。

戻 り値
正 常 に実 行 された場 合 、モニターに関 連 したメイン ウィンド ウの番 号 、そうでなければ、-1を返
します。

CSV_MM_NextEmpty()
'次 の'ページが、現 在 のページに対 して定 義 されているかチェックします。

注 : CSV_MM_NextEmpty() = 1の場 合 、'次 のページ'のナビゲーション ボタンを無 効 にします。

戻 り値
'次 のページ'が定 義 されていない場 合 は1、そうでなければ0を返 します。

CSV_MM_PageDisplay
'アクティブな'モニター、またはあらかじめ選 択 したモニターで選 択 したページを表 示 します。

シンタックス
CSV_MM_PageDisplay(sPage,iMonitor,bStoreLastPage,sStoreFunction)
#sPage:

表 示 するページ名 。

#iMonitor:

210
 Chapter: 5 CSV_include リファレンス

ページを表 示 するモニターの番 号 。最 初 のモニター は0、2番 目 のモニターは1など。iMonitor = -1の場

合 、ページは「アクティブな」(現 在 選 択 されている) モニターに表 示 されます。

#bStoreLastPage:

前 のページ スタックにページを追 加 します。bStoreLastPage = 0の場 合 、ページは表 示 された前 のページ

を保 存 するキューに書 き込 まれません。

#sStoreFunction:

前 のページスタックに保 存 する関 数 の名 前 。

関 数 が指 定 されると、前 のページまでナビゲート すると、ページを表 示 するのではな

く、その関 数 が呼 び出 されます。
引 数 を含 めるには、関 数 の名 前 にスペースを入 れ、次 にコンマで区 切 った引 数 (文
字 列 定 数 ) のリスト を入 れます。

戻 り値
正 常 に実 行 した場 合 は0、そうでなければエラー番 号 を返 します。

CSV_MM_PageLast
前 のページ スタックをナビゲート します。前 に表 示 されたページに関 して、あらかじめ設 定 された
数 だけ表 示 されていた順 番 で前 に戻 ったり、先 に進 んだり移 動 できます。スタックは、現 在 アク
ティブなモニターに固 有 です。つまり、アクティブなモニターに表 示 された前 に表 示 されたページ
のみがナビゲート されます。

シンタックス
CSV_MM_PageLast(iMode)
#iMode:

ナビゲーションの方 向 :
l 0 =前 に戻 る (デフォルト )。
l 1 =次 に進 む。

戻 り値
正 常 に実 行 した場 合 は0、そうでなければ -1を返 します。

CSV_MM_PageNext()
現 在 アクティブなページの'次 のページ'を表 示 します。ページは同 じモニター (現 在 アクティブなモ
ニター) に表 示 されます。

戻 り値
成 功 した場 合 は 0、そうでなければ -1 となります。

211
Chapter: 5 CSV_include リファレンス

CSV_MM_PagePrev()
現 在 アクティブなページの'前 のページ'を表 示 します。ページは同 じモニターに表 示 されます (現
在 アクティブなモニター)。

戻 り値
成 功 した場 合 は 0、そうでなければ -1 となります。

CSV_MM_PagesInit()
起 動 ページを表 示 します。.iniファイル [MultiMonitors] セクションからパラメータの値 が読 み込
まれます。

注 : この機 能 は複 数 のモニターをサポート する必 要 がある、すべてのクライアント に対 し、起

動 時 に呼 び出 されます。起 動 時 のCicode関 数 内 からこの関 数 を呼 び出 さずに使 用 でき
るように、周 期 イベント として設 定 されています ('CSV_MultiMonitor'イベント としてリスト さ
れています)。イベント を最 初 に処 理 するとき、複 数 のモニターの機 能 が初 期 化 されます。そ
の後 のすべての呼 び出 しは、何 の処 理 も行 わずにすぐに戻 されます。

CSV_MM_PreviousEmpty()
'前 の'ページが、現 在 のページに対 し定 義 されているかチェックします。

注 : CSV_MM_PreviousEmpty() = 1の場 合 、'前 のページ'のナビゲーション ボタンを無 効

にします。

戻 り値
'前 のページ'が定 義 されていない場 合 は1、そうでなければ0を返 します。

CSV_MM_StoreLastPage
選 択 したモニターの前 のページ スタックにページを追 加 します。ページ タイト ルはアクセスした順
にページを保 存 するキューに書 き出 されます。(各 モニターは、それぞれのキューがあります。)前
のページにナビゲーションするときに実 行 するアクションも保 存 されます。

シンタックス
CSV_MM_StoreLastPage(iMonitorNo,sPageAction,sPageTitle)
#iMonitorNo:

ページが表 示 されるモニタ番 号 。

#sPageAction:

212
 Chapter: 5 CSV_include リファレンス

前 のページスタックに保 存 するアクション名 。

関 数 を指 定 するには、「?」を関 数 名 の最 初 にプリフィックスとして付 けます。関 数 が

指 定 されると、最 後 のページにナビゲート すると、ページを表 示 するのではな
く、その関 数 が呼 び出 されます。
引 数 を含 めるには、関 数 の名 前 にスペースを入 れ、次 にコンマで区 切 った引 数 (文
字 列 定 数 ) のリスト を入 れます。
#sPageTitle:

表 示 されるページ名 。

戻 り値
前 に戻 るナビゲーションが可 能 ではない場 合 は 1、そうでなければ 0 を返 します。

CSV_MM_WinDrag()
マウスを使 用 してアクティブなウィンド ウを移 動 させます。つまり、ウィンド ウの位 置 は、マウスの移
動 を追 跡 します。

注 : CSV_MM_WinDragEnd を呼 び出 し、ウィンド ウのド ラッグを終 了 します。

CSV_MM_WinDragEnd()
CSV_MM_WinDrag()によって開 始 されたウィンド ウのド ラッグを終 了 します。

CSV_MM_WinFree()
アクティブなウィンド ウがモニターのメインウィンド ウでない場 合 、アクティブなウィンド ウを閉 じま
す。
WinFreeではなく、CSV_MM_WinFreeを呼 び出 すと、割 り当 てられたすべてのモニターで少 なくとも一
つのウィンド ウを開 いたままにします。開 いたままになるウィンド ウは、CSV_MM_PageDisplay関 数 に
よって開 かれたウィンド ウです。
複 数 のモニタの機 能 を使 用 している場 合 は、必 ず CSV_MM_WinFree を呼 び出 してウィンド ウを閉 じてくださ
い。

戻 り値
正 常 に実 行 された場 合 は0、そうでなければエラーが返 されます。-1が返 される場 合 、モニター
のメイン ウィンド ウを閉 じようとしたことを示 します。

CSV_MM_WinNewAt
アクティブなモニターの左 上 を基 準 としたX・Y座 標 に新 規 ウィンド ウを表 示 します。

213
Chapter: 5 CSV_include リファレンス

シンタックス
CSV_MM_WinNewAt(sPage,iX,iY,iMode)
#sPage:

表 示 するページウィンドウ名 。

#iX:

モニターの左 側 にウィンドウを表 示 するXオフセット 。

#iY:

モニターの上 部 にウィンドウを表 示 するYオフセット 。

#iMode:

表 示 モード ('WinNewAt'関 数 と同 じ設 定 ですが、デフォルト ではウィンドウはモードに64を追 加 するかどう

かにかかわらず、[常 に最 前 面 に表 示 ] になります。これによりポップアップ ウィンドウはメインウィンドウの後
ろに隠 れることはありません。このオプションを解 除 するには、2048をモードに追 加 します)。4096がモードに
追 加 されない限 り動 的 なサイズの変 更 は無 効 になります。ページ内 で、ウィンドウを中 央 に配 置 するに
は、8192 をモードに追 加 します。

戻 り値
ウィンド ウのウィンド ウ番 号 、またはウィンド ウを開 くことができない場 合 は、-1を返 します。

CSV_MM_WinPopup
ポップアップ ウィンド ウをアクティブなモニターの左 上 を基 準 としたX・Y座 標 に表 示 します。

シンタックス
CSV_MM_WinPopup(sWindow, iX, iY, iHideTitleBar)
#sWindow:

表 示 するページのウィンドウ名 。

#iX:

モニターの左 側 にウィンドウを表 示 するX座 標 。

#iY:

モニターの上 部 にウィンドウを表 示 するY座 標 。

#iHideTitleBar :
l 0 =ウィンド ウの標 準 タイト ル バーを表 示 します。
l 1 =タイト ル バーを表 示 しません (XPスタイル ウィンド ウ用 )。

214
 Chapter: 5 CSV_include リファレンス

戻 り値
ウィンド ウのウィンド ウ番 号 、またはウィンド ウを開 くことができない場 合 は、-1を返 します。

注 : 全 体 のウィンド ウは単 一 画 面 内 に表 示 されます。iX = -1およびiY = -1の場 合 、ウィン

ド ウは画 面 の中 央 に配 置 されます。

CSV_MM_WinTitle
ウィンド ウ タイト ルを設 定 します。ウィンド ウ タイト ルを設 定 するには、WinTitleではなくこの関 数
を呼 び出 します。ウィンド ウがメイン ページの場 合 、前 のページ スタックのページ タイト ルを変 更
します。正 しいページ タイト ルを前 に戻 る/次 に進 むナビゲーション ド ロップダウン リスト に表 示 し
ます。

シンタックス
CSV_MM_WinTitle(sTitle)
#sTitle:

ウィンドウのタイト ル。

戻 り値
正 常 に実 行 された場 合 は 0、そうでなければエラーが返 されます。

CSV_Nav_Alarms()
アラーム ページを表 示 、またはアラーム ページに定 義 された関 数 を呼 び出 します。

注 : ネット ワーク ページはパラメータ [Navigation] AlarmPage によって定 義 されます。関 数

を指 定 するには、「?」を関 数 名 の最 初 にプリフィックスとして付 けます。

戻 り値
成 功 した場 合 は 0、そうでなければ -1 となります。

CSV_Nav_AlarmsDisabled()
無 効 なアラーム ページを表 示 するか、または無 効 なアラーム ページ用 に定 義 された関 数 を呼
び出 します。

注 : ネット ワーク ページはパラメータ[Navigation]DisabledPageで定 義 されます。関 数 を指 定

215
Chapter: 5 CSV_include リファレンス

するには、関 数 の名 前 に「?」のプリフィックスを付 けます。

戻 り値
成 功 した場 合 は 0、そうでなければ -1 となります。

CSV_Nav_AlarmsHardware()
ハード ウェア アラーム ページを表 示 、またはハード ウェア アラーム ページに定 義 された関 数 を
呼 び出 します。

注 : ネット ワーク ページはパラメータ [Navigation] HardwarePageによって定 義 されます。

関 数 を指 定 するには、「?」を関 数 名 の最 初 にプリフィックスとして付 けます。

戻 り値
成 功 した場 合 は 0、そうでなければ -1 となります。

CSV_Nav_AlarmsSummary()
アラーム ページを表 示 、またはアラーム ページに定 義 された関 数 を呼 び出 します。

注 : ネット ワーク ページはパラメータ[Navigation]SummaryPageで定 義 されます。関 数 を指 定

するには、「?」を関 数 名 の最 初 にプリフィックスとして付 けます。

戻 り値
成 功 した場 合 は 0、そうでなければ -1 となります。

CSV_Nav_CloseWindow()
CitectSCADAをシャット ダウンできるようにフォームを表 示 します。

CSV_Nav_DisableMenuItem
指 定 したポップアップ メニューで指 定 したアイテムを有 効 /無 効 にします。メニュー アイテムが無
効 化 すると、ポップアップ メニューに浮 き彫 りで表 示 され、選 択 することができなくなります。

シンタックス
CSV_Nav_DisableMenuItem(iMode,sMenuItem,sSubMenuItem,sMenuName,sPageName)
#iMode:
l 1 = 無 効 なメニュー アイテム。
l 0 = 有 効 なメニュー アイテム。

216
 Chapter: 5 CSV_include リファレンス

#sMenuItem:

有 効 /無 効 にするメニュー アイテム。

#sSubMenuItem:

有 効 /無 効 にするサブメニュー アイテム (適 用 する場 合 )。

#sMenuName:

メニューの名 前 (ポップアップ メニューに関 連 付 けられたボタン)。

#sPageName:

メニューに関 連 付 けられたページの名 前 。

戻 り値
成 功 した場 合 は 0、そうでなければ -1 となります。

CSV_Nav_DisplayMenuBar
指 定 したページのメニューバーを作 成 します。メニューバーに表 示 するボタンを決 定 する際
に、PageMenu.dbf (以 前 の名 前 はMenu.dbf) にアクセスします。指 定 したボタンをもつ新 しい
メニュー バー (ActiveX オブジェクト ) が作 成 されます。

シンタックス
CSV_Nav_DisplayMenuBar(sPageName,iX,iY,nBackColour,nForeColour)
#sPageName:

ページ名 。

#iX:

メニューバーの左 上 のX座 標 。

#iY:

メニューバーの左 上 のY座 標 。

#nBackColour:

メニューバーの背 景 色 (CitectSCADAパレット 番 号 )。

#nForeColour:

メニューバーの前 景 (フォント ) 色 (CitectSCADAパレット 番 号 )。

戻 り値
成 功 した場 合 は 0、そうでなければ -1 となります。

217
Chapter: 5 CSV_include リファレンス

CSV_Nav_DisplayPopupMenu
指 定 したページと指 定 したメニューに対 し、ポップアップ メニューを表 示 します。メニューの左 上
のコーナーは、指 定 した XY 座 標 に表 示 されます。

シンタックス
CSV_Nav_DisplayPopupMenu(sPageName,sMenuName,iX,iY)
#sPageName:

ページ名 。

#sMenuName:

メニュー名 。

#iX:

ポップアップ メニューバーの左 上 のX座 標 。

#iY:

ポップアップ メニューバーの左 上 のY座 標 。

戻 り値
成 功 した場 合 は 0、そうでなければ -1 となります。

CSV_Nav_File
テキスト /リッチ テキスト ファイルを表 示 します。

シンタックス
CSV_Nav_File(sTitle,sFile,iMode,sFontName,iFontSize,iFontColour, iBackColour,iWordWrap)
#sTitle:

ファイル ページに表 示 するタイト ル。

#sFile:

パスを含 むファイル名 (例 ：「[Run] :\file.txt」)。

#iMode:
l 1 = ロック (編 集 を許 可 しない)。
l 2 = 保 存 を許 可 (ポップアップ コンテキスト メニューで保 存 オプションを有 効 にす
る)。
l 4 = 作 成 を許 可 (存 在 しない場 合 は、ファイルを作 成 する)。

218
 Chapter: 5 CSV_include リファレンス

l 8 = 開 くことを許 可 (ポップアップ コンテキスト メニューで開 くオプションを有 効 にし、

別 に開 くファイルの参 照 を可 能 にする)。
#sFontName:

ファイルを表 示 するフォント 名 (rtfファイルではない場 合 )。

#iFontSize:

フォント サイズ (rtf ファイルではない場 合 )。

#iFontColour:

フォント の色 (rtf ファイルではない場 合 )。

#iBackColour:

背景色。

#iWordWrap:

語 句 の折 り返 し。

戻 り値
成 功 した場 合 は 0、そうでなければ -1 となります。

CSV_Nav_GetEngToolsPrivilege()
設 定 ツールを利 用 する権 限 レベルをユーザーが持 っているか確 認 します。

戻 り値
特 権 レベルをもっている場 合 は 1、そうでなければ 0 を返 します。

CSV_Nav_Home()
ホーム ページを表 示 するか、またはホーム ページ用 に定 義 された関 数 を呼 び出 します。

注 : ホームページは、パラメータ[Navigation]HomePageによって定 義 されます。関 数 を指 定 す
るには、「?」を関 数 名 の最 初 にプリフィックスとして付 けます。

戻 り値
成 功 した場 合 は 0、そうでなければ -1 となります。

CSV_Nav_Login()
ユーザーがログインするポップアップ フォームを表 示 します。

CSV_Nav_LoginMenu()

219
Chapter: 5 CSV_include リファレンス

ログイン スクリーンのポップアップ メニューを表 示 します。

注 : ログイン ポップアップ メニューはPageMenu.dbf (以 前 の名 前 はMenu.dbf) の「テンプ

レート 」ページおよび「ログイン」メニューで定 義 されます。「ログイン」メニュー
が、PageMenu.dbfのこのセクションで定 義 されていない場 合 、デフォルト のメニューが表 示
されます。

CSV_Nav_MenuBar_MenuClick
ActiveX メニューバーのボタンをクリックしてト リガーされるイベント 。

シンタックス
CSV_Nav_MenuBar_MenuClick(sPageName,sButtonName,iX,iY)
#sPageName:

メニューを含 むページの名 前 。

#sButtonName:

クリックされるボタンの名 前 。

#iX:

メニューバーの左 上 のX座 標 。

#iY:

メニューバーの左 上 のY座 標 。

CSV_Nav_Network()
ネット ワーク ページを表 示 、またはネット ワーク ページに定 義 された関 数 を呼 び出 します。

注 : ネット ワーク ページはパラメータ [Navigation] NetworkPageによって定 義 されます。関

数 を指 定 するには、「?」を関 数 名 の最 初 にプリフィックスとして付 けます。

戻 り値
成 功 した場 合 は 0、そうでなければ -1 となります。

CSV_Nav_NetworkBtnEnabled()
ネット ワーク ページが存 在 するかどうかをチェックします。

220
 Chapter: 5 CSV_include リファレンス

戻 り値
ネット ワーク ページが存 在 する場 合 、または関 数 がネット ワークページに指 定 されている場 合
は、1を返 します。

CSV_Nav_PageExists
ページに関 連 したランタイム ファイルを探 すことによりページが既 存 するかどうかをチェックしま
す。

シンタックス
CSV_Nav_PageExists(sPage)
#sPage:

チェックするページ名 。

戻 り値
ページが存 在 する場 合 は1、そうでなければ0を返 します。

CSV_Nav_PagePrint()
アクティブなページの画 面 印 刷 を作 成 、またはト ページ印 刷 をするために定 義 された関 数 を呼
び出 します。

注 : 印 刷 関 数 は、ページ環 境 変 数 「PrintPage」が存 在 している場 合 は、この変 数 で定

義 されます。そうでない場 合 は、パラメータ[Navigation] PrintPageで定 義 されます。関 数 を
指 定 するには、関 数 の名 前 に「?」のプリフィックスを付 けます。関 数 が定 義 されない場 合 、
画 面 印 刷 が実 行 されます。

CSV_Nav_Parent()
現 在 のページに対 し、ParentPage 環 境 変 数 によって設 定 されたページを表 示 、また
はParentPageによって指 定 された関 数 を呼 び出 します。

戻 り値
成 功 した場 合 は 0、そうでなければ -1 となります。

注 : 関 数 を指 定 するには、関 数 の名 前 に「?」のプリフィックスを付 けます。

CSV_Nav_ParentBtnEnabled()

221
Chapter: 5 CSV_include リファレンス

現 在 のページに対 し、ページが定 義 されているかどうかを確 認 します。

戻 り値
親 ページが定 義 されている場 合 は1を返 します。

CSV_Nav_Report()
レポート ページを表 示 するか、またはレポート ページに定 義 された関 数 を呼 び出 します。

注 : ネット ワーク ページはパラメータ[Navigation]ReportPageで定 義 されます。関 数 を指 定 す

るには、関 数 の名 前 に「?」のプリフィックスを付 けます。

戻 り値
成 功 した場 合 は 0、そうでなければ -1 となります。

CSV_Nav_ReportBtnEnabled()
レポート ページが既 存 するかどうかをチェックします。

戻 り値
レポート ページが存 在 する場 合 、または関 数 がレポート ページ用 に指 定 されている場 合 は、1
を返 します。

CSV_Nav_ReportMenu
レポート のポップアップ メニューを表 示 します。

注 : レポート ポップアップ メニューはPageMenu.dbf (以 前 の名 前 はMenu.dbf) の「テンプ

レート 」ページおよび「レポート 」メニューで定 義 されます。

シンタックス
CSV_Nav_ReportMenu(iX,iY)
#iX:

ポップアップ メニュー位 置 のX座 標 。

#iY:

ポップアップ メニュー位 置 のY座 標 。

CSV_Nav_Tools()
ツール ページを表 示 、またはツール ページに定 義 された関 数 を呼 び出 します。

222
 Chapter: 5 CSV_include リファレンス

注 : ツール ページは[Navigation]ToolsPageパラメータで定 義 されています。

関 数 を指 定 するには、関 数 の名 前 に 「?」のプリフィックスを付 けます。

戻 り値
成 功 した場 合 は 0、そうでなければ -1 となります。

CSV_Nav_ToolsBtnEnabled()
ツール ページが既 存 するかどうかをチェックします。

戻 り値
ツール ページが既 存 する場 合 、または関 数 がツール ページに指 定 されている場 合 は、1を返
します。

CSV_Nav_ToolsMenu()
スクリーン ツールのポップアップ メニューを表 示 します。

注 : ツール ポップアップ メニューはPageMenu.dbf (以 前 の名 前 はMenu.dbf) の「テンプレー

ト 」ページおよび「ツール」メニューで定 義 されます。ツール メニューが、PageMenu.dbfのこの
セクションで定 義 されていない場 合 、デフォルト のメニューが表 示 されます。

CSV_Nav_Trend()
ト レンド ページを表 示 、またはト レンド ページに定 義 された関 数 を呼 び出 します。

注 : ト レンド ページはパラメータ [Navigation] TrendPageによって定 義 されます。関 数 を

指 定 するには、関 数 の名 前 に「?」のプリフィックスを付 けます。

戻 り値
成 功 した場 合 は 0、そうでなければ -1 となります。

CSV_Nav_TrendBtnEnabled()
ト レンド ページが既 存 するかどうかをチェックします。

戻 り値
ト レンド ページが既 存 する場 合 、または関 数 がト レンド ページに指 定 されている場 合 は、1を
返 します。

223
Chapter: 5 CSV_include リファレンス

CSV_Nav_TrendMenu()
ト レンド のポップアップ メニューを表 示 します。

注 : ト レンド ポップアップ メニューはPageMenu.dbf (以 前 の名 前 はMenu.dbf) の「テンプ

レート 」ページおよび「ト レンド 」メニューで定 義 されます。

CSV_Nav_TrendX()
インスタント ト レンド ページを表 示 します。

注 : この関 数 を使 用 するには、CSV_InstantTrendプロジェクト をインクルード プロジェクト と

して追 加 する必 要 があります。(CitectSCADA ユーザーガイド のの「現 在 のプロジェクト にプ
ロジェクト を含 める」を参 照 してください。)

戻 り値
成 功 した場 合 は 0、そうでなければ -1 となります。

CSV_Nav_TickMenuItem
指 定 したポップアップ メニューで指 定 したアイテムをチェックを付 けます/チェックを外 します。チェッ
クされたメニュー アイテムはポップアップ メニューにチェックマーク付 きで表 示 されます。

シンタックス
CSV_Nav_TickMenuItem(iMode,sMenuItem,sSubMenuItem,sMenuName,sPageName)
#iMode:
l 1 = メニュー アイテムにチェックを付 けます。
l 0 = メニュー アイテムのチェックを外 します。
#sMenuItem:

チェックを付 けける/チェックを外 すメニュー アイテム。

#sSubMenuItem:

チェックを付 けける/チェックを外 すサブメニュー アイテム (適 用 する場 合 )。

#sMenuName:

メニューの名 前 (例 ：ポップアップ メニューに関 連 付 けられたボタン)。

#sPageName:

メニューに関 連 付 けられたページの名 前 。

224
 Chapter: 5 CSV_include リファレンス

戻 り値
成 功 した場 合 は 0、そうでなければ -1 となります。

CSV_Sec_ShowLoginMenu
ポップアップ メニューを表 示 してログイン、ログアウト 、パスワード の変 更 、そしてユーザーが必 要
な特 権 を持 っている場 合 ユーザーの編 集 またはユーザーの追 加 が行 えます。

シンタックス
CSV_Sec_ShowLoginMenu(iXpos,iYpos,iUserEditPrivilege)
#iXpos:

ポップアップ メニューの左 上 のX位 置 。

#iYpos:

ポップアップ メニューの左 上 のY位 置 。

#iUserEditPrivilege:

ユーザーを追 加 または削 除 に必 要 な権 限 。

CSV_String_GetField
文 字 列 からフィールド の値 (テキスト ) を取 得 します。この文 字 列 はいくつかのフィールド がフィー
ルド 区 切 り文 字 によって区 切 られています。

シンタックス
CSV_String_GetField(sText,iField,sFieldSeparator)
#sText:

フィールドを含 む文 字 列 。

#iField:

返 すフィールド値 のインデックス (1から開 始 )。

#SFieldSeparator:

フィールドの区 切 り文 字 。

戻 り値
文 字 列 としてのフィールド の値 。

225
Chapter: 5 CSV_include リファレンス

sText = "ab?cde?fghi?j";
sField = CSV_String_GetField(sText,3,"?");
In this case sField = "fghi"

CSV_String_GetLines
1行 の最 大 文 字 数 が指 定 された場 合 、文 字 列 で行 数 を返 します。

シンタックス
CSV_String_GetLines(sText, iChars)
#sText:

行 に変 換 するテキスト 。

#iChars:

1行 の最 大 文 字 数 。

戻 り値
テキスト が変 換 される行 数 。

CSV_String_Replace
サブ文 字 列 が、指 定 された回 数 で、別 のサブ文 字 列 に置 換 される文 字 列 を返 します。

シンタックス
CSV_String_Replace(sTextString,sFind,sReplace,iStart,iCount)
#sTextString:

置 換 するサブ文 字 列 を含 む式

#sFind:

検 索 するサブ文 字 列 。

#sReplace:

置 換 サブ文 字 列 。

#iStart:

オプション。サブ文 字 列 の検 索 が開 始 する式 内 の位 置 。省 略 された場 合 は、()であるとみなされます。

#iCount:

226
 Chapter: 5 CSV_include リファレンス

オプション。サブ文 字 列 の置 換 を行 う回 数 。指 定 しないと、デフォルト の -1 が使 用 され、すべてのサブ文

字 列 が置 換 されます。

CSV_Tag_Debug
ランタイム時 に、変 数 タグのすべてにユーザーがアクセスできるフォームを作 成 します。読 み取 り
および書 き込 みがサポート されます。フォームは常 に最 前 面 に表 示 され、インスタンスは1つだけ
が許 可 されます。

シンタックス
CSV_Tag_Debug()

戻 り値
選 択 したタグの名 前 。

注 : システムですべてのタグを表 示 するためにリスト ボックスを使 用 します。リスト はフィルタさ

れます。

CSV_Trend_AutoScale
すべてのト レンド ペンを自 動 的 にスケールします。例 ：100% スケールは表 示 可 能 ト レンド ウィ
ンド ウの最 大 タグ値 よりタグ範 囲 全 体 の 10% 拡 大 し、0% スケールは表 示 可 能 ト レンド ウィン
ド ウの最 小 タグ値 よりタグ範 囲 全 体 の 10%縮 小 します。

シンタックス
CSV_Trend_AutoScale(hTrendAN)
#hTrendAN:

ト レンドのアニメーションポイント 番 号 。

CSV_Trend_DspGroup
指 定 したト レンド ページにト レンド ペンの指 定 グループを表 示 します。ト レンド ペンのグループ
は [RUN] ディレクト リのTrendGrp.dbfファイルで定 義 されていなければなりません。グループは
グループ名 または、グループの説 明 のいずれかによって指 定 できます。

シンタックス
CSV_Trend_DspGroup(sTitle,sTrendPage,hTrendAN,sTrendID,iTrendIDType, iTrendDataSet)
#sTitle:

ト レンド ページに表 示 するタイト ル。

227
Chapter: 5 CSV_include リファレンス

#sTrendPage:

表 示 するト レンド ページ名 。

#hTrendAN:

ト レンドのアニメーションポイント 番 号 。

#sTrendID:

ト レンド グループの名 前 または説 明 (TrendGrp.dbfにあります)。

#iTrendIDType:

ト レンドのタイプ。2つの可 能 な値 。
l 0 = sTrendIDはト レンド グループの名 前 を指 定 します。
l 1 = sTrendIDはト レンド グループの説 明 を指 定 します。
#iTrendDataSet:

グループに使 用 されるデータセット を指 定 します。

標 準 のト レンド ページは データセット 0を使 用 し、ダブル ト レンド ページはデータセット 1および2

を使 用 します。

CSV_Trend_DspGroupList
リスト ボックスに使 用 可 能 なト レンド タグのグループを表 示 します。リスト から選 択 したアイテム
の説 明 を返 します。グループは [RUN] ディレクト リにあるTrendGrp.dbfファイルで設 定 されま
す。

シンタックス
CSV_Trend_DspGroupList(sSelectedGroup,sAreas)
#sSelectedGroup:

リスト で選 択 済 みのグループ名 。

#sAreas:

リスト で有 効 にするエリア。つまり、これらのエリアに所 属 するト レンド グループのみが表 示 されます。

戻 り値
リスト から選 択 されたト レンド グループ (説 明 )、または [キャンセル] ボタンを押 した場 合 "" を返
します。

CSV_Trend_DspPopupMenu
ポップアップ メニューを表 示 して、選 択 したペンを追 加 またはクリアすることができます。

228
 Chapter: 5 CSV_include リファレンス

シンタックス
CSV_Trend_DspPopupMenu(hTrendAN,iPen)
#hTrendAN:

ト レンドのアニメーションポイント 番 号 。

#iPen:

選 択 したペンの番 号 。

戻 り値
ト レンド グループの説 明 。

CSV_Trend_DspScaleRange
指 定 したト レンド ペンの現 在 表 示 されているスケール範 囲 を以 下 のフォーマット で返 しま
す。「Lo - HiEU」この場 合 Lo = RangeMin, Hi = RangeMax, EU =エンジニアリングユニット を
示 します。

シンタックス
CSV_Trend_DspScaleRange(hTrendAN,iPen)
#hTrendAN:

ト レンドのアニメーションポイント 番 号 。

#iPen:

ト レンド ペンの番 号 。

戻 り値
文 字 列 としてフォーマット された範 囲 の値 。

CSV_Trend_DspTrendText
コメント がある場 合 、指 定 したペンによってプロット されたト レンド タグのコメント を返 し、そうでな
ければ、ト レンド タグの名 前 を返 します。

シンタックス
CSV_Trend_DspScaleRange(hTrendAN,iPen)
#hTrendAN:

ト レンドのアニメーションポイント 番 号 。

#iPen:

229
Chapter: 5 CSV_include リファレンス

ト レンド ペンの番 号 。

戻 り値
ある場 合 は、ト レンド タグのコメント を返 し、そうでなければト レンド タグの名 前 を返 します (す
べて大 文 字 )。

CSV_Trend_GetCursorPos
サンプルト レンド カーソルの始 点 からのオフセット を取 得 します。

シンタックス
CSV_Trend_GetCursorPos(hTrendAN)
#hTrendAN:

ト レンドのアニメーションポイント 番 号 。

戻 り値
サンプルにおける、ト レンド カーソルの始 点 からのオフセット 、またはカーソルが無 効 な場 合 –1。

CSV_Trend_GetCursorTypeStr
カーソルが表 示 されるかどうかを示 すテキスト を返 します。CSV_Trend_GetCursorValueStr()ととも
に使 用 し、ト レンド タグの値 がカーソルの値 あるいは現 在 値 に対 応 するかどうかを知 らせます。

シンタックス
CSV_Trend_GetCursorTypeStr(hTrendAN)
#hTrendAN:

ト レンドのアニメーションポイント 番 号 。

戻 り値
カーソルが表 示 されない場 合 、「現 在 値 」を返 し、カーソルが表 示 される場 合 は、「カーソル
値 」を返 します。

CSV_Trend_GetCursorValueStr
カーソルの位 置 でト レンド ペンの値 を取 得 するか、カーソルが無 効 の場 合 は、ト レンド ペンの
現 在 値 を取 得 します。文 字 列 で値 が返 されますが、タグのエンジニアリングユニット をオプション
で後 に付 けることができます。

230
 Chapter: 5 CSV_include リファレンス

シンタックス
CSV_Trend_GetCursorValueStr(hTrendAN, iPen, iEngUnits)
#hTrendAN:

ト レンドのアニメーションポイント 番 号 。

#iPen:

ト レンド ペンの番 号 。

#iEngUnits:

返 されるカーソル値 にエンジニアリングユニット を付 けます。

戻 り値
カーソル位 置 のト レンド ペンの値 、またはカーソルが表 示 されない場 合 は現 在 値 。

CSV_Trend_GetGroup
現 在 、指 定 のモニターで表 示 (あるいは前 回 に表 示 ) されたト レンド グループの説 明
(TrendGrp.dbfにより定 義 済 み) を取 得 します。

シンタックス
CSV_Trend_GetGroup(iMonitor, iTrendDataSet)
#iMonitor:

ト レンドが表 示 されている/されたモニターの番 号 。

#iTrendDataSet:

ト レンド タグのグループに使 用 されるデータセット を指 定 します。標 準 のト レンド ページは データセット 0を

使 用 し、ダブル ト レンド ページはデータセット 1および2を使 用 します。

戻 り値
ト レンド グループの説 明 。

CSV_Trend_GetMode
ト レンド ペンのモード (リアルタイムまたは履 歴 ト レンド ) を取 得 します。

シンタックス
CSV_Trend_GetMode(hTrendAN)

#hTrendAN:

ト レンドのアニメーションポイント 番 号 。

231
Chapter: 5 CSV_include リファレンス

戻 り値
現 在 のモード :リアルタイムは0、履 歴 は1を返 します。

CSV_Trend_GetPen
指 定 したペンによってプロット されるト レンド タグを取 得 します。

シンタックス
CSV_Trend_GetPen(hTrendAN, iPen)
#hTrendAN:

ト レンドのアニメーションポイント 番 号 。

#iPen:

ペンの番 号 。

戻 り値
指 定 したペンのト レンド タグ。

CSV_Trend_GetPenFocus
現 在 フォーカスされているト レンド ペンを取 得 します。

シンタックス
CSV_Trend_GetPenFocus(hTrendAN)
#hTrendAN:

ト レンドのアニメーションポイント 番 号 。

戻 り値
フォーカスされているペンの番 号 。

CSV_Trend_GetSettings
.ini ファイルに書 き込 んで現 在 のページの設 定 (表 示 されるタグおよびスケール) を呼 び出 し (
取 得 ) します。この関 数 は.ini ファイル内 のセクションで、各 ページごとに を割 り当 てます。

シンタックス
CSV_Trend_GetSettings(sPage, hTrendAN)
#sPage:

232
 Chapter: 5 CSV_include リファレンス

呼 び出 す設 定 のリファレンス。

#hTrendAN:

ト レンドのアニメーションポイント 番 号 。

[TrendPage1]
Tag_1=TrendTag1
Zero_1=0.
Full_1=1000.
Tag_2=TrendTag2
Zero_2=0.
Full_2=1000.
Tag_3=TrendTag3
Zero_3=0.
Full_3=1000.
Tag_4=TrendTag4
Zero_4=0.
Full_4=1000.
Tag_5=
Tag_6=
Tag_7=
Tag_8=

注 : ト レンド ページへのエント リーでこの関 数 を呼 び出 します。

CSV_Trend_GetSettings
.ini ファイルを書 き出 して現 在 のページの設 定 (表 示 されるタグおよびスケール) を呼 び出 しま
す。この関 数 は各 ページの.ini ファイルに別 のセクションを割 り当 てます。

シンタックス
CSV_Trend_GetSettings(sPage, hTrendAN)

[TrendPage1]
Tag_1=TrendTag1
Zero_1=0.
Full_1=1000.
Tag_2=TrendTag2
Zero_2=0.
Full_2=1000.
Tag_3=TrendTag3
Zero_3=0.

233
Chapter: 5 CSV_include リファレンス

Full_3=1000.
Tag_4=TrendTag4
Zero_4=0.
Full_4=1000.
Tag_5=
Tag_6=
Tag_7=
Tag_8=

注 : ト レンド ページを終 了 するときにこの関 数 を呼 び出 します。

CSV_Trend_GetSpan
指 定 したト レンド の時 間 幅 を「HH:MM:SS」の文 字 列 フォーマット で取 得 します。

シンタックス
CSV_Trend_GetSpan(hTrendAN)
#hTrendAN:

ト レンドのアニメーションポイント 番 号 。

戻 り値
フォーマット された時 刻 の文 字 列 。

CSV_Trend_GetTime
一 番 右 側 に表 示 されているサンプルの時 刻 を使 用 して、パーセント でト レンド の時 間 を取 得 し
ます。一 番 右 側 に表 示 されたサンプルに関 連 付 けられた時 間 は終 了 時 間 です。開 始 時 刻
は一 番 左 側 に表 示 された時 間 です。パーセン 0 (ゼロ) は終 了 時 刻 を示 し、パーセント 100は
開 始 時 刻 を示 します。

シンタックス
CSV_Trend_GetTime(hTrendAN, iPercent)
#hTrendAN:

ト レンドのアニメーションポイント 番 号 。

#iPercent:

表 示 された一 番 右 側 のサンプル時 間 からのト レンドのパーセント 。

戻 り値
hh:mm:ssのフォーマット のト レンド の時 刻 。

234
 Chapter: 5 CSV_include リファレンス

CSV_Trend_GetDate
表 示 された一 番 右 側 のサンプルの日 付 を使 用 して、ト レンド に沿 って、パーセント でト レンド の
日 付 を取 得 します。一 番 右 側 に表 示 されたサンプルに関 連 付 けられた日 付 は終 了 日 付 で
す。
開 始 日 付 は一 番 左 側 に表 示 された日 付 です。パーセント 0 (ゼロ) は終 了 日 付 を示 し、パー
セント 100は開 始 日 付 を示 します。

シンタックス
GetDate(hTrendAN,iPercent)
#hTrendAN:

ト レンドのアニメーションポイント 番 号 。

#iPercent:

表 示 された一 番 右 側 のサンプルの日 付 からのト レンドのパーセント 。

戻 り値
月 日 年 のフォーマット のト レンド の日 付 。

CSV_Trend_GroupConfig()
ポップアップ ウィンド ウを表 示 して、ランタイム時 に TrendGrp.dbf のレコード を参 照 /編 集 /追
加 /削 除 できるようにします。

CSV_Trend_Page
指 定 したペンでト レンド ページを作 成 します。

注 : プロジェクト 内 のテンプレート を混 合 することはできないため、CSV_Trend_Page

は、XP-様 式 のテンプレート でのみ機 能 します。CSV_Trend_Page を使 用 して標 準 テンプ
レート に基 づいたページにジャンプする場 合 、ページは表 示 されますがト レンド タグは追 加
されません。これはPageTrend Cicode関 数 にも当 てはまります。

シンタックス
CSV_Trend_Page(sPage,sPen1,sPen2,sPen3,sPen4,sPen5,sPen6,sPen7,sPen8)
#sPage:

表 示 するト レンド ページ名 。

#sPen1:

pen 1で作 成 するト レンドのト レンド タグ

235
Chapter: 5 CSV_include リファレンス

#sPen2:

pen 2で作 成 するト レンドのト レンド タグ

#sPen3:

pen 3で作 成 するト レンドのト レンド タグ

#sPen4:

pen 4で作 成 するト レンドのト レンド タグ

#sPen5:

pen 5で作 成 するト レンドのト レンド タグ

#sPen6:

pen 6で作 成 するト レンドのト レンド タグ

#sPen7:

pen 7で作 成 するト レンドのト レンド タグ

#sPen8:

pen 8で作 成 するト レンドのト レンド タグ

戻 り値
正 常 に実 行 した場 合 は0、そうでなければエラー番 号 を返 します。

CSV_Trend_Popup
指 定 したペンで新 規 ウィンド ウにポップアップ ト レンド ページを作 成 します。ウィンド ウは、アクテ
ィブなモニターの中 央 にに配 置 されます。

シンタックス
CSV_Trend_Popup(sPage,sPen1,sPen2,sPen3,sPen4)
#sPage:

表 示 するト レンド ページ名 。

#sPen1:

pen 1で作 成 するト レンドのト レンド タグ

#sPen2:

pen 2で作 成 するト レンドのト レンド タグ

#sPen3:

pen 3で作 成 するト レンドのト レンド タグ

236
 Chapter: 5 CSV_include リファレンス

#sPen4:

pen 4で作 成 するト レンドのト レンド タグ

戻 り値
ポップアップ ト レンド ウィンド ウのウィンド ウ番 号 ; ウィンド ウを開 けなかった場 合 は、-1を返 しま
す。

CSV_Trend_ScaleDigital
-2 ～ 2の間 にデジタル ペンを再 スケールします。

注 : 再 スケールするには、ト レンド タグはデジタル変 数 タグと同 じ名 前 が付 けられている必

要 があります。

シンタックス
CSV_Trend_ScaleDigital(hTrendAN,iPen)
#hTrendAN:

ト レンドのアニメーションポイント 番 号 。

#iPen:

スケールを適 用 するペンの番 号 、またはすべてのペンの場 合 –1を返 します。

CSV_Trend_SelectGroup
リスト ボックスからト レンド タグのグループを選 択 するできるようにします。各 グループには関 連 付
けられた名 前 、説 明 、および8つまでのタグのリスト を含 みます。この関 数 は選 択 したグループ
データを保 存 し、リスト から選 択 したグループの名 前 を返 します。

注 : グループは [RUN] ディレクト リにある TrendGrp.dbf ファイルで設 定 されます。

シンタックス
CSV_Trend_SelectGroup(iMonitor,iTrendDataSet)

#iMonitor:

ト レンドが表 示 されている/されたモニターの番 号 。

#iTrendDataSet:

ト レンド タグのグループに使 用 されるデータセット を指 定 します。標 準 のト レンドページは データセット 0を

使 用 し、ダブル ト レンド ページはデータセット 1および2を使 用 します。

237
Chapter: 5 CSV_include リファレンス

戻 り値
リスト から選 択 されたト レンド グループ (説 明 )、または [キャンセル] ボタンを押 した場 合 "" を返
します。

CSV_Trend_SelectPen
リスト ボックスを表 示 して、選 択 したペンを使 用 してト レンド するタグを選 択 できるようにします。

シンタックス
CSV_Trend_SelectPen(sSelectedPen)
#sSelectedPen:

あらかじめ選 択 するト レンド タグ名 。

戻 り値
リスト から選 択 したト レンド タグの名 前 か、またはアクションがキャンセルされた場 合 は"" を返 し
ます。

CSV_Trend_SetCursor
ト レンド ペンにフォーカスがない場 合 、この関 数 は戻 され、そうでなければ、ト レンド のカーソル
を指 定 したサンプルの数 だけ移 動 します。ト レンド カーソルが無 効 の場 合 、この関 数 によって
有 効 にされます。カーソルが有 効 でかつサンプル数 が0 (ゼロ) の場 合 、カーソルは無 効 になりま
す。カーソルが現 在 のト レンド フレームから外 側 に出 ると、ト レンド はスクロールします。

シンタックス
CSV_Trend_SetCursor(hTrendAN)
#hTrendAN:

ト レンドのアニメーションポイント 番 号 。

CSV_Trend_SetDate
キーボード フォームからト レンド の 0% の日 付 を設 定 します。これにより、入 力 した日 付 までの
ト レンド の情 報 を表 示 できるようにします。

シンタックス
CSV_Trend_SetDate(hTrendAN,sValue)
#hTrendAN:

ト レンドのアニメーションポイント 番 号 。

238
 Chapter: 5 CSV_include リファレンス

#sValue:

ト レンドの日 付 を 0% に設 定 する日 付 。sValue = ""の場 合 、日 付 を選 択 するためのフォームが表 示 され

ます。

戻 り値
新 規 日 付 (文 字 列 )。

CSV_Trend_SetDateTime
キーパッド フォームから0%ト レンド 日 付 と時 刻 を設 定 します。これにより、入 力 した時 刻 と日 付
までのト レンド 情 報 を表 示 することができます。

シンタックス
CSV_Trend_SetDateTime(hTrendAN)
#hTrendAN:

ト レンドのアニメーションポイント 番 号 。

戻 り値
スペースで区 分 された新 しい時 刻 と日 付 。

CSV_Trend_SetPens
ト レンド ペンにト レンド タグを割 り当 てます。ト レンド タグの名 前 は特 定 のモニターに表 示 され
るト レンド タグの最 後 のグループを保 存 する文 字 列 から抽 出 されます。

シンタックス
CSV_Trend_SetPens(hTrendAN, iMonitor, iTrendDataSet)
#hTrendAN:

ト レンドのアニメーションポイント 番 号 。

#iMonitor:

ト レンドを表 示 するモニターの番 号 (-1 =アクティブなモニター)。

#iTrendDataSet:

ト レンド タグのグループに使 用 されるデータセット を指 定 します。標 準 のト レンド ページは データセット 0を

使 用 し、ダブル ト レンド ページはデータセット 1および2を使 用 します。

CSV_Trend_SetRange

239
Chapter: 5 CSV_include リファレンス

すべてのト レンド ペンのデフォルト 範 囲 を取 得 し、範 囲 の値 にページの文 字 列 の10～ 17を設

定 します。

シンタックス
CSV_Trend_SetRange(hTrendAN)
#hTrendAN:

ト レンドのアニメーションポイント 番 号 。

CSV_Trend_SetScale
ゼロとト レンド の最 大 スケール値 を設 定 できるようにします。すべてのト レンド に対 して変 更 する
か、現 在 のト レンド のみに対 して変 更 することができます。

シンタックス
CSV_Trend_SetScale(hTrendAN,iPercentage,sValue)
#hTrendAN:

タイムベースを設 定 するト レンドのアニメーションポイント 番 号 。

#iPercentage:

スケール パーセント を 設 定 します (0または100)。

#sValue:

スケール パーセント を設 定 する値 。sValue = ""の場 合 、フォームが表 示 され、ユーザーが新 しいスケール

を選 択 できます。

戻 り値
新 規 スケールの値 (文 字 列 )。

CSV_Trend_SetSpan
ト レンド の時 間 幅 (表 示 する合 計 時 間 ) を設 定 します。

シンタックス
CSV_Trend_SetSpan(hTrendAN,sSpan)
#hTrendAN:

ト レンドのアニメーションポイント 番 号 。

#sSpan:

時 間 幅 を設 定 する値 。sValue = ""の場 合 、フォームはト レンド幅 を選 択 できるようにします。

240
 Chapter: 5 CSV_include リファレンス

戻 り値
新 規 時 間 幅 (文 字 列 )。

CSV_Trend_SetTime
キーボード フォームから0%ト レンド 時 刻 を設 定 します。これにより、入 力 した時 刻 までト レンド
情 報 を表 示 することができます。

シンタックス
CSV_Trend_SetTime(hTrendAN,sValue)
#hTrendAN:

ト レンドのアニメーションポイント 番 号 。

#sValue:

0%ト レンド時 刻 に設 定 する時 刻 。sValue = ""の場 合 、フォームは選 択 した時 刻 に表 示 されます。

戻 り値
新 規 時 刻 (文 字 列 )。

CSV_Trend_SetTimebase
各 サンプル間 の時 間 間 隔 を設 定 することができます。

シンタックス
CSV_Trend_SetTimebase(hTrendAN,sValue)
#hTrendAN:

タイムベースを設 定 するト レンドのアニメーションポイント 番 号 。

#sValue:

タイムベースを設 定 する値 。sValue = ""の場 合 、フォームが表 示 され、ユーザーが新 しい時 刻 ベースを選

択 できます。

戻 り値
新 規 タイムベース (文 字 列 )。

CSV_Trend_UpdatePens

241
Chapter: 5 CSV_include リファレンス

指 定 のAN で現 在 ト レンド されているタグ名 をコンマで区 切 ったリスト として文 字 列 にして保 存

します。区 切 られた文 字 列 は各 モニターに割 り当 てられます。文 字 列 はト レンド ページが再 表
示 されるとき、ト レンド された最 後 のタグを復 元 するために使 用 されます。

シンタックス
CSV_Trend_UpdatePens(hTrendAN,iMonitor,iTrendDataSet)
#hTrendAN:

ト レンドのアニメーションポイント 番 号 。

#iMonitor:

ト レンドを表 示 するモニターの番 号 (-1 =アクティブなモニター)。

#iTrendDataSet:

ト レンド タグのグループに使 用 されるデータセット を指 定 します。標 準 のト レンド ページは データセット 0を

使 用 し、ダブル ト レンド ページはデータセット 1および2を使 用 します。

CSV_Trend_Win
指 定 したペンで新 規 ウィンド ウにト レンド ページを作 成 します。

シンタックス
CSV_Trend_Win(sPage,iX,iY,iMode,sPen1,sPen2,sPen3,sPen4,sPen5,sPen6,sPen7, sPen8)
#sPage:

表 示 するト レンド ページ名 。

#iX:

ウィンドウの左 上 のX 座 標 。

#iY:

ウィンドウの左 上 のY座 標 。

#iMode:

ウィンドウのモード (= WinNewAtで使 用 されるモード)。

#sPen1:

pen 1で作 成 するト レンドのト レンド タグ

#sPen2:

pen 2で作 成 するト レンドのト レンド タグ

#sPen3:

242
 Chapter: 5 CSV_include リファレンス

pen 3で作 成 するト レンドのト レンド タグ

#sPen4:

pen 4で作 成 するト レンドのト レンド タグ

#sPen5:

pen 5で作 成 するト レンドのト レンド タグ

#sPen6:

pen 6で作 成 するト レンドのト レンド タグ

#sPen7:

pen 7で作 成 するト レンドのト レンド タグ

#sPen8:

pen 8で作 成 するト レンドのト レンド タグ

戻 り値
ウィンド ウのウィンド ウ番 号 ; ウィンド ウを開 くことができない場 合 は、-1を返 します。

CSV_TrendX_AddVariable
最 初 に利 用 できるインスタント ト レンド タグに変 数 を割 当 てます。インスタント ト レンド タグは
現 在 ト レンド を追 跡 している変 数 がない場 合 に利 用 できます、つま
りmsTrendXVariable[iTrendNo] = ""。ここで、iTrendNo がインスタント ト レンド の数 の場 合 、利 用
できます。

注 : この関 数 はト レンド サーバーにおいてのみ呼 び出 されます。冗 長 性 を保 つために、関

数 は第 2/冗 長 ト レンド サーバー上 で同 じ引 数 で呼 び出 されます。

変 数 はト レンド 持 続 期 間 が割 当 てられます。変 数 名 は現 在 割 当 てられている変 数 を、割 り

当 てられた順 番 にすべて保 存 しているキューの終 わりに追 加 され、それは割 当 てられた順 序
になっています。
利 用 できるト レンド タグがない場 合 、変 数 は分 析 のために割 当 てられません。

シンタックス
CSV_TrendX_AddVariable(sVariable, iDuration, IupdateRedundantSrvr)
#sVariable:

分 析 される変 数 の名 前 。

#iDuration:

243
Chapter: 5 CSV_include リファレンス

ト レンド タグ タイマーをあらかじめ設 定 する値 。変 数 が分 析 される秒 数 を決 めます。

#iUpdateRedundantSrvr:
l 1 = 第 2 ト レンド サーバーを同 じ情 報 で更 新 する、つまり第 2 ト レンド サーバー上
で 同 じ関 数 を RPC します。関 数 自 身 での RPC 呼 び出 しにおいてのみ、0に設
定 します。
l 0 = 第 2ト レンド サーバーをRPCしない。

注 : 成 功 した場 合 、ト レンド sVariable に割 当 てられるインスタント ト レンド タグ数 、それ

以 外 は -1。

CSV_TrendX_AgeTrends()
ト レンド カウント ダウン タイマーを減 らしていきます。

CSV_TrendX_ClearTrend
ト レンド キャッシュをクリアし、特 定 のト レンド に関 連 したト レンド ファイルを削 除 します。
新 しい変 数 をインスタン ト ト レンド タグに割 当 てるには、まずこの関 数 を呼 び出 す必 要 があり
ます。ト レンド タグが異 なる変 数 に以 前 割 当 てられている可 能 性 があるので、これを行 う必 要
があります。この場 合 、ト レンド 履 歴 をスクロールバックすると、現 在 の変 数 と関 連 していない
データが表 示 されることがあります。
注 : この機 能 はト レンド サーバーにおいてのみ呼 び出 します。冗 長 性 を保 つために、関 数 は
第 2/冗 長 ト レンド サーバー上 の同 じ引 数 と共 に呼 び出 されます。

シンタックス
CSV_TrendX_ClearTrend(iTrendNo, IUpdateRedundantSrvr)
#iTrendNo:

クリアするインスタント ト レンド番 号 。

#iUpdateRedundantSrvr:
l 1 = 第 2 ト レンド サーバーを同 じ情 報 で更 新 する、つまり第 2 ト レンド サーバー上
で RPC は同 じ関 数 。
l 0 = 第 2ト レンド サーバーをRPCしない。関 数 自 身 での RPC 呼 び出 しにおいての
み、0に設 定 します。

CSV_TrendX_Close
ト レンド ペンに関 連 したインスタント ト レンド タグを開 放 します。インスタント ト レンド ポップアッ
プを終 了 します。

244
 Chapter: 5 CSV_include リファレンス

シンタックス
CSV_TrendX_Close(hAN)
#hAN:

インスタント ト レンドの AN 番 号 。

CSV_TrendX_DeletePen()
インスタント ト レンド ページ上 のト レンド ペンを削 除 します。インスタント ト レンド タグに割 当 て
られている変 数 の分 析 を終 了 します。

シンタックス
CSV_TrendX_DeletePen(hAN,iPenNo)
#hAN:

インスタント ト レンドの AN 番 号

#iPenNo:

削 除 するト レンド ペンの数 。

CSV_TrendX_Display()
インスタント ト レンド ポップアップを表 示 します。ト レンド 期 間 をデフォルト 値 に設 定 します。

CSV_TrendX_DspPopupMenu
インスタント ト レンド ページ上 のマウスに位 置 にポップアップを作 成 します。これによりユーザーは
ト レンド ペンを選 択 ( つまり選 択 したペンにより分 析 されるタグを選 択 ) またはト レンド ペンをクリ
アすることができます。
ユーザーが「ト レンド ペンを選 択 」を選 択 した場 合 、フォームが表 示 され、ユーザーは利 用 可
能 な変 数 タグのメニューからペンで分 析 する変 数 タグを選 択 できます。ユーザーが「ト レンド ペ
ンをクリア」を選 択 すると、選 択 したト レンド ペンは削 除 されます。ユーザーがト レンド ペンマー
カーを右 クリックすると呼 び出 されます。

シンタックス
CSV_TrendX_DspPopupMenu(hTrendAN, iPenNo)
#hTrendAn:

インスタント ト レンドの AN 番 号 。

#iPenNo:

選 択 / 削 除 するト レンド ペンの数 。

245
Chapter: 5 CSV_include リファレンス

CSV_TrendX_GenericToTag
生 の整 数 値 (0-32000) を指 定 したタグの最 小 換 算 値 と最 大 換 算 値 の間 でスケールされた実
際 の値 に変 換 します。

シンタックス
CSV_TrendX_GenericToTag(iValue,sTagName)
#iValue:

0 - 32000間 でスケールされた生 の値 。

#sTagname:

iValueをスケールするために使 用 される、最 小 換 算 値 と最 大 換 算 値 のタグの名 前 。

戻 り値
タグの最 小 換 算 値 と最 大 換 算 値 間 でスケールされている値 。

CSV_TrendX_GenericToTagStr
生 の整 数 値 (0-32000) を指 定 した小 換 算 値 と最 大 換 算 値 間 でスケールされた実 際 の値 に
変 換 し、次 のその値 を文 字 列 として戻 します。

注 : インスタント ト レンド データは汎 用 形 式 で保 存 されます。つまり、範 囲 0 - 32000の生

の整 数 として保 存 されます。この関 数 を呼 び出 して、生 のト レンド 値 をスケールされた値 に
変 換 し、ト レンド ポップアップに表 示 します。

シンタックス
CSV_TrendX_GenericToTagStr(iValue,sTagName)
#iValue:

0 - 32000間 でスケールされた生 の値 。

#sTagname:

iValueをスケールするために使 用 される、最 小 換 算 値 と最 大 換 算 値 値 のタグの名 前 。

戻 り値
タグのエンジニアリング ゼロ スケールとエンジニアリング フルスケール間 でスケールされている値 (
文 字 列 として) 。

CSV_TrendX_GetComment
変 数 タグに関 連 しているコメント を取 得 します。

246
 Chapter: 5 CSV_include リファレンス

シンタックス
CSV_TrendX_GetComment(sVariable)
#sVariable:

コメント を取 得 するタグの名 前 。

戻 り値
変 数 タグsVariableに関 連 したコメント 。

CSV_TrendX_GetCursor
カーソルの位 置 にあるインスタント ト レンド ペンの値 を取 得 します。

シンタックス
CSV_TrendX_GetCursor(hAN, iPenNo)
#hAN:

インスタント ト レンドの AN 番 号 。

#iPenNo:

カーソル値 を取 得 するペン。

戻 り値
カーソルの位 置 にあるト レンド ペンの値 ( 文 字 列 として返 します) 。値 は変 数 タグの設 定 にした
がって、ト レンド を追 跡 している変 数 の最 小 換 算 値 と最 大 換 算 値 の間 でスケールされます。

CSV_TrendX_GetDuration()
インスタント ト レンド ポップアップに関 連 している期 間 を取 得 します。

戻 り値
インスタント ト レンド ポップアップのト レンド 期 間 、長 期 間 (hh:mm:ss) 形 式 。

CSV_TrendX_GetSamplePeriod
サンプルされるト レンド タグの周 期 を取 得 します。

シンタックス
CSV_TrendX_GetSamplePeriod(iTrendNo)
#iTrendNo:

247
Chapter: 5 CSV_include リファレンス

サンプリング周 期 を取 得 するト レンド タグの数 。

戻 り値
指 定 したインスタント ト レンド のサンプリング周 期 ( 秒 単 位 ) 。

注 : これはト レンド タグ設 定 フォームで指 定 されている試 行 期 間 ( 1 秒 に設 定 ) と同 じで

はありません。インスタント ト レンド の試 行 期 間 はランタイムにおいては動 的 に設 定 できま
す。

CSV_TrendX_GetScale
フォーカスされているト レンド ペンに対 して表 示 されているパーセンテージの割 合 を示 す値 を取
得 します。インスタント ト レンド ページ上 で 0 、50 、100% などのスケールを決 定 / 表 示 するた
めに使 用 されます。

シンタックス
CSV_TrendX_GetScale(hAN, iPercent)
#hAN:

インスタント ト レンドの AN 番 号 。

#iPercent:

フルスケールのパーセンテージ。

戻 り値
スケール値 。

CSV_TrendX_GetTrendName
インスタント ト レンド の番 号 からインスタント ト レンド の名 前 を取 得 します。

シンタックス
CSV_TrendX_GetTrendName(iTrendNo)
#iTrendNo:

インスタント ト レンド タグの番 号 。

戻 り値
ト レンド タグの名 前 。

248
 Chapter: 5 CSV_include リファレンス

CSV_TrendX_GetTrigger
説 明 この関 数 はすべてのインスタント ト レンド タグの、ト レンド タグ設 定 フォームのト リガー フ
ィールド で呼 び出 されます。

シンタックス
CSV_TrendX_GetTrigger(iTrendNo)
#iTrendNo:

インスタント ト レンド タグの番 号 。

戻 り値
戻 り値 各 インスタント ト レンド タグのト リガー設 定 。

CSV_TrendX_GetVal
この関 数 はすべてのインスタント ト レンド タグの、ト レンド タグ設 定 フォームの数 式 フィールド で
呼 び出 されます。ト レンド システムで使 用 可 能 なト レンド タグに割 り当 てられている値 を保 管
する、配 列 の要 素 を作 成 します。

シンタックス
CSV_TrendX_GetVal(iTrendNo)
#iTrendNo:

インスタント ト レンド タグの番 号 。

戻 り値
インスタント ト レンド タグに関 連 している変 数 のうち、-1と32000間 の整 数 として最 後 に保 存 さ
れた値 。

CSV_TrendX_InitClient()
インスタント ト レンド のために、ト レンド クライアント を初 期 化 します。

注 : この関 数 はインスタント ト レンド 関 数 が必 要 な場 合 、すべてのト レンド クライアント に

対 してスタート アップ時 に呼 び出 されます。スタート アップCicode関 数 でこの関 数 を呼 び出
さずに使 用 できるように、周 期 イベント として設 定 されます( CSV_TrendXClientイベント として
表 示 ) 。イベント が最 初 に処 理 されるとき、インスタント ト レンド クライアント の機 能 が初 期
化 されます。その後 のすべての呼 び出 しは、何 の処 理 も行 わずにすぐに戻 されます。

CSV_TrendX_InitSrvr()

249
Chapter: 5 CSV_include リファレンス

インスタント ト レンド のために、ト レンド サーバーを初 期 化 します。ト レンド キャッシュのデータを

クリアするための表 を設 定 します。すべてのインスタント ト レンド ト リガーを1に設 定 します。イン
スタント ト レンド システムで分 析 される変 数 名 を保 存 するキューを初 期 化 します。

注 : この関 数 はインスタント ト レンド 関 数 が必 要 な場 合 、すべてのト レンド サーバーに対

してスタート アップ時 に呼 び出 されます。スタート アップCicode関 数 でこの関 数 を呼 び出 さ
ずに使 用 できるように、周 期 イベント として設 定 されます( CSV_TrendXServerイベント として表
示 ) 。イベント が最 初 に処 理 されるとき、インスタント ト レンド サーバーの機 能 が初 期 化 さ
れます。その後 のすべての呼 び出 しは、何 の処 理 も行 わずにすぐに戻 されます。

CSV_TrendX_MapTrendTags()
用 のWrapper 関 数 。ト レンド サーバーで１秒 ごとにイベント として呼
_CSV_TrendX_MapTrendTags
び出 され、すべてのト レンド タグ値 を更 新 します(CSV_TrendXServer イベント が有 効 の場 合 ) 。

CSV_TrendX_RefreshTrendPage
ト レンド ページを更 新 します。変 数 がインスタント ト レンド システムに追 加 されてから呼 び出 さ
れます。現 在 の時 間 にスクロールします。

シンタックス
CSV_TrendX_RefreshTrendPage(hAN)
#hAN:

インスタント ト レンドの AN 番 号 。

注 : TrendSetNow を呼 び出 すと、旧 /無 効 なデータはスクリーンからクリアされます。ペンで分

析 されている変 数 が変 更 されたときに必 要 です。

CSV_TrendX_SetDuration
インスタント ト レンド ポップアップの期 間 を設 定 します。

シンタックス
CSV_TrendX_SetDuration(iDuration, iDspNumPad)
#iDuration:

ポップアップ期 間 ( 秒 単 位 ) 。

#iDspNumPad:

データ エント リーのための数 値 パッドを表 示 します。

250
 Chapter: 5 CSV_include リファレンス

CSV_TrendX_SetDuration
ト レンド サーバーにインスタント ト レンド の期 間 を設 定 します。

注 : この関 数 はト レンド サーバーにおいてのみ呼 び出 します。冗 長 性 を保 つために、関 数

は第 2/冗 長 ト レンド サーバー上 の同 じ引 数 と共 に呼 び出 されます。

シンタックス
CSV_TrendX_SetDuration(iTrendNo,iDuration,iUpdateRedundantSrvr)
#iTrendNo:

期 間 を設 定 するト レンドの番 号 。

#iDuration:

ポップアップ期 間 ( 秒 単 位 ) 。

#iUpdateRedundantSrvr:
l 1 = 第 2ト レンド サーバーを同 じ情 報 で更 新 する、つまり第 2ト レンド サーバー上
でRPCは同 じ関 数 。
l 0 = 第 2ト レンド サーバーをRPCしない。関 数 自 身 での RPC 呼 び出 しにおいての
み、0に設 定 します。

戻 り値
成 功 した場 合 は 0、そうでなければ -1 となります。

CSV_TrendX_SetPen()
フォームを表 示 し、ユーザはト レンド ペンに割 当 てる変 数 を選 択 できます。

CSV_TrendX_SetSamplePeriod
指 定 したインスタン ト ト レンド ペンの試 行 期 間 を設 定 します。表 示 目 的 のためだけに、試 行
期 間 はページ単 位 の整 数 として保 存 されます。この関 数 を呼 び出 すと、更 新 されます。サンプ
リング周 期 がト レンド サーバで更 新 されます。

シンタックス
CSV_TrendX_SetSamplePeriod(hAN, iPenNo, iPeriod)
#hAN:

インスタント ト レンド AN の番 号 。

#iPenNo:

サンプリング周 期 を更 新 するためのペンの番 号 。

251
Chapter: 5 CSV_include リファレンス

#iPeriod:

新 しい試 行 期 間 を設 定 するための時 間 ( 秒 単 位 ) 。

CSV_TrendX_SetScale
インスタント ト レンド のスケールを設 定 します。すべてのト レンド に対 して、または現 在 のト レンド
に対 してのみ設 定 できます。

シンタックス
CSV_TrendX_SetScale(hAN,iPercent,iScaleVal,iDspNumPad)
#hAN:

インスタント ト レンドの AN 番 号 。

#iPercent:

スケール設 定 が表 す、表 示 範 囲 のパーセント 。

#iScaleVal:

新 しいスケール値 。

#iDspNumPad:

スケールを設 定 するための数 値 パッドを表 示 します。

CSV_TrendX_TagSelect
インスタント ト レンド ページでペンに変 数 を割 当 てます。変 数 は最 初 に利 用 できるインスタント
ト レンド タグに割 当 てられます。ト レンド ページがアクセスするローカル ページ単 位 の変 数 が更
新 されます。

戻 り値
成 功 した場 合 、ト レンド sVariableに割 当 てられるインスタント ト レンド タグの番 号 、さもなけれ
ば-1 。

シンタックス
CSV_TrendX_TagSelect(hAN,iPenNo,sVariable)
#hAN:

インスタント ト レンドの AN 番 号 。

#iPenNo:

変 数 に割 当 てるペンの番 号 。

#sVariable:

252
 Chapter: 5 CSV_include リファレンス

ペンに割 当 てる変 数 の名 前 。

CSV_TrendX_TagSelectFrmCursor()
アニメーションポイント の上 にマウス ポインタをポイント することで、インスタント ト レンド ページ上
のペンに変 数 を割 当 てます。AN 基 準 点 に関 連 した変 数 が選 択 されます。

CSV_TrendX_TagToGeneric
指 定 したタグのエンジニアリング ゼロとエンジニアリング フルスケール間 でスケールされた実 数 値
を生 の整 数 値 (0-32000) に変 換 します。
インスタント ト レンド データは汎 用 形 式 、つまり範 囲 が0 - 32000の生 の整 数 として保 存 されま
す。

シンタックス
CSV_TrendX_TagToGeneric(rValue, sTagName)
#rValue:

生 の整 数 0-32000に変 換 されるスケールされた値 。

#sTagname:

エンジニアリング ゼロとエンジニアリング フルスケール値 rValueがその間 にスケールされている、タグの名

前。

戻 り値
0-32000間 にスケールされた値 。

CSV_TrendX_TrendTimeout
インスタント ト レンド ポップアップに関 連 したト レンド の残 り時 間 を監 視 します。

シンタックス
CSV_TrendX_TrendTimeout(hAN)
#hAN:

インスタント ト レンド AN の番 号 。

戻 り値
ト レンド がタイムアウト した場 合 は１、さもなければ0。

CSV_WinUtl_DestroyCursor()
指 定 したカーソルを削 除 し、カーソルを標 準 のカーソルに設 定 します。

253
Chapter: 5 CSV_include リファレンス

CSV_WinUtl_GetColourRes()
スクリーンカラーの解 像 度 を取 得 します。

戻 り値
スクリーンカラー解 像 度 ：0 = 256色 、1 =ハイカラー (16 ビット ) 、2 = True color (24 ビット /32 ビッ
ト ) 、-1 = エラー。

CSV_WinUtl_GetCpuUsage
指 定 したプロセスのパーセント CPU使 用 率 または総 CPU使 用 率 を取 得 します。
注 : この関 数 はWindows Vistaでは使 用 されなくなっています、このオペレーティング システム
で呼 び出 すと0を戻 します。

シンタックス
CSV_WinUtl_GetCpuUsage(sProcessName)
#sProcessName:

プロセス名 または総 CPU使 用 率 を取 得 する場 合 は ""。

戻 り値
パーセンテージCPU使 用 率 。

CSV_WinUtl_GetSystemDir()
Windowsシステム ディレクト リを取 得 します。

戻 り値
Windowsシステム ディレクト リ パス。

CSV_WinUtl_GetTotalCpuUsage()
総 パーセンテージCPU使 用 率 を取 得 します。

注 : CSV_WinUtl_UpdateTotalCpuUsage を呼 び出 して、データを更 新 します( CSV_WinUtl_

UpdateTotalCpuUsage は''フォアグラウンド の Cicode の実 行 時 間 が長 すぎます'のエラーをを
防 ぎます) 。

戻 り値
総 CPU使 用 率 。

CSV_WinUtl_GetWindowsDir()

254
 Chapter: 5 CSV_include リファレンス

Windowsディレクト リを取 得 します。

戻 り値
Windowsディレクト リ パス。

CSV_WinUtl_GetWinMode()
CitectSCADAがフルスクリーン モード の場 合 、1を返 します。

戻 り値
フルスクリーン モード の場 合 は1 ( [Animator]FullScreen = 1) 、それ以 外 は0を返 します。。

CSV_WinUtl_LoadCursor
ファイル( .ani または.cur ) から指 定 ウィンド ウ用 にカーソルを読 み込 みます( .ani または.cur ) 。

シンタックス
CSV_WinUtl_LoadCursor(sCursor,hWnd)
#sCursor:

カーソルを含 むファイル( パスを含 む) 。

#hWnd:

カーソルを変 更 するウィンドウのハンドル。

戻 り値
新 しいカーソルへのハンド ル。

CSV_WinUtl_LockWindowUpdate
指 定 したウィンド ウを停 止 します( CitectSCADAが再 ペイント することを防 ぎます) 。

シンタックス
CSV_WinUtl_LockWindowUpdate(hWnd)
#hWnd:

凍 結 するウィンドウのハンドル、または任 意 の凍 結 したウィンドウを凍 結 解 除 するには-1。

戻 り値
成 功 した場 合 は 0、そうでなければ -1 となります。

CSV_WinUtl_NormalCursor

255
Chapter: 5 CSV_include リファレンス

指 定 したウィンド ウに対 して、標 準 カーソルを読 み込 みます。

シンタックス
CSV_WinUtl_NormalCursor(hWnd)
#hWnd:

カーソルを変 更 するウィンドウのハンドル。

戻 り値
標 準 カーソルへのハンド ル。

CSV_WinUtl_ShellExec
指 定 したファイルを開 くまたは印 刷 します。

シンタックス
CSV_WinUtl_ShellExec(sFile,sArgs,sDir,sOperation,iShowCmd)
#sFile:

開 くまたは印 刷 するファイルを指 定 するか、開 くまたは検 索 するフォルダを指 定 します。この関 数 は実 行 可

能 なファイルまたはドキュメント ファイルを開 くことができます。また、キュメント ファイルを印 刷 することができ
ます。

#sArgs:

sFileが実 行 可 能 なファイルを指 定 した場 合 、sArgsはアプリケーションに渡 すパラメータを指 定 しま

す。sFileがドキュメント ファイルを指 定 した場 合 、sArgs は""である必 要 があります。

#sDir:

デフォルト のディレクト リを指 定 します。

#sOperation:

実 行 する操 作 を指 定 します。次 の操 作 文 字 列 は有 効 です。

l 開 く- lpFileパラメータで指 定 したファイルを開 きます。ファイルは実 行 可 能 なファイ
ルまたはド キュメント ファイルでもかまいません。また、フォルダでもかまいません。
l 印 刷 する - この関 数 はlpFileが指 定 したファイルを印 刷 します。ファイルはド キュメ
ント ファイルである必 要 があります。ファイルが実 行 可 能 なファイルの場 合 、関 数
は「開 く」が指 定 した場 合 と同 様 に、ファイルを開 きます。
l 検 索 する - この関 数 はlpFileが指 定 したフォルダを検 索 します。パラメータは ""が
可 能 です。その場 合 、関 数 はlpFileで指 定 したファイルを開 きます。
#iShowCmd:

256
 Chapter: 5 CSV_include リファレンス

sFileが実 行 可 能 なファイルを指 定 する場 合 、iShowCmdはアプリケーションを開 いたとき、どのように表

示 するか指 定 します。次 の値 のいずれかになります。
l SW_HIDE (=0) - ウィンド ウを非 表 示 にし、他 のウィンド ウをアクティブにします。
l SW_MAXIMIZE (=3) - 指 定 したウィンド ウを最 大 化 します。
l SW_MINIMIZE (=6) - 指 定 したウィンド ウを最 小 化 にし、z-orderの順 番 で次 の
ト ップレベル ウィンド ウをアクティブにします。
l SW_RESTORE (=9) - ウィンド ウをアクティブにし、表 示 します。ウィンド ウを最 小 化
あるいは最 大 化 した場 合 、Windowsは元 のサイズと位 置 に復 元 します。最 小
化 したウィンド ウを元 に戻 すには、アプリケーションはこのフラグを指 定 する必 要 が
あります。
l SW_SHOW (=5) - ウィンド ウを作 動 し、現 在 のサイズと位 置 で表 示 します。
l SW_SHOWDEFAULT (=10) - アプリケーションを起 動 したプログラムによ
り、theCreateProcess関 数 に渡 された、STARTUPINFO 構 造 で指 定 されたSW_
flagに基 づいた表 示 マルチステート を設 定 します。アプリケーションはこのフラグと
共 にShowWindowを呼 び出 し、そのメインウィンド ウの初 期 表 示 マルチステート
を設 定 します。
l SW_SHOWMAXIMIZED (=3) - ウィンド ウをアクティブにし、最 大 化 したウィンド ウ
として表 示 します。
l SW_SHOWMINIMIZED (=2) - ウィンド ウをアクティブにし、最 小 化 したウィンド ウ
として表 示 します。
l SW_SHOWMINNOACTIVE (=7) - ウィンド ウを最 小 化 したウィンド ウとして表 示
します。アクティブウィンド ウはアクティブのままです。
l SW_SHOWNA (=8) - ウィンド ウを現 在 のマルチステート で表 示 します。アクティブ
なウィンド ウはアクティブのまま。
l SW_SHOWNOACTIVATE (=4) - 最 近 のサイズおよび位 置 でウィンド ウを表 示 し
ます。作 動 したウィンド ウはアクティブのまま。
l SW_SHOWNORMAL (=1) - ウィンド ウをアクティブにし、表 示 します。ウィンド ウを
最 小 化 あるいは最 大 化 した場 合 、Windowsは元 のサイズと位 置 に復 元 しま
す。ウィンド ウを初 めて表 示 するときは、アプリケーションはこのフラグを指 定 する必
要 があります。sFileがド キュメント ファイルを指 定 した場 合 、nShowCmdはゼロで
ある必 要 があります。

戻 り値
成 功 した場 合 は32より大 きい値 を戻 し、さもなければ32以 下 のエラー値 を戻 します。次 の表
でエラー値 を表 示 します。
l ERROR_FILE_NOT_FOUND (=2) - 指 定 したファイルは見 つかりませんでした。
l ERROR_PATH_NOT_FOUND (=3) - 指 定 したパスは見 つかりませんでした。
l ERROR_BAD_FORMAT (=17) - .exeファイルは無 効 です( Win32® 以 外 の .exeまたは
.exeイメージのエラー) 。

257
Chapter: 5 CSV_include リファレンス

l SE_ERR_ACCESSDENIED (=5) - オペレーティング システムは指 定 したファイルへのアクセス

を拒 否 しました。
l SE_ERR_ASSOCINCOMPLETE (=27) - ファイル名 関 連 付 けは不 完 全 または無 効 です。
l SE_ERR_DDEBUSY (=30) - 他 のDDEト ランザクションが処 理 中 であったため、DDEト ランザ
クションは完 了 できませんでした。
l SE_ERR_DDEFAIL (=29) - DDEト ランザクションは成 功 しませんでした。
l SE_ERR_DDETIMEOUT (=28) - DDEト ランザクションは要 求 がタイムアウト したため、完 了
できませんでした。
l SE_ERR_DLLNOTFOUND (=32) - 指 定 したダイナミック リンク ライブラリは見 つかりません
でした。
l SE_ERR_FNF (=2) - 指 定 したファイルは見 つかりませんでした。
l SE_ERR_NOASSOC (=31) - 指 定 したファイル名 拡 張 子 と関 連 付 けするアプリケーションは
ありません。
l SE_ERR_OOM (=8) - 操 作 を完 了 するために、メモリーが十 分 ありませんでした。
l SE_ERR_PNF (=3) - 指 定 したパスは見 つかりませんでした。
l SE_ERR_SHARE (=26) - 共 有 違 反 が起 こりました。

CSV_WinUtl_UpdateTotalCpuUsage()
合 計 パーセント CPU利 用 率 を最 小 0.5秒 間 隔 で更 新 します。管 理 者 ツール ページから呼 び
出 します。

CSV_WinUtl_WaitCursor
指 定 したウィンド ウに対 して待 機 / ビジー カーソルを読 み込 みます。

シンタックス
CSV_WinUtl_WaitCursor(hWnd)
#hWnd:

カーソルを変 更 するウィンドウのハンドル。

戻 り値
待 機 カーソルへのハンド ル。

258
Chapter: 6 グラフィックス ビルダー オート メーション
インターフェース
CitectSCADAグラフィックス ビルダーで、「オート メーション」がサポート されるようになりました。
オート メーションとは、OLEサービスの1つで、アプリケーションで機 能 を公 開 したり、同 じコンピ
ュータやネット ワーク上 のコンピュータにある他 のアプリケーションの機 能 をコント ロールすることが
可 能 になります。これにより、プログラミング コード によってアプリケーションを統 合 および自 動 化
できます。
オート メーションには次 の2つの主 な要 素 があります。
l オート メーション サーバーと呼 ばれるアプリケーション、またはソフト ウェア コンポーネント 。機
能 が公 開 され、他 のアプリケーションからアクセスできるようになっているため、コント ロールが
可 能 です。Microsoft のオート メーション サーバーの例 としては、Microsoft Office アプリケー
ションや Microsoft Project があります。これらのオート メーション サーバーでは、オブジェクト
モデルを通 じて機 能 が公 開 されます。
l オート メーション コント ローラと呼 ばれる別 のアプリケーション、または開 発 ツール。オート メー
ション サーバーで公 開 されている機 能 にアクセスして、プログラミング コード を通 じてOLE
オート メーション サーバーをコント ロールできます。Microsoftのオート メーション コント ローラの
例 としては、Microsoft Visual Basic、Microsoft Visual C++、および Microsoft Visual
Basic for Applications (Microsoft Access、Microsoft Excel、およびMicrosoft Projectに
内 蔵 ) があります。
オートメーションとは、オート メーション コント ローラからオート メーション サーバーにオート メーション
サーバーで公 開 されている機 能 を使 用 して指 示 が送 られ、オート メーション サーバーで指 示 が
実 行 されるプロセスを包 括 して指 す言 葉 です。
CitectSCADA グラフィックス ビルダー オート メーション インターフェースにより、CitectSCADA グラ
フィックス ビルダーがオート メーション サーバーとして機 能 できます。これによりグラフィックス ビル
ダー関 数 を公 開 するだけでなく、いくつかのプロジェクト エディタおよびCitectエクスプローラ関 数
も公 開 します。
このインターフェースではシンプルなオブジェクト モデルがサポート されています。すべての関 数 は
ルート レベルにあります。名 前 は構 造 化 され、グループ識 別 子 と機 能 名 を含 んでいます。例 え
ば、DrawLine、DrawRectangle、PositionAt、PositionRotate、ProjectSelect、ProjectUpgrade
などです。これらの関 数 はVisual Basic (VB)プログラムから呼 び出 すことができます。

注 : Visual Basicの開 発 環 境 では、参 照 するグラフィックス ビルダー タイプ ライブラリをあら

かじめ選 択 することが必 要 です。まだ選 択 されていない場 合 は、Visual Basicの [プロジェ

259
Chapter: 6 グラフィックス ビルダー オートメーション インターフェース

クト ] メニューから [参 照 設 定 ] を選 択 し、[グラフィックス ビルダー タイプ ライブラリ] をチェック

します。

例
次 のサンプルVisual Basicコード は新 しいCitectSCADAページを作 成 、特 定 の場 所 へGenieを
設 定 、パラメータを設 定 、線 を引 き、「TEST」という名 前 のページを保 存 することができます。

Dim GraphicsBuilder As IGraphicsBuilder2

Set GraphicsBuilder = New GraphicsBuilder.GraphicsBuilder
With GraphicsBuilder
.Visible = True
.PageNew "include", "standard", "normal", 0, True, True
.LibraryObjectPlace "include", "motors", "motor_1_east", 0, True
.PositionAt 300, 500
.LibraryObjectPutProperty "Tag", "Test_Tag"
.DrawLine 100, 100, 300, 300
.AttributeLineColour = 120
.PageSaveAs "Example", "TEST"
.PageClose
.Visible = False
End With
Set GraphicsBuilder = Nothing

関連項目
エラー処 理
オート メーション イベント

エラー処 理
Visual Basic から関 数 を呼 び出 した場 合 、エラーがあると例 外 が発 生 します。次 の表 に、発
生 する可 能 性 のある HRESULT エラーをまとめます。

C++の定 義 16進 値 VBでの16進 コード 説明

S_OK 0 例 外 なし 正 常 に実 行

E_ 5 1つ以 上 の引 数 が範 囲 外
INVALIDARG 80070057

E_HANDLE 80070006 アクティブなオブジェクト (ページ

80070006 またはグラフィック オブジェクト )
なし

260
 Chapter: 6 グラフィックス ビルダー オートメーション インターフェース

E_POINTER 80004003 リンクの欠 落 または破 損 を検 出

80004003

E_ABORT 11F 列 挙 が中 止 されたか、関 数 が

80000007 手 動 でキャンセルされた
(ProjectUpdateなど)

E_FAIL 80004005 その他 のすべてのエラー

80004005

エラー コード の処 理 には、次 のVisual Basicコード を使 用 できます。

On Error Resume Next

Err.Clear
GraphicsBuilder.LibObjectName Project, File, Page, Type
If Err.Number <> 0 Then
Debug.Print "Error occurred in LibObjectName"
End If

次 の点 に注 意 してください。
l Visual Basicでは、エラーがある場 合 にのみErr変 数 が設 定 されます。関 数 が正 常 に実 行
された場 合 は、0には設 定 されません。
l Visual Basicが例 外 を処 理 する場 合 、関 数 のパラメータは無 視 されます。このた
め、ProjectNext のような関 数 が成 功 しなかった場 合 、空 の文 字 列 が返 されるのではなく、
文 字 列 は未 定 義 となります。
ページ関 数 、オプション関 数 、オブジェクト 描 画 およびプロパティ関 数 、テキスト プロパティ関 数
グループの関 数 、および
LibSelectionHooksEnabled、SelectionEventEnabled、BrokenLinkCancelEnabled、および
Visibleの各 関 数 は VB の変 数 として取 り扱 われます。
C++からこれらの関 数 を呼 び出 す場 合 、「put_」や「get_」のプレフィックスを使 用 する必 要 があり
ます。つまり、「put_Visible(TRUE)」、「get_Visible(bValue)」などとして、値 を設 定 または取 得
します。ただし、C++ でも関 数 は同 様 になります (例 ：PageName)。
C++の適 切 な関 数 名 を確 認 するには、タイプ ライブラリCTDRAW32.TLBを参 照 してください。
このタイプ ライブラリは、CitectSCADA のBINディレクト リにあります。Microsoft Visual Studio
ツールのOLE / COMオブジェクト 表 示 ア ([ファイル] メニューから [View Typelib] を選 択 ) を使
用 して表 示 することができます。
関連項目
オート メーション イベント

261
Chapter: 6 グラフィックス ビルダー オートメーション インターフェース

オート メーション イベント

グラフィックス ビルダーには、イベント ベースのアクション通 知 機 能 もあり、これによって、オート メー
ション クライアント は、このイベント を受 け取 り、適 切 な対 応 をとることができます。次 の例 ではフ
ォームとイベント 機 能 付 きグラフィックス ビルダーオート メーションオブジェクト を作 成 し、グラフィック
ス ビルダーがシンボルを貼 り付 けとページを保 存 する といった2 つのイベント を生 成 するアクショ
ンを実 行 します。
この機 能 を有 効 にするには：
l グラフィックス ビルダー オブジェクト が「WithEvents」を宣 言 する必 要 があります。
l イベント ハンド ラーのサブルーチンの名 前 とシグネチャが正 しいものでなければなりません。イ
ベント ハンド ラーの機 能 名 は、gb (グラフィックビルダー オブジェクト ) に_<eventName>を付
け足 します。例 ：gb_PasteSymbol。これは、標 準 の Visual Basic イベント ハンド リング サブ
ルーチン命 名 法 と一 致 しています。
詳 細 については、個 々 のイベント サブルーチンの説 明 を参 照 してください。

Private WithEvents gb As GraphicsBuilder.GraphicsBuilder

Public Sub Form_Load()
Set gb = New GraphicsBuilder.GraphicsBuilder
gb.LibrarySelectionHooksEnabled = True
gb.Visible = True
End Sub
Public Sub gb_PasteSymbol()
MsgBox ("PasteSymbol")
End Sub
Private Sub gb_PageSaved(ByVal Project As String, ByVal Page As String,
ByVal LastPage As Boolean)
MsgBox "PageSaved: " + Project + "." + Page + "--"
End Sub

関連項目
エラー処 理

関 数 カテゴリ
このテーブルで、グラフィックス ビルダー オート メーション インターフェースで公 開 されている
CitectSCADA 関 数 を、次 のカテゴリに分 類 し一 覧 表 示 しています。

整 列 と位 置 の 選 択 したオブジェクト の位 置 を3次 元 (X、Y、Z の順 序 ) で変 更 できます。

関数

イベント 関 数 特 定 の状 況 においてイベント を発 生 する、オート メーション ディスパッチ メカニズムを使

262
 Chapter: 6 グラフィックス ビルダー オートメーション インターフェース

用 できます。

特殊関数 現 在 このカテゴリに該 当 するのはVisible関 数 のみです。

動 的 なプロパ プロジェクト のグラフィックス オブジェクト の動 的 なプロパティ (移 動 、スケーリング、回 転 、

ティの関 数 スライダー、動 的 な色 の塗 り込 み) を編 集 できます。

ライブラリ オブ プロジェクト のライブラリに保 管 されているオブジェクト を使 用 および操 作 できます。これに

ジェクト 関 数 は、ジニー、スーパー ジニー、シンボルなどのオブジェクト も含 まれます。

その他 の関 数 グラフィックス ビルダーの特 別 な操 作 に使 用 します。例 えば、アクティブなウィンドウのハ

ンドルを要 求 して、外 部 とのドラッグ アンド ドロップを実 行 できます。

オブジェクト の オブジェクト を描 画 して、オブジェクト のプロパティを操 作 できます。

描 画 とプロパ
ティの関 数

オプション関 グラフィックス ビルダーの [ツール] メニューにあるオプションに関 連 する関 数 です。

数

ページ関 数 プロジェクト のページを操 作 (開 く、閉 じる、保 存 する、削 除 するなど) し、これらのペー

ジのオブジェクト を選 択 できます。テンプレート 、シンボル、ジニー、スーパー ジニーなど
です。

ページ プロパ プロジェクト のページのプロパティを操 作 できます。

ティの関 数

プロジェクト 関 これらの関 数 は、プロジェクト レベルで機 能 します。一 部 の関 数 は、Citect プロジェクト

数 エディタやプロジェクト エクスプローラの内 部 から起 動 されます。

テキスト プロ プロジェクト のテキスト オブジェクト のプロパティを読 み込 み、および編 集 できます。

パティの関 数

戻 り値 とエラー値 の処 理 の詳 細 、および Visual Basic のサンプルについては、エラー処 理 を参

照 してください。

整 列 と位 置 の関 数
次 の関 数 は、選 択 したオブジェクト の位 置 を 3 次 元 (X、Y、Z の順 序 ) で変 更 します。

PositionAt アクティブなオブジェクト を指 定 した位 置 に配 置 します。

PositionBringForward- ページのオブジェクト のレイヤーの中 で、最 後 に操 作 したオブジェクト を 1 つ

s 上 に移 動 し、前 方 に移 動 したように表 示 します。

263
Chapter: 6 グラフィックス ビルダー オートメーション インターフェース

PositionBringToFront グラフィックス ページで最 後 に操 作 したオブジェクト を一 番 上 のレイヤーに配

置 し、他 のオブジェクト の前 面 にあるように表 示 します。

PositionMirrorHorizon- 最 後 に操 作 したオブジェクト を、水 平 軸 に沿 って反 転 します。

tal

PositionMirrorVertical 最 後 に操 作 したオブジェクト を、垂 直 軸 に沿 って反 転 します。

PositionRotate 最 後 に操 作 したオブジェクト を時 計 回 りに 90 度 回 転 します。

PositionSendBackwar- ページのオブジェクト のレイヤーの中 で、最 後 に操 作 したオブジェクト を 1 つ

ds 下 に移 動 し、後 ろに移 動 したように表 示 します。

PositionSendToBack グラフィックス ページで最 後 に操 作 したオブジェクト を一 番 下 のレイヤーに配

置 し、他 のオブジェクト の後 ろにあるように表 示 します。

戻 り値 とエラー値 の処 理 の詳 細 、およびVisual Basicのサンプルについては、エラー処 理 を参

照 してください。

PositionAt
アクティブなオブジェクト を指 定 した位 置 に配 置 します。OptionSnapToGrid または
OptionSnapToGuidelines が真 (TRUE) に設 定 されている場 合 は、配 置 先 の座 標 が調 整 さ
れることに注 意 してください。

シンタックス
PositionAt(XPosition, YPosition)
XPosition:

ページの左 側 からの、ピクセルによる絶 対 X位 置 です。

YPosition:

ページの上 部 からの、ピクセルによる絶 対 Y位 置 です。

戻 り値
正 常 に関 数 が実 行 された場 合 は0 (ゼロ) が、それ以 外 の場 合 はエラーが返 されます。

注 : 戻 り値 とエラー値 の処 理 の詳 細 については、エラー処 理 を参 照 してください。

関連項目
PositionRotate, PositionMirrorVertical, PositionMirrorHorizontal, PositionSendToBack,
PositionBringToFront, PositionBringForwards, PositionSendBackwards

264
 Chapter: 6 グラフィックス ビルダー オートメーション インターフェース

GraphicsBuilder.LibraryObjectPlace "include", "agitator", "agit_1_Pos1_g", 2, True

GraphicsBuilder.PositionAt "200,200"

PositionBringForwards
ページのオブジェクト のレイヤーの中 で、最 後 に操 作 したオブジェクト を 1 つ上 に移 動 し、前 に
移 動 したように表 示 します。

シンタックス
PositionBringForwards

戻 り値
関 数 が正 常 に実 行 された場 合 は0 (ゼロ) が、それ以 外 の場 合 はエラーが返 されます。

注 : 戻 り値 とエラー値 の処 理 の詳 細 については、エラー処 理 を参 照 してください。

関連項目
PositionAt, PositionRotate, PositionMirrorVertical, PositionMirrorHorizontal,
PositionSendToBack, PositionBringToFront, PositionSendBackwards

' Moves an object forward in the layering of objects on a graphics page

GraphicsBuilder.LibraryObjectPlace "include", "agitator", "agit_1_Pos1_g", 2, True
GraphicsBuilder.PositionAt 200, 200
GraphicsBuilder.PositionBringForwards

PositionBringToFront
グラフィックス ページで最 後 に操 作 したオブジェクト を一 番 上 のレイヤーに配 置 し、他 のすべて
のオブジェクト の前 にあるように表 示 します。

シンタックス
PositionBringToFront

戻 り値
正 常 に関 数 が実 行 された場 合 は0 (ゼロ) が、それ以 外 の場 合 はエラーが返 されます。

265
Chapter: 6 グラフィックス ビルダー オートメーション インターフェース

注 : 戻 り値 とエラー値 の処 理 の詳 細 については、エラー処 理 を参 照 してください。

関連項目
PositionAt, PositionRotate, PositionMirrorVertical, PositionMirrorHorizontal,
PositionSendToBack, PositionBringForwards, PositionSendBackwards

' Places an object in front of all other objects on a graphics page

GraphicsBuilder.LibraryObjectPlace "include", "agitator", "agit_1_Pos1_g", 2, True
GraphicsBuilder.PositionAt 200, 200
GraphicsBuilder.PositionBringToFront

PositionMirrorHorizontal
最 後 に操 作 したオブジェクト を、水 平 軸 に沿 って反 転 します。

シンタックス
PositionMirrorHorizontal

戻 り値
正 常 に関 数 が実 行 された場 合 は0 (ゼロ) が、それ以 外 の場 合 はエラーが返 されます。

注 : 戻 り値 とエラー値 の処 理 の詳 細 については、エラー処 理 を参 照 してください。

関連項目
PositionAt, PositionRotate, PositionMirrorVertical, PositionSendToBack,
PositionBringToFront, PositionBringForwards, PositionSendBackwards

' Mirrors an object across a horizontal access

GraphicsBuilder.LibraryObjectPlace "include", "agitator", "agit_1_Pos1_g", 2, True
GraphicsBuilder.PositionAt 200, 200
GraphicsBuilder.PositionMirrorHorizontal

PositionMirrorVertical
最 後 に操 作 したオブジェクト を、垂 直 軸 に沿 って反 転 します。

266
 Chapter: 6 グラフィックス ビルダー オートメーション インターフェース

シンタックス
PositionMirrorVertical

戻 り値
関 数 が正 常 に実 行 された場 合 は0 (ゼロ) が、それ以 外 の場 合 はエラーが返 されます。

注 : 戻 り値 とエラー値 の処 理 の詳 細 については、エラー処 理 を参 照 してください。

関連項目
PositionAt, PositionRotate, PositionMirrorHorizontal, PositionSendToBack,
PositionBringToFront, PositionBringForwards, PositionSendBackwards

' Mirrors an object across a vertical access

GraphicsBuilder.LibraryObjectPlace "include", "agitator", "agit_1_Pos1_g", 2, True
GraphicsBuilder.PositionAt 200, 200
GraphicsBuilder.PositionMirrorVertical

PositionRotate
最 後 に操 作 したオブジェクト を時 計 回 りに 90 度 回 転 します。

シンタックス
PositionRotate

戻 り値
関 数 が正 常 に実 行 された場 合 は0 (ゼロ) が、それ以 外 の場 合 はエラーが返 されます。

注 : 戻 り値 とエラー値 の処 理 の詳 細 については、エラー処 理 を参 照 してください。

関連項目
PositionAt, PositionMirrorVertical, PositionMirrorHorizontal, PositionSendToBack,
PositionBringToFront, PositionBringForwards, PositionSendBackwards

267
Chapter: 6 グラフィックス ビルダー オートメーション インターフェース

' Rotates an object 90 degrees

GraphicsBuilder.LibraryObjectPlace "include", "agitator", "agit_1_Pos1_g", 2, True
GraphicsBuilder.PositionAt 200, 200
GraphicsBuilder.PositionRotate

PositionSendBackwards

ページのオブジェクト のレイヤーの中 で、最 後 に操 作 したオブジェクト を 1 つ下 に移 動 し、後 ろ

に移 動 したように表 示 します。

シンタックス
PositionSendBackwards

戻 り値
正 常 に関 数 が実 行 された場 合 は0 (ゼロ) が、それ以 外 の場 合 はエラーが返 されます。

注 : 戻 り値 とエラー値 の処 理 の詳 細 については、エラー処 理 を参 照 してください。

関連項目
PositionAt, PositionMirrorVertical, PositionMirrorHorizontal, PositionSendToBack,
PositionBringToFront, PositionBringForwards, PositionRotate

' Moves an object backwards in the layering of objects on a graphics page

GraphicsBuilder.LibraryObjectPlace "include", "agitator", "agit_1_Pos1_g", 2, True
GraphicsBuilder.PositionAt 200, 200
GraphicsBuilder.PositionSendBackwards

PositionSendToBack
グラフィックス ページで最 後 に操 作 したオブジェクト を一 番 下 のレイヤーに配 置 し、他 のすべて
のオブジェクト の後 ろにあるように表 示 します。

シンタックス
PositionSendToBack

268
 Chapter: 6 グラフィックス ビルダー オートメーション インターフェース

戻 り値
関 数 が正 常 に実 行 された場 合 は0 (ゼロ) が、それ以 外 の場 合 はエラーが返 されます。

注 : 戻 り値 とエラー値 の処 理 の詳 細 については、エラー処 理 を参 照 してください。

関連項目
PositionAt, PositionMirrorVertical, PositionMirrorHorizontal, PositionSendBackwards,
PositionBringToFront, PositionBringForwards, PositionRotate

' Places an object behind all other objects on a graphics page

GraphicsBuilder.LibraryObjectPlace "include", "agitator", "agit_1_Pos1_g", 2, True
GraphicsBuilder.PositionAt 200, 200
GraphicsBuilder.PositionSendToBack

イベント 関 数
次 のイベント では、オート メーション ディスパッチ メカニズムを使 用 して、特 定 の状 況 でイベント
が発 生 します。

BrokenLink このイベント は、関 数 ProjectUpdatePages()また PageOpen()を実 行 中 に欠 けてい

るリンクが見 つかった場 合 に発 生 します。欠 けているオブジェクト の詳 細
は、Project、Library、Object、GenieOrSymbol の各 パラメータで提 供 されます。

PasteGenie LibrarySelectionHooksEnabled()属 性 が真 (TRUE)に設 定 されていると、次 の場

合 にこのイベント が発 生 します。[ジニーの貼 り付 け] メニュー アイテムを選 択 した場
合 、[ジニーの貼 り付 け] ツールバー ボタンを押 した場 合 、または F11 キーを押 した場
合。

PasteSymbo- LibrarySelectionHooksEnabled()属 性 が真 (TRUE) に設 定 されていて、[シンボ

l ル貼 り付 け] メニュー項 目 を選 択 した場 合 、[シンボル貼 り付 け] ツールバー ボタンを押
した場 合 、またはF6キーを押 した場 合 にこのイベント が発 生 します。

ProjectChan- このイベント は、Citect エクスプローラで新 しいプロジェクト を選 択 するたびに発 生 しま

ge す。

Selection SelectionEventEnabled()が真 (TRUE) に設 定 されていると、グラフィックス ページ

内 で選 択 を行 うたびにこのイベント が発 生 します。選 択 の四 角 形 のサイズが、パラメー
タとして渡 されます。

269
Chapter: 6 グラフィックス ビルダー オートメーション インターフェース

SwapObject LibrarySelectionHooksEnabled()属 性 が真 (TRUE) に設 定 されていると、Ctrl

キーとShiftキーを同 時 に押 し、グラフィックス ページでオブジェクト をダブルクリックした場
合 にこのイベント が発 生 します。

注 : 戻 り値 とエラー値 の処 理 の詳 細 については、エラー処 理 を参 照 してください。

BrokenLink
このイベント は、関 数 ProjectUpdatePages または PageOpen を実 行 中 に欠 けているリンクが
見 つかった場 合 に発 生 します。欠 けているオブジェクト の詳 細
は、Project、Library、Object、GenieOrSymbol の各 パラメータで提 供 されます。

シンタックス
BrokenLink(Project, Library, Object, GenieOrSymbol)
Project：

プロジェクト の名 前 。

Library：

ライブラリの名 前 。

Object：

シンボルまたはジニーの名 前 。

GenieOrSymbol：

オブジェクト がシンボルか、ジニーかを識 別 します。1 = ジニー、2 = シンボルです。

関連項目
オート メーション イベント

PasteGenie
LibrarySelectionHooksEnabled 属 性 が真 (TRUE) に設 定 されていて、[ジニーの貼 り付 け] メ
ニュー項 目 を選 択 した場 合 、[ジニーの貼 り付 け] ツールバー ボタンを押 した場 合 、または F11
キーを押 した場 合 にこのイベント が発 生 します。

シンタックス
PasteGenie
関連項目
オート メーション イベント

270
 Chapter: 6 グラフィックス ビルダー オートメーション インターフェース

PasteSymbol
LibrarySelectionHooksEnabled() 属 性 が真 (TRUE) に設 定 されていて、[シンボル貼 り付 け]
メニュー項 目 を選 択 した場 合 、[シンボル貼 り付 け] ツールバー ボタンを押 した場 合 、または F6
キーを押 した場 合 にこのイベント が発 生 します。

シンタックス
PasteSymbol
関連項目
オート メーション イベント

ProjectChange
このイベント は、Citect エクスプローラで新 しいプロジェクト を選 択 するたびに発 生 します。

シンタックス
ProjectChange
関連項目
オート メーション イベント

Selection
SelectionEventEnabled が真 (TRUE) に設 定 されていると、グラフィックス ページ内 で選 択 を行
うたびにこのイベント が発 生 します。選 択 の四 角 形 のサイズが、パラメータとして渡 されます。

シンタックス
Selection (FromXPosition, FromYPosition, ToXPosition, ToYPosition)
FromXPosition:

ページの左 側 から、選 択 した四 角 形 の左 上 のコーナーまでの距 離 (ピクセル単 位 ) です。

FromYPosition:

ページの上 部 から、選 択 した四 角 形 の左 上 のコーナーまでの距 離 (ピクセル単 位 ) です。

ToXPosition:

ページの左 側 から、選 択 した四 角 形 の右 下 のコーナーまでの距 離 (ピクセル単 位 ) です。

ToYPosition:

ページの上 部 から、選 択 した四 角 形 の右 下 のコーナーまでの距 離 (ピクセル単 位 ) です。

関連項目
オート メーション イベント

271
Chapter: 6 グラフィックス ビルダー オートメーション インターフェース

SwapObject
LibrarySelectionHooksEnabled 属 性 が真 (TRUE) に設 定 されているときに、Ctrl キーと Shift
キーを同 時 に押 し、グラフィックス ページのオブジェクト をダブルクリックするとこのイベント が発 生
します。

シンタックス
SwapObject
関連項目
オート メーション イベント

特殊関数
特 殊 関 数 のカテゴリには、現 在 、表 示 関 数 のみが含 まれています。

Visib- CitectSCADA グラフィックス ビルダーの可 視 性 を制 御 するか、または現 在 の可 視 マルチステート

le を取 得 します。

注 ：戻 り値 とエラー値 の処 理 の詳 細 については、エラー処 理 を参 照 してください。

Visible
CitectSCADA グラフィックス ビルダーの可 視 性 を制 御 するか、または現 在 の可 視 マルチステー
ト を取 得 します。

シンタックス
Visible

戻 り値
グラフィックス ビルダーの現 在 の可 視 マルチステート を確 認 する場 合 は、真 (TRUE) または偽
(FALSE) が返 されます。この関 数 に設 定 を適 用 する場 合 は、設 定 が完 了 した場 合 は 0 (ゼ
ロ) が、その他 の場 合 はエラーが返 されます。

注 :戻 り値 とエラー値 の処 理 の詳 細 については、エラー処 理 を参 照 してください。

272
 Chapter: 6 グラフィックス ビルダー オートメーション インターフェース

' Make CitectSCADA Graphics Builder appear

GraphicsBuilder.Visible = TRUE

' Retrieve the current visible state of the Graphics Builder

MyVariable = GraphicsBuilder.Visible

注 :この関 数 は、C++環 境 では2つの独 立 した関 数 として実 行 されます。put_Visible によっ

てグラフィックス ビルダーの可 視 マルチステート が設 定 され、get_Visibleによってグラフィックス
ビルダーの現 在 の可 視 マルチステート が取 得 されます (TRUE=表 示 )。

動 的 なプロパティの関 数
これらの関 数 では、プロジェクト のグラフィックス オブジェクト の動 的 なプロパティ (移 動 、スケーリ
ング、回 転 、スライダー、動 的 な色 の塗 り込 み) を編 集 できます。
選 択 されているオブジェクト やアクティブなオブジェクト がない場 合 、またはオブジェクト でこのタイ
プのプロパティがサポート されていない場 合 は、エラーE_HANDLEが返 されます。引 数 が範 囲
外 の場 合 はE_INVALIDARGが返 されます。

PropertiesAccessDisableGet [オブジェクト のプロパティ] ダイアログ ボックスの [アクセス |

無 効 ] タブで設 定 されている現 在 の値 を読 み込 みます。

PropertiesAccessDisablePut [オブジェクト のプロパティ] ダイアログ ボックスの [アクセス |

無 効 ] タブで値 を設 定 します。

PropertiesAccessGeneralGet [オブジェクト のプロパティ] ダイアログ ボックスの [アクセス |

全 般 ] タブの値 を読 み込 みます。

PropertiesAccessGeneralPut [オブジェクト のプロパティ] ダイアログ ボックスの [アクセス |

全 般 ] タブで値 を設 定 します。

PropertiesButtonGet [オブジェクト のプロパティ] ダイアログ ボックスの [表 示 | 全

般 ] タブからボタン オブジェクト の値 を読 み込 みます。

PropertiesButtonPut ボタン オブジェクト の [オブジェクト のプロパティ] ダイアログ

ボックスの [表 示 | 全 般 ] タブで値 を設 定 します。

PropertiesCicodeObjectGet [オブジェクト のプロパティ] ダイアログ ボックスの [Cicode |

全 般 ] タブからCicodeオブジェクト の値 を読 み込 みます。

PropertiesCicodeObjectPut [オブジェクト のプロパティ] ダイアログ ボックスの [Cicode |

273
Chapter: 6 グラフィックス ビルダー オートメーション インターフェース

全 般 ] タブで Cicode オブジェクト の値 を設 定 します。

PropertiesDisplayValueGet [オブジェクト のプロパティ] ダイアログ ボックスの [表 示 | 表

示 内 容 ] タブで設 定 されているタイプと式 を設 定 します。

PropertiesDisplayValuePut [オブジェクト のプロパティ] ダイアログ ボックスの [表 示 | 表

示 内 容 ] タブで値 と式 を設 定 します。

PropertiesDisplayValueTextGet [オブジェクト のプロパティ] ダイアログ ボックスの [表 示 | 表

示 内 容 ] タブから特 定 のインデックスのテキスト を読 み込
みます。

PropertiesDisplayValueTextPut [オブジェクト のプロパティ] ダイアログ ボックスの [表 示 | 表

示 内 容 ] タブで特 定 のインデックスのテキスト を設 定 しま
す。

PropertiesFillColourColourGet [オブジェクト のプロパティ] ダイアログ ボックスの [塗 り込 み

| 色 ] タブから、指 定 されたインデックス ポイント に設 定 さ
れている現 在 の色 の値 を読 み込 みます。この関 数
は、PropertiesFillColourColourGetEx関 数 に置 き換 え
られました。

PropertiesFillColourColourGetEx [オブジェクト のプロパティ] ダイアログ ボックスの [塗 り込 み

| 色 ] タブから、指 定 されたインデックス ポイント に設 定 さ
れている現 在 の色 の値 を読 み込 みます。

PropertiesFillColourColourPut [オブジェクト のプロパティ] ダイアログ ボックスの [塗 り込 み

| 色 ] タブで、特 定 のインデックスに色 を設 定 します。この
関 数 は、PropertiesFillColourColourPutEx関 数 に置
き換 えられました。

PropertiesFillColourColourPutEx [オブジェクト のプロパティ] ダイアログ ボックスの [塗 り込 み

| 色 ] タブで、特 定 のインデックスに色 を設 定 します。

PropertiesFillColourGet 現 在 のオブジェクト の [オブジェクト のプロパティ] ダイアログ

ボックスの [塗 り込 み | 色 ] タブで設 定 されている値 を読
み込 みます。

PropertiesFillColourPut [オブジェクト のプロパティ] ダイアログ ボックスの [塗 り込 み

| 色 ] タブで値 を設 定 します。

PropertiesFillLevelGet [オブジェクト のプロパティ] ダイアログ ボックスの [塗 り込 み

| レベル] タブで設 定 されている値 を読 み込 みます。この
関 数 は、PropertiesFillLevelGetEx関 数 に置 き換 えら
れました。

PropertiesFillLevelGetEx [オブジェクト のプロパティ] ダイアログ ボックスの [塗 り込 み

| レベル] タブで設 定 されている値 を読 み込 みます。

274
 Chapter: 6 グラフィックス ビルダー オートメーション インターフェース

PropertiesFillLevelPut [オブジェクト のプロパティ] ダイアログ ボックスの [塗 り込 み

| レベル] タブで値 を設 定 します。この関 数
は、PropertiesFillLevelPutEx関 数 に置 き換 えられまし
た。

PropertiesFillLevelPutEx [オブジェクト のプロパティ] ダイアログ ボックスの [塗 り込 み

| レベル] タブで値 を設 定 します。

PropertiesInputKeyboardGet [オブジェクト のプロパティ] ダイアログ ボックスの [入 力 |

キーボード コマンド] タブで設 定 されている値 を読 み込 み
ます。

PropertiesInputKeyboardPut [オブジェクト のプロパティ] ダイアログ ボックスの [入 力 |

キーボード コマンド] タブで値 を設 定 します。

PropertiesInputTouchGet [オブジェクト のプロパティ] ダイアログ ボックスの [入 力 | タ

ッチ] タブで設 定 されている値 を読 み込 みます。

PropertiesInputTouchPut [オブジェクト のプロパティ] ダイアログ ボックスの [入 力 | タ

ッチ] タブで値 を設 定 します。

PropertiesShowDialog オブジェクト のプロパティ ダイアログ ボックス、またはジニーの

フォームを表 示 します。

PropertiesSymbolSetGet [オブジェクト のプロパティ] ダイアログ ボックスの [表 示 | 全

般 ] タブで設 定 されているタイプと式 を読 み込 みます。

PropertiesSymbolSetPut [オブジェクト のプロパティ] ダイアログ ボックスの [表 示 | 全

般 ] タブで、シンボル セット に定 義 されているタイプを設 定
します。

PropertiesSymbolSetSymbolGet 現 在 選 択 しているオブジェクト の「インデックス」要 素 の要 素

名 とライブラリ名 を取 得 します。

PropertiesSymbolSetSymbolPut 現 在 選 択 しているオブジェクト の「インデックス」要 素 の要 素

名 とライブラリ名 を設 定 します。

PropertiesTransCentreOffsetExpressGet 定 義 式 のプロパティを取 得 します。

PropertiesTransCentreOffsetExpressPut エクスプレス プロパティを設 定 します。

PropertiesTransformationGet [オブジェクト のプロパティ] ダイアログ ボックスの [移 動 ]、[

スケーリング]、および [スライダー] の各 タブで設 定 されて
いるプロパティ値 を読 み込 みます。

PropertiesTransformationPut [オブジェクト のプロパティ] ダイアログ ボックスの [移 動 ]、[

スケーリング]、および [スライダー] の各 タブで、プロパティ
の値 を設 定 します。

PropertiesTrendGet [オブジェクト のプロパティ] ダイアログ ボックスの [表 示 | 全

275
Chapter: 6 グラフィックス ビルダー オートメーション インターフェース

般 ] タブで設 定 されている、ト レンド オブジェクト の値 を読

み込 みます。この関 数 は、PropertiesTrendGetEx関 数
に置 き換 えられました。

PropertiesTrendGetEx [オブジェクト のプロパティ] ダイアログ ボックスの [表 示 | 全

般 ] タブで設 定 されている、ト レンド オブジェクト の値 を読
み込 みます。

PropertiesTrendPut [オブジェクト のプロパティ] ダイアログ ボックスの [表 示 | 全

般 ] タブに表 示 される、ト レンド オブジェクト の値 を設 定 し
ます。この関 数 は、PropertiesTrendPutEx関 数 に置 き
換 えられました。

PropertiesTrendPutEx [オブジェクト のプロパティ] ダイアログ ボックスの [表 示 | 全

般 ] タブに表 示 される、ト レンド オブジェクト の値 を設 定 し
ます。

PropertyVisibility [オブジェクト のプロパティ] ダイアログ ボックスの [表 示 | 可

視 性 ] タブで、[非 表 示 の条 件 ] を設 定 します。

注 : 戻 り値 とエラー値 の処 理 の詳 細 については、エラー処 理 を参 照 してください。

PropertiesAccessDisableGet
現 在 のオブジェクト の [オブジェクト のプロパティ] ダイアログ ボックスの [アクセス | 無 効 ] タブで設
定 されている現 在 の値 を読 み込 みます。

シンタックス
PropertiesAccessDisableGet(Expression, DisableFlag, DisableStyle)
式:

[使 用 不 可 条 件 ] コマンド の文 字 列

DisableFlag:

不 適 切 なエリアや権 限 設 定 が発 生 した場 合 に、オブジェクト が無 効 になるように設 定 されている場 合 は

TRUE。

DisableStyle:

[使 用 不 可 の表 示 ]の設 定
l 0 = 浮 き彫 り
l 1 = 灰色表示
l 2 = 非表示

276
 Chapter: 6 グラフィックス ビルダー オートメーション インターフェース

戻 り値
要 求 された値 (文 字 列 )。

注 :戻 り値 とエラー値 の処 理 の詳 細 については、エラー処 理 を参 照 してください。

関連項目
PropertiesAccessDisablePut

PropertiesAccessDisablePut
現 在 のオブジェクト の [オブジェクト のプロパティ] ダイアログ ボックスの [アクセス | 無 効 ] タブで値
を設 定 します。

シンタックス
PropertiesAccessDisablePut(Expression, DisableFlag, DisableStyle)
式:

コマンドの場 合 の Disable の文 字 列

DisableFlag:

不 適 切 なエリアや権 限 設 定 が発 生 した場 合 に、オブジェクト が無 効 になるように設 定 されている場 合 は

TRUE。

DisableStyle:

無 効 のスタイルの設 定
l 0 = 浮 き彫 り
l 1 = 灰色表示
l 2 = 非表示

戻 り値
正 常 に関 数 が実 行 された場 合 は 0 (ゼロ) が、それ以 外 の場 合 はエラーが返 されます。

注 :戻 り値 とエラー値 の処 理 の詳 細 については、エラー処 理 を参 照 してください。

関連項目
PropertiesAccessDisableGet

PropertiesAccessGeneralGet

277
Chapter: 6 グラフィックス ビルダー オートメーション インターフェース

現 在 のオブジェクト の [オブジェクト のプロパティ] ダイアログ ボックスの [[アクセス | 全 般 ] ]で値 を

読 み込 みます。

シンタックス
PropertiesAccessGeneralGet(Description, Tooltip, Area, Privilege, LogDevice)
説明：

オブジェクト を説 明 する文 字 列 。

ツールチップ：

オブジェクト のツールチップ文 字 列 。

Area:

現 在 のエリアの設 定 を示 す1 ～ 255の値 。または、[ページと同 じエリア] チェック ボックスがオンの場 合 は

0。

Privilege:

現 在 の権 限 の設 定 を示 す 1 ～ 255 の値 。または、[権 限 制 限 無 し]チェック ボックスがオンの場 合 は 0。

LogDevice:

ログ デバイスの名 前 (文 字 列 )。

戻 り値
要 求 された値 (文 字 列 )。

注 :戻 り値 とエラー値 の処 理 の詳 細 については、エラー処 理 を参 照 してください。

関連項目
PropertiesAccessGeneralPut

PropertiesAccessGeneralPut
現 在 のオブジェクト の [オブジェクト のプロパティ] ダイアログ ボックスの [アクセス] メニューの [全
般 ] タブで値 を設 定 します。

シンタックス
PropertiesAccessGeneralPut(Description, Tooltip, Area, Privilege, LogDevice)
説明：

オブジェクト を説 明 する文 字 列 。

ツールチップ：

278
 Chapter: 6 グラフィックス ビルダー オートメーション インターフェース

オブジェクト のツールチップ文 字 列 。

Area:

現 在 のエリアの設 定 を示 す1 ～ 255の値 。または、[ページと同 じエリア] チェック ボックスがオンの場 合 は

0。

Privilege:

現 在 の権 限 の設 定 を示 す 1 ～ 255 の値 。または、[権 限 制 限 無 し] チェック ボックスがオンの場 合 は 0。

LogDevice:

ログ デバイスの名 前 (文 字 列 )。

戻 り値
正 常 に関 数 が実 行 された場 合 は 0 (ゼロ) が、それ以 外 の場 合 はエラーが返 されます。

注 :戻 り値 とエラー値 の処 理 の詳 細 については、「オート メーションのエラー処 理 」を参 照 し

てください。

関連項目
PropertiesAccessGeneralGet

PropertiesButtonGet
[オブジェクト のプロパティ] ダイアログ ボックスの [表 示 | 全 般 ] タブからボタン オブジェクト の値 を
読 み込 みます。

シンタックス
PropertiesButtonGet(ButtonType, Text, TextFont, Library, SymbolName)
ButtonType:

ボタンのタイプを定 義 します。
l 0 = テキスト
l 1 = 枠 線 3D ターゲット
l 2 = 枠 線 ターゲット
l 3 = ターゲット
l 4 = シンボル
l 5 = XP 様 式 のテキスト つきボタン
l 6 = XP 様 式 のシンボルつきボタン
テキストの場 合

ボタン テキスト 。この引 数 が有 効 なのは、ButtonType = 0 および 5 (テキスト ) についてのみです。

279
Chapter: 6 グラフィックス ビルダー オートメーション インターフェース

TextFont:

ボタンのテキスト に使 用 するフォント 。この引 数 が有 効 なのは、ButtonType = 0 および 5 (テキスト ) につい

てのみです。

Library:

ボタンのシンボルが保 管 されているライブラリ。この引 数 が有 効 なのは、ButtonType = 4 および 6 (シンボ

ル) についてのみです。

SymbolName:

ボタンに表 示 するシンボルの名 前 。この引 数 が有 効 なのは、ButtonType = 4 および 6 (シンボル) につい

てのみです。

戻 り値
要 求 された値 (文 字 列 )。

注 :戻 り値 とエラー値 の処 理 の詳 細 については、エラー処 理 を参 照 してください。

関連項目
PropertiesButtonPut

PropertiesButtonPut
ボタン オブジェクト の [オブジェクト のプロパティ] ダイアログ ボックスの [表 示 |全 般 ] タブで値 を設
定 します。

シンタックス
PropertiesButtonPut(Type, Text, TextFont, Library, SymbolName)
ButtonType:

ボタンのタイプを定 義 します。
l 0 = テキスト
l 1 = 枠 線 3D ターゲット
l 2 = 枠 線 ターゲット
l 3 = ターゲット
l 4 = シンボル
l 5 = XP 仕 様 のテキスト つきボタン
l 6 = XP 仕 様 のシンボルつきボタン
テキストの場 合

ボタン テキスト 。この引 数 が有 効 なのは、ButtonType = 0 および 5 (テキスト ) についてのみです。

280
 Chapter: 6 グラフィックス ビルダー オートメーション インターフェース

TextFont:

ボタンのテキスト に使 用 するフォント 。この引 数 が有 効 なのは、ButtonType = 0 および 5 (テキスト ) につい

てのみです。

Library:

ボタンのシンボルが保 管 されているライブラリ。この引 数 が有 効 なのは、ButtonType = 4 および 6 (シンボ

ル) についてのみです。

SymbolName:

ボタンに表 示 するシンボルの名 前 。この引 数 が有 効 なのは、ButtonType = 4 および 6 (シンボル) につい

てのみです。

戻 り値
関 数 が正 常 に実 行 された場 合 は0 (ゼロ) が、それ以 外 の場 合 はエラーが返 されます。

注 :戻 り値 とエラー値 の処 理 の詳 細 については、エラー処 理 を参 照 してください。

関連項目
PropertiesButtonGet

PropertiesCicodeObjectGet
[オブジェクト のプロパティ] ダイアログ ボックスの [Cicode] メニューの [全 般 ] タブから Cicode オブ
ジェクト の値 を読 み込 みます。

シンタックス
PropertiesCicodeObjectGet(Expression, Library, SymbolName)
式:

コマンドの式

Library:

使 用 するシンボルが保 管 されているライブラリの名 前 。

SymbolName:

使 用 するシンボルの名 前 。

戻 り値
要 求 された値 (文 字 列 )。

281
Chapter: 6 グラフィックス ビルダー オートメーション インターフェース

注 :戻 り値 とエラー値 の処 理 の詳 細 については、エラー処 理 を参 照 してください。

関連項目
PropertiesCicodeObjectPut

PropertiesCicodeObjectPut
[オブジェクト のプロパティ] ダイアログ ボックスの [Cicode | 全 般 ] タブで Cicode オブジェクト の値
を設 定 します。

シンタックス
PropertiesCicodeObjectPut(Expression, Library, SymbolName)
式:

コマンドの式

Library:

使 用 するシンボルが保 管 されているライブラリの名 前 。

SymbolName:

使 用 するシンボルの名 前 。

戻 り値
関 数 が正 常 に実 行 された場 合 は0 (ゼロ) が、それ以 外 の場 合 はエラーが返 されます。

注 :戻 り値 とエラー値 の処 理 の詳 細 については、エラー処 理 を参 照 してください。

関連項目
PropertiesCicodeObjectGet

PropertiesDisplayValueGet
数 値 オブジェクト またはテキスト オブジェクト の [オブジェクト のプロパティ] ダイアログ ボックスの [
表 示 | 表 示 内 容 ] タブで設 定 されているタイプと式 を読 み込 みます。

シンタックス
PropertiesDisplayValueGet(SymbolSetType, ExpressionA, ExpressionB, ExpressionC,
ExpressionD, ExpressionE)
SymbolSetType:

282
 Chapter: 6 グラフィックス ビルダー オートメーション インターフェース

シンボル セット のタイプを定 義 します。

l 0 = オン/オフ
l 1 = マルチステート
l 2 = 配列
l 3 = 数字
l 4 = 文字列
ExpressionA:

これが主 な式 です。
l タイプ [オン/オフ] の [オンのテキスト の条 件 ]。
l タイプ [マルチステート ] の条 件 A。
l タイプ [配 列 ] の配 列 式 。
l タイプ [数 字 ] の数 式 。
l タイプ [文 字 列 ] の文 字 列 の定 義 式 。
ExpressionB:

条 件 B。[マルチステート ] タイプでのみ使 用 されます。

ExpressionC:

条 件 C。[マルチステート ] タイプでのみ使 用 されます。

ExpressionD:

条 件 D。[マルチステート ] タイプでのみ使 用 されます。

ExpressionE:

条 件 E。[マルチステート ] タイプでのみ使 用 されます。

戻 り値
要 求 された値 (文 字 列 )。

注 :戻 り値 とエラー値 の処 理 の詳 細 については、エラー処 理 を参 照 してください。

関連項目
PropertiesDisplayValuePut

283
Chapter: 6 グラフィックス ビルダー オートメーション インターフェース

` Gets the properties on the Appearance/DisplayValue sheet for a

number or text object

GraphicsBuilder.PropertiesDisplayValueGet nType, Expression1,

Expression2, Expression3, Expression4, Expression5

PropertiesDisplayValuePut
数 値 オブジェクト またはテキスト オブジェクト の [オブジェクト のプロパティ] ダイアログ ボックスの [
表 示 | 表 示 内 容 ] タブに表 示 されるフィールド を設 定 します。これには、タイプの設 定 と関 連
する式 が含 まれます。

シンタックス
PropertiesDisplayValueGet(SymbolSetType, ExpressionA, ExpressionB, ExpressionC,
ExpressionD, ExpressionE)
SymbolSetType:

シンボル セット のタイプを定 義 します。

l 0 = オン/オフ
l 1 = マルチステート
l 2 = 配列
l 3 = 数字
l 4 = 文字列
ExpressionA:

これが主 な式 です。
l タイプ [オン/オフ] の [オンのテキスト の条 件 ]。
l タイプ [マルチステート ] の条 件 A。
l タイプ [配 列 ] の配 列 式 。
l タイプ [数 字 ] の数 式 。
l タイプ [文 字 列 ] の文 字 列 の定 義 式 。
ExpressionB:

条 件 B。[マルチステート ] タイプでのみ使 用 されます。

ExpressionC:

条 件 C。[マルチステート ] タイプでのみ使 用 されます。

ExpressionD:

条 件 D。[マルチステート ] タイプでのみ使 用 されます。

284
 Chapter: 6 グラフィックス ビルダー オートメーション インターフェース

ExpressionE:

条 件 E。[マルチステート ] タイプでのみ使 用 されます。

戻 り値
関 数 が正 常 に実 行 された場 合 は0 (ゼロ) が、それ以 外 の場 合 はエラーが返 されます。

注 :戻 り値 とエラー値 の処 理 の詳 細 については、エラー処 理 を参 照 してください。

関連項目
PropertiesDisplayValueGet

PropertiesDisplayValueTextGet
タイプがマルチステート 、配 列 、または数 字 である数 値 オブジェクト またはテキスト オブジェクト の
[オブジェクト のプロパティ] ダイアログ ボックスの [表 示 | 表 示 内 容 ] タブから、特 定 のインデック
スのテキスト を読 み込 みます。

シンタックス
PropertiesDisplayValueTextGet(Index, Text)
Index:

テキスト の場 所 。
l 0..31：タイプが [マルチステート ] の場 合 。
l 0..255：タイプが [配 列 ] の場 合 。
l 0：タイプが [数 字 ] の場 合 。
テキストの場 合

フィールドに書 き込 まれたテキスト 。
l タイプ [マルチステート ] のステート テキスト 。
l タイプ [配 列 ] の配 列 テキスト 。
l タイプ [数 字 ] のフォーマット 。

戻 り値
要 求 された値 (文 字 列 )。

注 :戻 り値 とエラー値 の処 理 の詳 細 については、エラー処 理 を参 照 してください。

285
Chapter: 6 グラフィックス ビルダー オートメーション インターフェース

関連項目
PropertiesDisplayValueTextPut, PropertiesDisplayValuePut, PropertiesCicodeObjectPut

PropertiesDisplayValueTextPut
タイプがマルチステート 、配 列 、または数 字 である数 値 オブジェクト またはテキスト オブジェクト の
[オブジェクト のプロパティ] ダイアログ ボックスの [表 示 | 表 示 内 容 ] タブで、特 定 のインデックス
のテキスト を設 定 します。

シンタックス
PropertiesDisplayValueTextGet(Index, Text)
Index:

テキスト の場 所 。
l 0..31：タイプが [マルチステート ] の場 合 。
l 0..255：タイプが [配 列 ] の場 合 。
l 0：タイプが [数 字 ] の場 合 。
テキストの場 合

フィールドに書 き込 まれたテキスト 。
l タイプ [マルチステート ] のステート テキスト 。
l タイプ [配 列 ] の配 列 テキスト 。
l タイプ [数 字 ] のフォーマット 。

戻 り値
関 数 が正 常 に実 行 された場 合 は0 (ゼロ) が、それ以 外 の場 合 はエラーが返 されます。

注 :戻 り値 とエラー値 の処 理 の詳 細 については、エラー処 理 を参 照 してください。

関連項目
PropertiesDisplayValueTextGet, PropertiesSymbolSetPut, PropertiesSymbolSetGet

PropertiesFillColourColourGet
配 列 、限 界 値 、および階 調 度 のタイプの [オブジェクト のプロパティ] ダイアログ ボックスの [塗 り
込 み | 色 ] タブで、指 定 されたインデックス ポイント に設 定 されている現 在 の色 の値 を読 み込
みます。

注 :この関 数 では True Color 機 能 がサポート されていないため、関 数

286
 Chapter: 6 グラフィックス ビルダー オートメーション インターフェース

PropertiesFillColourColourGetEx に置 き換 えられました。

シンタックス
PropertiesFillColourColourGet(Index, ColourNo, Limit, Operator)
Index:

現 在 の色 を読 み込 む対 象 のインデックスを指 定 します。この値 は、選 択 した色 の塗 り込 みによって異 なり

ます。
l 0 - 31：タイプが [マルチステート ] の場 合 。
l 0 - 255：タイプが [配 列 ] の場 合 。
l 0 - 255：タイプが [限 界 値 ] の場 合 。
l 0 - 1：階 調 度 の場 合 。
ColourNo:

インデックス設 定 に適 用 された色 を表 す、0 ～ 255 の値 。

Limit:

限 界 値 を表 す、0 ～ 100の値 。タイプ [限 界 値 ] にのみ使 用 されます。

Operator:

限 界 値 の設 定 に使 用 される、現 在 の演 算 子 を表 す値 。
l 0 : < (より小 さい)
l 1 : > (より大 きい)
l 2 : < = (以 下 )
l 3 : > = (以 上 )

戻 り値
関 数 が正 常 に実 行 された場 合 は0 (ゼロ) が、それ以 外 の場 合 はエラーが返 されます。

注 :戻 り値 とエラー値 の処 理 の詳 細 については、エラー処 理 を参 照 してください。

関連項目
PropertiesFillColourColourPut, PropertiesFillColourGet, PropertiesFillColourPut

PropertiesFillColourColourGetEx
配 列 、限 界 値 、および階 調 度 のタイプの [オブジェクト のプロパティ] ダイアログ ボックスの [塗 り
込 み | 色 ] タブで、指 定 されたインデックス ポイント に設 定 されている現 在 の色 の値 を読 み込
みます。

287
Chapter: 6 グラフィックス ビルダー オートメーション インターフェース

シンタックス
PropertiesFillColourColourGet(Index, OnColourNo, OffColourNo, Limit, Operator)
Index:

現 在 の色 を読 み込 む対 象 のインデックスを指 定 します。この値 は、選 択 した色 の塗 り込 みによって異 なり

ます。
l 0 - 31：タイプが [マルチステート ] の場 合 。
l 0 - 255：タイプが [配 列 ] の場 合 。
l 0 - 255：タイプが [限 界 値 ] の場 合 。
l 0 - 1：階 調 度 の場 合 。
OnColourNo:

インデックス設 定 に適 用 されている「ON」の色 を表 す RGB 値 。

OffColourNo:

インデックス設 定 に適 用 されている「off」の色 を表 す RGB 値 。

Limit:

限 界 値 を表 す、0 ～ 100の値 。タイプ [限 界 値 ] にのみ使 用 されます。

Operator:

限 界 値 の設 定 に使 用 される、現 在 の演 算 子 を表 す値 。
l 0 : < (より小 さい)
l 1 : > (より大 きい)
l 2 : < = (以 下 )
l 3 : > = (以 上 )

戻 り値
関 数 が正 常 に実 行 された場 合 は0 (ゼロ) が、それ以 外 の場 合 はエラーが返 されます。

注 :戻 り値 とエラー値 の処 理 の詳 細 については、エラー処 理 を参 照 してください。

関連項目
PropertiesFillColourColourPutEx, PropertiesFillColourGet, PropertiesFillColourPut

PropertiesFillColourColourPut
[配 列 ]、[限 界 値 ]、[階 調 度 ] のタイプの [オブジェクト のプロパティ] ダイアログ ボックスの [塗 り込
み | 色 ] タブで、特 定 のインデックスの色 を設 定 します。

288
 Chapter: 6 グラフィックス ビルダー オートメーション インターフェース

注 :この関 数 では True Color 機 能 がサポート されていないため、関 数

PropertiesFillColourColourPutEx に置 き換 えられました。

シンタックス
PropertiesFillColourColourPut(Index, ColourNo, Limit, Operator)
Index:

現 在 の色 を読 み込 む対 象 のインデックスを指 定 します。この値 は、選 択 した色 の塗 り込 みによって異 なり

ます。
l 0 - 31：タイプが [マルチステート ] の場 合 。
l 0 - 255：タイプが [配 列 ] の場 合 。
l 0 - 255：タイプが [限 界 値 ] の場 合 。
l 0 - 1：階 調 度 の場 合 。
ColourNo:

インデックス設 定 に適 用 された色 を表 す、0 ～ 255 の値 。

Limit:

限 界 値 を表 す、0 ～ 100の値 。タイプ [限 界 値 ] にのみ使 用 されます。

Operator:

限 界 値 の設 定 に使 用 される、現 在 の演 算 子 を表 す値 。
l 0 : < (より小 さい)
l 1 : > (より大 きい)
l 2 : < = (以 下 )
l 3 : > = (以 上 )

戻 り値
関 数 が正 常 に実 行 された場 合 は0 (ゼロ) が、それ以 外 の場 合 はエラーが返 されます。

注 :戻 り値 とエラー値 の処 理 の詳 細 については、エラー処 理 を参 照 してください。

関連項目
PropertiesFillColourColourGet, PropertiesFillColourGet, PropertiesFillColourPut

PropertiesFillColourColourPutEx
[配 列 ]、[限 界 値 ]、[階 調 度 ] のタイプの [オブジェクト のプロパティ] ダイアログ ボックスの [塗 り込
み | 色 ] タブで、特 定 のインデックスの色 を設 定 します。

289
Chapter: 6 グラフィックス ビルダー オートメーション インターフェース

シンタックス
PropertiesFillColourColourPutEx(Index, OnColourNo, OffColourNo, Limit, Operator)
Index:

現 在 の色 を読 み込 む対 象 のインデックスを指 定 します。この値 は、選 択 した色 の塗 り込 みによって異 なり

ます。
l 0 - 31：タイプが [マルチステート ] の場 合 。
l 0 - 255：タイプが [配 列 ] の場 合 。
l 0 - 255：タイプが [限 界 値 ] の場 合 。
l 0 - 1：階 調 度 の場 合 。
OnColourNo:

インデックス設 定 に適 用 されている「ON」の色 を表 す RGB 値 。

OffColourNo:

インデックス設 定 に適 用 されている「off」の色 を表 す RGB 値 。

Limit:

限 界 値 を表 す、0 ～ 100の値 。タイプ [限 界 値 ] にのみ使 用 されます。

Operator:

限 界 値 の設 定 に使 用 される、現 在 の演 算 子 を表 す値 。
l 0 : < (より小 さい)
l 1 : > (より大 きい)
l 2 : < = (以 下 )
l 3 : > = (以 上 )

戻 り値
関 数 が正 常 に実 行 された場 合 は0 (ゼロ) が、それ以 外 の場 合 はエラーが返 されます。

注 :戻 り値 とエラー値 の処 理 の詳 細 については、エラー処 理 を参 照 してください。

関連項目
PropertiesFillColourColourGetEx, PropertiesFillColourPut

PropertiesFillColourGet
現 在 のオブジェクト の [オブジェクト のプロパティ] ダイアログ ボックスの [塗 り込 み | 色 ] タブで、
設 定 されている値 を読 み込 みます。

290
 Chapter: 6 グラフィックス ビルダー オートメーション インターフェース

シンタックス
PropertiesFillColourGet(FillColourType, ExpressionA, ExpressionB, ExpressionC,
ExpressionD, ExpressionE, RangeFlag, RangeMin, RangeMax)
FillColourType:

塗 り込 み色 のタイプです。
l 0 = オン/オフ
l 1 = マルチステート
l 2 = 配列
l 3 = 限界値
l 4 = 階調度
ExpressionA:

これが主 な式 です。
l タイプ [オン/オフ] の [オン カラーの条 件 ]。
l タイプ [マルチステート ] の条 件 A。
l タイプ [配 列 ] の配 列 条 件 。
l タイプ [動 画 化 ] の色 の定 義 式 。
ExpressionB:

条 件 B。マルチステート のシンボル セット にのみ使 用 されます。

ExpressionC:

条 件 C。マルチステート のシンボル セット にのみ使 用 されます。

ExpressionD:

条 件 D。マルチステート のシンボル セット にのみ使 用 されます。

ExpressionE:

条 件 E。マルチステート のシンボル セット にのみ使 用 されます。

RangeFlag:

真 (TRUE) に設 定 されている場 合 、[範 囲 の指 定 ] チェックボックスがオンになります。フラグは [限 界 値 ]

タイプと [階 調 度 ] タイプでのみ有 効 です。

RangeMin:

この浮 動 小 数 点 の値 は、タグ値 の最 小 値 を設 定 します。引 数 RangeFlag が真 (TRUE) に設 定 されて

いる場 合 にのみ必 要 です。

RangeMax:

291
Chapter: 6 グラフィックス ビルダー オートメーション インターフェース

この浮 動 小 数 点 の値 は、タグ値 の最 大 値 を設 定 します。引 数 RangeFlag が真 (TRUE) に設 定 されて

いる場 合 にのみ必 要 です。

戻 り値
要 求 された値 (文 字 列 )。

注 :戻 り値 とエラー値 の処 理 の詳 細 については、エラー処 理 を参 照 してください。

関連項目
PropertiesFillColourPut, PropertiesFillColourColourGet, PropertiesFillColourColourPut

PropertiesFillColourPut
現 在 のオブジェクト の [オブジェクト のプロパティ] ダイアログ ボックスの [塗 り込 み | 色 ] タブで、
値 を設 定 します。

シンタックス
PropertiesFillColourPut(FillColourType, ExpressionA, ExpressionB, ExpressionC,
ExpressionD, ExpressionE, RangeFlag, RangeMin, RangeMax)
FillColourType:

塗 り込 み色 のタイプです。
l 0 = オン/オフ
l 1 = マルチステート
l 2 = 配列
l 3 = 限界値
l 4 = 階調度
ExpressionA:

これが主 な式 です。
l タイプ [オン/オフ] の [オン カラーの条 件 ]。
l タイプ [マルチステート ] の条 件 A。
l タイプ [配 列 ] の配 列 条 件 。
l タイプ [動 画 化 ] の色 の定 義 式 。
ExpressionB:

条 件 B。マルチステート のシンボル セット にのみ使 用 されます。

ExpressionC:

条 件 C。マルチステート のシンボル セット にのみ使 用 されます。

292
 Chapter: 6 グラフィックス ビルダー オートメーション インターフェース

ExpressionD:

条 件 D。マルチステート のシンボル セット にのみ使 用 されます。

ExpressionE:

条 件 E。マルチステート のシンボル セット にのみ使 用 されます。

RangeFlag:

真 (TRUE) に設 定 されている場 合 、[範 囲 の指 定 ] チェックボックスがオンになります。フラグは [限 界 値 ]

タイプと [階 調 度 ] タイプでのみ有 効 です。

RangeMin:

この浮 動 小 数 点 の値 は、タグ値 の最 小 値 を設 定 します。引 数 RangeFlag が真 (TRUE) に設 定 されて

いる場 合 にのみ必 要 です。

RangeMax:

この浮 動 小 数 点 の値 は、タグ値 の最 大 値 を設 定 します。引 数 RangeFlag が真 (TRUE) に設 定 されて

いる場 合 にのみ必 要 です。

戻 り値
関 数 が正 常 に実 行 された場 合 は0 (ゼロ) が、それ以 外 の場 合 はエラーが返 されます。

注 :戻 り値 とエラー値 の処 理 の詳 細 については、エラー処 理 を参 照 してください。

関連項目
PropertiesFillColourGet, PropertiesFillColourColourGet, PropertiesFillColourColourPut

PropertiesFillLevelGet
現 在 のオブジェクト の [オブジェクト のプロパティ] ダイアログ ボックスの [塗 り込 み |レベル] タブ
で、設 定 されている値 を読 み込 みます。

注 :この関 数 では True Color 機 能 がサポート されていないため、関 数

PropertiesFillLevelGetEx に置 き換 えられました。

シンタックス
PropertiesFillLevelGet(Expression, RangeFlag, RangeMin, RangeMax, OffsetMin, OffsetMax,
FillDirection, BackgroundColour)
式:

レベルの定 義 式

293
Chapter: 6 グラフィックス ビルダー オートメーション インターフェース

RangeFlag:

[範 囲 の指 定 ] チェックボックスがオンの場 合 、真 (TRUE) になります。

RangeMin:

タグの範 囲 で、最 小 の浮 動 小 数 点 の値 。この引 数 が有 効 なのは、RangeFlag が真 (TRUE) に設 定 さ

れている場 合 のみです。

RangeMax:

タグの範 囲 で、浮 動 小 数 点 の最 大 値 。この引 数 が有 効 なのは、RangeFlag が真 (TRUE) に設 定 され

ている場 合 のみです。

OffsetMin:

タグ値 が最 小 の場 合 に、塗 りこみ表 示 領 域 の割 合 を表 す、0 ～ 100 の値 。

OffsetMax:

タグ値 が最 大 の場 合 に、塗 りこみ表 示 エリアの割 合 を表 す、0 ～ 100 の値 。

FillDirection:

現 在 の塗 り込 みの方 向 の設 定 。
l 0 = 上へ
l 1 = 下へ
l 2=左
l 3=右
BackgroundColour:

背 景 色 を示 す 0 ～ 255 の値 。

戻 り値
要 求 された値 (文 字 列 )。

注 :戻 り値 とエラー値 の処 理 の詳 細 については、エラー処 理 を参 照 してください。

関連項目
PropertiesFillColourPut

PropertiesFillLevelGetEx
現 在 のオブジェクト の [オブジェクト のプロパティ] ダイアログ ボックスの [塗 り込 み |レベル] タブ
で、設 定 されている値 を読 み込 みます。

294
 Chapter: 6 グラフィックス ビルダー オートメーション インターフェース

シンタックス
PropertiesFillLevelGetEx(式 , RangeFlag, RangeMin, RangeMax, OffsetMin, OffsetMax,
FillDirection, OnColour, OffColour)
式:

レベルの定 義 式

RangeFlag:

[範 囲 の指 定 ] チェックボックスがオンの場 合 、真 (TRUE) になります。

RangeMin:

タグの範 囲 で、最 小 の浮 動 小 数 点 の値 。この引 数 が有 効 なのは、RangeFlag が真 (TRUE) に設 定 さ

れている場 合 のみです。

RangeMax:

タグの範 囲 で、浮 動 小 数 点 の最 大 値 。この引 数 が有 効 なのは、RangeFlag が真 (TRUE) に設 定 され

ている場 合 のみです。

OffsetMin:

タグ値 が最 小 の場 合 に、塗 りこみ表 示 領 域 の割 合 を表 す、0 ～ 100 の値 。

OffsetMax:

タグ値 が最 大 の場 合 に、塗 りこみ表 示 エリアの割 合 を表 す、0 ～ 100 の値 。

FillDirection:

現 在 の塗 り込 みの方 向 の設 定 。
l 0 = 上へ
l 1 = 下へ
l 2=左
l 3=右
OnColour:

オンの場 合 のバックグラウンド色 を示 す RGB 値 。

OffColour:

オフの場 合 のバックグラウンド色 を示 す RGB 値 。

戻 り値
要 求 された値 (文 字 列 )。

注 :戻 り値 とエラー値 の処 理 の詳 細 については、エラー処 理 を参 照 してください。

295
Chapter: 6 グラフィックス ビルダー オートメーション インターフェース

関連項目
PropertiesFillColourPut

PropertiesFillLevelPut
現 在 のオブジェクト の [オブジェクト のプロパティ] ダイアログ ボックスの [塗 り込 み | レベル] タブ
で、値 を設 定 します。

注 :この関 数 では True Color 機 能 がサポート されていないため、関 数

PropertiesFillLevelPutEx に置 き換 えられました。

シンタックス
PropertiesFillLevelPut(式 , RangeFlag, RangeMin, RangeMax, OffsetMin, OffsetMax,
FillDirection, BackgroundColour)
式:

レベルの定 義 式

RangeFlag:

[範 囲 の指 定 ] チェックボックスがオンの場 合 、真 (TRUE) になります。

RangeMin:

タグの範 囲 で、最 小 の浮 動 小 数 点 の値 。この引 数 が有 効 なのは、RangeFlag が真 (TRUE) に設 定 さ

れている場 合 のみです。

RangeMax:

タグの範 囲 で、浮 動 小 数 点 の最 大 値 。この引 数 が有 効 なのは、RangeFlag が真 (TRUE) に設 定 され

ている場 合 のみです。

OffsetMin:

タグ値 が最 小 の場 合 に、塗 りこみ表 示 領 域 の割 合 を表 す、0 ～ 100 の値 。

OffsetMax:

タグ値 が最 大 の場 合 に、塗 りこみ表 示 エリアの割 合 を表 す、0 ～ 100 の値 。

FillDirection:

現 在 の塗 り込 みの方 向 の設 定 。
l 0 = 上へ
l 1 = 下へ
l 2=左
l 3=右

296
 Chapter: 6 グラフィックス ビルダー オートメーション インターフェース

BackgroundColour:

背 景 色 を示 す 0 ～ 255 の値 。

戻 り値
関 数 が正 常 に実 行 された場 合 は0 (ゼロ) が、それ以 外 の場 合 はエラーが返 されます。

注 :戻 り値 とエラー値 の処 理 の詳 細 については、エラー処 理 を参 照 してください。

関連項目
PropertiesFillLevelPutEx,PropertiesFillLevelGet

PropertiesFillLevelPutEx
現 在 のオブジェクト の [オブジェクト のプロパティ] ダイアログ ボックスの [塗 り込 み | レベル] タブ
で、値 を設 定 します。

シンタックス
PropertiesFillLevelPutEx(式 , RangeFlag, RangeMin, RangeMax, OffsetMin, OffsetMax,
FillDirection, OnColour, OffColour)
式:

レベルの定 義 式

RangeFlag:

[範 囲 の指 定 ] チェックボックスがオンの場 合 、真 (TRUE) になります。

RangeMin:

タグの範 囲 で、最 小 の浮 動 小 数 点 の値 。この引 数 が有 効 なのは、RangeFlag が真 (TRUE) に設 定 さ

れている場 合 のみです。

RangeMax:

タグの範 囲 で、浮 動 小 数 点 の最 大 値 。この引 数 が有 効 なのは、RangeFlag が真 (TRUE) に設 定 され

ている場 合 のみです。

OffsetMin:

タグ値 が最 小 の場 合 に、塗 りこみ表 示 領 域 の割 合 を表 す、0 ～ 100 の値 。

OffsetMax:

タグ値 が最 大 の場 合 に、塗 りこみ表 示 エリアの割 合 を表 す、0 ～ 100 の値 。

FillDirection:

現 在 の塗 り込 みの方 向 の設 定 。

297
Chapter: 6 グラフィックス ビルダー オートメーション インターフェース

l 0 = 上へ
l 1 = 下へ
l 2=左
l 3=右
OnColour:

オンの場 合 のバックグラウンド色 を示 す RGB 値 。

OffColour:

オフの場 合 のバックグラウンド色 を示 す RGB 値 。

戻 り値
関 数 が正 常 に実 行 された場 合 は0 (ゼロ) が、それ以 外 の場 合 はエラーが返 されます。

注 :戻 り値 とエラー値 の処 理 の詳 細 については、エラー処 理 を参 照 してください。

関連項目
PropertiesFillLevelGetEx

PropertiesInputKeyboardGet
現 在 のオブジェクト の [オブジェクト のプロパティ] ダイアログ ボックスの [入 力 | キーボード コマン
ド ] タブで、設 定 されている値 を読 み込 みます。

シンタックス
PropertiesInputKeyboardGet(Index, KeySequence, Command, Area, Privilege, LogMessage)
Index:

キー シーケンスを示 す0 ～ 255の値 。

KeySequence:

入 力 するキーの文 字 列 。

コマンド :

キー シーケンス コマンドの式 。

Area:

エリアを示 す0 ～ 255の値 。0の場 合 、[オブジェクト と同 じエリア] チェックボックスはオンになります。

Privilege:

権 限 を示 す0 ～ 255の値 。0の場 合 、[オブジェクト と同 じエリア] チェックボックスはオンになります。

298
 Chapter: 6 グラフィックス ビルダー オートメーション インターフェース

LogMessage:

ログに記 録 するメッセージ テキスト 。

戻 り値
要 求 された値 (文 字 列 )。

注 :戻 り値 とエラー値 の処 理 の詳 細 については、エラー処 理 を参 照 してください。

関連項目
PropertiesInputKeyboardPut

PropertiesInputKeyboardPut
現 在 のオブジェクト の [オブジェクト のプロパティ] ダイアログ ボックスの [入 力 | キーボード コマン
ド ] タブで、値 を設 定 します。

シンタックス
PropertiesInputKeyboardPut(Index, KeySequence, Command, Area, Privilege, LogMessage)
Index:

キー シーケンスを示 す0 ～ 255の値 。

KeySequence:

入 力 するキーの文 字 列 。

コマンド :

キー シーケンス コマンドの式 。

Area:

エリアを示 す0 ～ 255の値 。0の場 合 、[オブジェクト と同 じエリア] チェックボックスはオンになります。

Privilege:

権 限 を示 す0 ～ 255の値 。0の場 合 、[オブジェクト と同 じエリア] チェックボックスはオンになります。

LogMessage:

ログに記 録 するメッセージ テキスト 。

戻 り値
関 数 が正 常 に実 行 された場 合 は0 (ゼロ) が、それ以 外 の場 合 はエラーが返 されます。

299
Chapter: 6 グラフィックス ビルダー オートメーション インターフェース

注 :戻 り値 とエラー値 の処 理 の詳 細 については、エラー処 理 を参 照 してください。

関連項目
PropertiesInputKeyboardGet

PropertiesInputTouchGet
現 在 のオブジェクト の [オブジェクト のプロパティ] ダイアログ ボックスの [入 力 | タッチ] タブで、設
定 されている値 を読 み込 みます。

シンタックス
PropertiesInputTouchGet(Action, 式 , LogMessage, RepeatRate)
Action:

キーボード アクションの種 類 です。

l 0 = 上へ
l 1 = 下へ
l 2 = 繰 り返 し
式:

選 択 されたキーボード動 作 (上 へ、下 へ、または繰 り返 し) に対 して設 定 されている式 。

LogMessage:

ログに記 録 するメッセージ テキスト 。

RepeatRate:

繰 り返 しの速 度 をミリ秒 で示 す、1 ～ 32000 の値 。

戻 り値
要 求 された値 (文 字 列 )。

注 :戻 り値 とエラー値 の処 理 の詳 細 については、エラー処 理 を参 照 してください。

関連項目
PropertiesInputTouchPut

300
 Chapter: 6 グラフィックス ビルダー オートメーション インターフェース

PropertiesInputTouchPut
現 在 のオブジェクト の [オブジェクト のプロパティ] ダイアログ ボックスの [入 力 | タッチ] タブで、値
を設 定 します。

シンタックス
PropertiesInputTouchPut(Action, 式 , LogMessage, RepeatRate)
Action:

キーボード アクションの種 類 です。

l 0 = 上へ
l 1 = 下へ
l 2 = 繰 り返 し
式:

選 択 されたキーボード動 作 (上 へ、下 へ、または繰 り返 し) に対 して設 定 されている式 。

LogMessage:

ログに記 録 するメッセージ テキスト 。

RepeatRate:

繰 り返 しの速 度 をミリ秒 で示 す、1 ～ 32000 の値 。

戻 り値
関 数 が正 常 に実 行 された場 合 は0 (ゼロ) が、それ以 外 の場 合 はエラーが返 されます。

注 :戻 り値 とエラー値 の処 理 の詳 細 については、エラー処 理 を参 照 してください。

関連項目
PropertiesInputTouchGet

PropertiesShowDialog
オブジェクト のプロパティ ダイアログ ボックス、またはジニーのフォームを表 示 します。

シンタックス
PropertiesShowDialog

301
Chapter: 6 グラフィックス ビルダー オートメーション インターフェース

戻 り値
関 数 が正 常 に実 行 された場 合 は0 (ゼロ) が、それ以 外 の場 合 はエラーが返 されます。

注 :戻 り値 とエラー値 の処 理 の詳 細 については、エラー処 理 を参 照 してください。

PropertiesSymbolSetGet
シンボル セット の [オブジェクト のプロパティ] ダイアログ ボックスの [表 示 | 全 般 ] タブで設 定 され
ているタイプと式 を読 み込 みます。

シンタックス
PropertiesSymbolSetGet(SymbolSetType, ExpressionA, ExpressionB, ExpressionC,
ExpressionD, ExpressionE)
SymbolSetType:

シンボル セット のタイプを定 義 します。

l 0 = オン/オフ
l 1 = マルチステート
l 2 = 配列
l 3 = 動画化
ExpressionA:

これが主 な式 です。
l タイプ [オン/オフ] の [オン シンボルの条 件 ]。
l タイプ [マルチステート ] の条 件 A。
l タイプ [配 列 ] の配 列 条 件 。
l タイプ [動 画 化 ] の動 画 する条 件 。
ExpressionB:

条 件 B。マルチステート のシンボル セット にのみ使 用 されます。

ExpressionC:

条 件 C。マルチステート のシンボル セット にのみ使 用 されます。

ExpressionD:

条 件 D。マルチステート のシンボル セット にのみ使 用 されます。

ExpressionE:

条 件 E。マルチステート のシンボル セット にのみ使 用 されます。

302
 Chapter: 6 グラフィックス ビルダー オートメーション インターフェース

戻 り値
要 求 された値 (文 字 列 )。

注 :戻 り値 とエラー値 の処 理 の詳 細 については、エラー処 理 を参 照 してください。

関連項目
PropertiesSymbolSetPut

` Gets the properties on the Appearance/General sheet for a symbol set

GraphicsBuilder.PropertiesSymbolSetGet nType, Expression1, Expression2, Expression3,
Expression4, Expression5

PropertiesSymbolSetPut
[オブジェクト のプロパティ] ダイアログ ボックスの [表 示 | 全 般 ] タブでシンボル セット に対 して定
義 されているタイプと、使 用 されるすべての式 を設 定 します。

シンタックス
PropertiesSymbolSetPut(SymbolSetType, ExpressionA, ExpressionB, ExpressionC,
ExpressionD, ExpressionE)
SymbolSetType:

シンボル セット のタイプを定 義 します。

l 0 = オン/オフ
l 1 = マルチステート
l 2 = 配列
l 3 = 動画化
ExpressionA:

これが主 な式 です。
l タイプ [オン/オフ] の [オン シンボルの条 件 ]。
l タイプ [マルチステート ] の条 件 A。
l タイプ [配 列 ] の配 列 条 件 。
l タイプ [動 画 化 ] の動 画 する条 件 。
ExpressionB:

303
Chapter: 6 グラフィックス ビルダー オートメーション インターフェース

条 件 B。マルチステート のシンボル セット にのみ使 用 されます。

ExpressionC:

条 件 C。マルチステート のシンボル セット にのみ使 用 されます。

ExpressionD:

条 件 D。マルチステート のシンボル セット にのみ使 用 されます。

ExpressionE:

条 件 E。マルチステート のシンボル セット にのみ使 用 されます。

戻 り値
関 数 が正 常 に実 行 された場 合 は0 (ゼロ) が、それ以 外 の場 合 はエラーが返 されます。

注 :戻 り値 とエラー値 の処 理 の詳 細 については、エラー処 理 を参 照 してください。

関連項目
PropertiesSymbolSetGet

` Sets the properties on the Appearance General sheet for a symbol set
GraphicsBuilder.PropertiesSymbolSetPut 0, "ON / OFF", "", "", "", ""

PropertiesSymbolSetSymbolGet
現 在 選 択 されてるオブジェクト の「インデックス」要 素 の要 素 名 とライブラリ名 を取 得 します。
「インデックス」は現 在 選 択 しているオブジェクト 内 の要 素 を参 照 します。例 :
l 現 在 選 択 しているオブジェクト がオン/オフ シンボル セット である場 合 、インデックスは 0 ～ 1
の値 を取 れます。
l 現 在 選 択 しているオブジェクト がマルチステート シンボル セット である場 合 、インデックスは 0
～ 31 の値 を取 れます。
l 現 在 選 択 しているオブジェクト が配 列 シンボル セット である場 合 、インデックスは 0 ～ 255
の値 を取 れます。
l 現 在 選 択 しているオブジェクト がアニメーション シンボル セット である場 合 、インデックスは 0
～ 255 の値 を取 れます。

304
 Chapter: 6 グラフィックス ビルダー オートメーション インターフェース

l 戻 り時 に、「要 素 」には「インデックス」要 素 のシンボル セット 要 素 名 の名 前 が含 まれること

になります。
l 戻 り時 に、「ライブラリ」には「インデックス」要 素 のシンボル セット ライブラリ名 の名 前 が含 ま
れることになります。
たとえば、次 のとおりです。
Index=0, Element="detail_entrycoil1_grey_01", Library="steelmill"
Index=1, Element="detail_entrycoil1_green_01", Library="steelmill"

シンタックス
PropertiesSymbolSetSymbolGet(Index, Library, Element)

戻 り値
該 当 なし

注 :戻 り値 とエラー値 の処 理 の詳 細 については、エラー処 理 を参 照 してください。

Public Sub Test()

Dim gb As GraphicsBuilder.GraphicsBuilder
.
.
.
gb.PropertiesSymbolSetSymbolPut(1, "
Library", "
Element")
Dim sLibrary As String
Dim sElement As String
gb.PropertiesSymbolSetSymbolGet(1, sLibrary, sElement)
End Sub

関連項目
PropertiesSymbolSetSymbolPut

PropertiesSymbolSetSymbolPut
現 在 選 択 されてるオブジェクト の「インデックス」要 素 の要 素 名 とライブラリ名 を設 定 します。
「インデックス」は現 在 選 択 しているオブジェクト 内 の要 素 を参 照 します。例 :
l 現 在 選 択 しているオブジェクト がオン/オフ シンボル セット である場 合 、インデックスは 0 ～ 1
の値 を取 れます。

305
Chapter: 6 グラフィックス ビルダー オートメーション インターフェース

l 現 在 選 択 しているオブジェクト がマルチステート シンボル セット である場 合 、インデックスは 0

～ 31 の値 を取 れます。
l 現 在 選 択 しているオブジェクト が配 列 シンボル セット である場 合 、インデックスは 0 ～ 255
の値 を取 れます。
l 現 在 選 択 しているオブジェクト がアニメーション シンボル セット である場 合 、インデックスは 0
～ 255 の値 を取 れます。
l 戻 り時 に、「要 素 」には「インデックス」要 素 のシンボル セット 要 素 名 の名 前 が含 まれること
になります。
l 戻 り時 に、「ライブラリ」には「インデックス」要 素 のシンボル セット ライブラリ名 の名 前 が含 ま
れることになります。
たとえば、次 のとおりです。
Index=0, Element="detail_entrycoil1_grey_01", Library="steelmill"
Index=1, Element="detail_entrycoil1_green_01", Library="steelmill"

シンタックス
PropertiesSymbolSetSymbolPut(Index, Library, Element)

戻 り値
該 当 なし

注 :戻 り値 とエラー値 の処 理 の詳 細 については、エラー処 理 を参 照 してください。

Public Sub Test()

Dim gb As GraphicsBuilder.GraphicsBuilder
.
.
.
gb.PropertiesSymbolSetSymbolPut(1, "
Library", "
Element")
Dim sLibrary As String
Dim sElement As String
gb.PropertiesSymbolSetSymbolGet(1, sLibrary, sElement)
End Sub

関連項目
PropertiesSymbolSetSymbolGet()

306
 Chapter: 6 グラフィックス ビルダー オートメーション インターフェース

PropertiesTransCentreOffsetExpressGet
エクスプレス プロパティを取 得 します。

シンタックス
PropertiesTransCentreOffsetExpressGet(movementRotationalExpress,scalingHorizontalEx-
press,scalingVerticalExpress,sliderRotationalExpress)
movementRotationalExpress - 移 動 回 転 の定 義 式
scalingHorizontalExpress - 水 平 スケール の定 義 式
scalingVerticalExpress - 垂 直 スケール の定 義 式
sliderRotationalExpress - スライダー回 転 の定 義 式

戻 り値
該 当 なし

注 :戻 り値 とエラー値 の処 理 の詳 細 については、エラー処 理 を参 照 してください。

Public Sub Test()

Dim gb As GraphicsBuilder.GraphicsBuilder
gb = New GraphicsBuilder.GraphicsBuilder
.
.
.
gb.PropertiesTransCentreOffsetExpressPut(0, 0, 0, 0)
Dim nMovRot As Short
Dim nScaleHorz As Short
Dim nScaleVert As Short
Dim nSliderRot As Short
gb.PropertiesTransCentreOffsetExpressGet(nMovRot, nScaleHorz, nScaleVert,
nSliderRot)
End Sub

関連項目
PropertiesTransCentreOffsetExpressPut

PropertiesTransCentreOffsetExpressPut
エクスプレス プロパティを設 定 します。

307
Chapter: 6 グラフィックス ビルダー オートメーション インターフェース

シンタックス
PropertiesTransCentreOffsetExpressPut(movementRotationalExpress,scalingHorizontalEx-
press,scalingVerticalExpress,sliderRotationalExpress)
movementRotationalExpress - 移 動 回 転 エクスプレス
scalingHorizontalExpress - 水 平 スケール エクスプレス
scalingVerticalExpress - 垂 直 スケール エクスプレス
sliderRotationalExpress - スライダー回 転 エクスプレス

戻 り値
該 当 なし

注 :戻 り値 とエラー値 の処 理 の詳 細 については、エラー処 理 を参 照 してください。

Public Sub Test()

Dim gb As GraphicsBuilder.GraphicsBuilder
gb = New GraphicsBuilder.GraphicsBuilder
.
.
.
gb.PropertiesTransCentreOffsetExpressPut(0, 0, 0, 0)
Dim nMovRot As Short
Dim nScaleHorz As Short
Dim nScaleVert As Short
Dim nSliderRot As Short
gb.PropertiesTransCentreOffsetExpressGet(nMovRot, nScaleHorz, nScaleVert,
nSliderRot)
End Sub

関連項目
PropertiesTransCentreOffsetExpressGet

PropertiesTransformationGet
PropertiesTransformationGet 現 在 のオブジェクト に対 し、[オブジェクト のプロパティ] ダイアログ
ボックスの [移 動 ]、[スケーリング]、および [スライダー] タブで設 定 されているプロパティ値 を読 み
込 みます。

308
 Chapter: 6 グラフィックス ビルダー オートメーション インターフェース

シンタックス
PropertiesTransformationGet(Action, 式 , RangeFlag, RangeMin, RangeMax, OffsetMin,
OffsetMax, CustomFlag, CentreOffsetRight, CentreOffsetDown)
Action:

データの読 み込 み元 となる [オブジェクト のプロパティ] ダイアログ ボックスのタブを選 択 します。

l 0 = MovementHorizontal (水 平 移 動 )
l 1 = MovementVertical (垂 直 移 動 )
l 2 = MovementRotational (回 転 性 移 動 )
l 3 = ScalingHorizontal (水 平 スケーリング)
l 4 = ScalingVertical (垂 直 スケーリング)
l 5 = SliderHorizontal (水 平 スライダー)
l 6 = SliderVertical (垂 直 スライダー)
l 7 = SliderRotational (回 転 性 スライダー)
式:

[フィールド] の主 な式 です。
l 動 作 MovementHorizontal または MovementVertical に対 する移 動 の定 義
式。
l 動 作 MovementRotational に対 する角 度 の定 義 式 。
l 動 作 ScalingHorizontal または ScalingVertical に対 するスケーリングの定 義
式。
l 動 作 SliderHorizontal、SliderVertical、または SliderRotational に対 するタグ。
RangeFlag:

[範 囲 の指 定 ] がオンの場 合 に真 (TRUE)。

RangeMin:

最 小 の浮 動 小 数 点 の値 。RangeFlag が設 定 されていない場 合 は 0 (ゼロ) です。

RangeMax:

最 大 の浮 動 小 数 点 の値 。RangeFlag が真 (TRUE) に設 定 されている場 合 は 0 (ゼロ) です。

OffsetMin:

動 作 MovementRotational および SliderRotational に対 する最 小 時 の角 度 の値 、またはその他 のすべ

ての動 作 に対 する 最 小 時 のオフセット の値 。

OffsetMax:

動 作 MovementRotational および SliderRotational に対 する最 大 時 の角 度 の値 、またはその他 のすべ

ての動 作 に対 する 最 大 時 のオフセット の値 。

CustomFlag:

309
Chapter: 6 グラフィックス ビルダー オートメーション インターフェース

動 作 MovementRotational、SliderRotational、Scaling Horizontal、または ScalingVertical に対 し、中

心 軸 のオフセット が [カスタム] に設 定 されている場 合 に真 (TRUE)。

CentreOffsetRight:

中 心 の右 側 へのオフセット のカスタム設 定 を示 す、0 ～ 32767 の値 。CustomFlag が設 定 されていない

場 合 は 0 (ゼロ) です。

CentreOffsetDown:

中 心 の右 側 へのオフセット のカスタム設 定 を示 す、0 ～ 32767 の値 。CustomFlag が設 定 されていない

場 合 は 0 (ゼロ) です。

戻 り値
要 求 された値 (文 字 列 )。

注 :戻 り値 とエラー値 の処 理 の詳 細 については、エラー処 理 を参 照 してください。

関連項目
PropertiesTransformationPut

PropertiesTransformationPut
[オブジェクト のプロパティ] ダイアログ ボックスの [移 動 ]、[スケーリング]、および [スライダー] の各
タブで、プロパティの値 を設 定 します。

シンタックス
PropertiesTransformationGet(Action, 式 , RangeFlag, RangeMin, RangeMax, OffsetMin,
OffsetMax, CustomFlag, CentreOffsetRight, CentreOffsetDown)
Action:

データの読 み込 み元 となる [オブジェクト のプロパティ] ダイアログ ボックスのタブを選 択 します。

l 0 = MovementHorizontal (水 平 移 動 )
l 1 = MovementVertical (垂 直 移 動 )
l 2 = MovementRotational (回 転 性 移 動 )
l 3 = ScalingHorizontal (水 平 スケーリング)
l 4 = ScalingVertical (垂 直 スケーリング)
l 5 = SliderHorizontal (水 平 スライダー)
l 6 = SliderVertical (垂 直 スライダー)
l 7 = SliderRotational (回 転 性 スライダー)
式:

310
 Chapter: 6 グラフィックス ビルダー オートメーション インターフェース

[フィールド] の主 な式 です。
l 動 作 MovementHorizontal または MovementVertical に対 する移 動 の定 義
式。
l 動 作 MovementRotational に対 する角 度 の定 義 式 。
l 動 作 ScalingHorizontal または ScalingVertical に対 するスケーリングの定 義
式。
l 動 作 SliderHorizontal、SliderVertical、または SliderRotational に対 するタグ。
RangeFlag:

[範 囲 の指 定 ] がオンの場 合 に真 (TRUE)。

RangeMin:

最 小 の浮 動 小 数 点 の値 。RangeFlag が設 定 されていない場 合 は 0 (ゼロ) です。

RangeMax:

最 大 の浮 動 小 数 点 の値 。RangeFlag が真 (TRUE) に設 定 されている場 合 は 0 (ゼロ) です。

OffsetMin:

動 作 MovementRotational および SliderRotational に対 する最 小 時 の角 度 の値 、またはその他 のすべ

ての動 作 に対 する 最 小 時 のオフセット の値 。

OffsetMax:

動 作 MovementRotational および SliderRotational に対 する最 大 時 の角 度 の値 、またはその他 のすべ

ての動 作 に対 する 最 大 時 のオフセット の値 。

CustomFlag:

動 作 MovementRotational、SliderRotational、Scaling Horizontal、または ScalingVertical に対 し、中

心 軸 のオフセット が [カスタム] に設 定 されている場 合 に真 (TRUE)。

CentreOffsetRight:

中 心 の右 側 へのオフセット のカスタム設 定 を示 す、0 ～ 32767 の値 。CustomFlag が設 定 されていない

場 合 は 0 (ゼロ) です。

CentreOffsetDown:

中 心 の右 側 へのオフセット のカスタム設 定 を示 す、0 ～ 32767 の値 。CustomFlag が設 定 されていない

場 合 は 0 (ゼロ) です。

戻 り値
要 求 された値 (文 字 列 )。

注 :戻 り値 とエラー値 の処 理 の詳 細 については、エラー処 理 を参 照 してください。

311
Chapter: 6 グラフィックス ビルダー オートメーション インターフェース

関連項目
PropertiesTransformationGet

PropertiesTrendGet
[オブジェクト のプロパティ] ダイアログ ボックスの [表 示 | 全 般 ] タブで設 定 されている、ト レンド
オブジェクト の値 を読 み込 みます。

注 :この関 数 では True Color 機 能 がサポート されていないため、関 数

PropertiesTrendGetEx に置 き換 えられました。

シンタックス
PropertiesTrendGet(NumberOfSamples, PixelPerSample, Expression1, Colour1, Expression2,
Colour2, Expression3, Colour3, Expression4, Colour4, Expression5, Colour5, Expression6,
Colour6, Expression7, Colour7, Expression8, Colour8)
NumberOfSamples:

ト レンド ディスプレイのサンプル数 を表 す、0 ～ 32767の値 。

PixelPerSample:

各 サンプルの幅 をピクセル数 で表 す、1 ～ 32の値 。

Expression1:

[ペン 1] フィールドの文 字 列 引 数 。

Colour1:

ト レンド [ペン 1] の色 を示 す0 ～ 255の値 。

Expression2:

[ペン 2] フィールドの文 字 列 引 数 。

Colour2:

ト レンド [ペン 2] の色 を示 す0 ～ 255の値 。

Expression3:

[ペン 3] フィールドの文 字 列 引 数 。

Colour3:

ト レンド [ペン 3] の色 を示 す0 ～ 255の値 。

Expression4:

[ペン 4] フィールドの文 字 列 引 数 。

312
 Chapter: 6 グラフィックス ビルダー オートメーション インターフェース

Colour4:

ト レンド [ペン 4] の色 を示 す0 ～ 255の値 。

Expression5:

[ペン 5] フィールドの文 字 列 引 数 。

Colour5:

ト レンド [ペン 5] の色 を示 す0 ～ 255の値 。

Expression6:

[ペン 6] フィールドの文 字 列 引 数 。

Colour6:

ト レンド [ペン 6] の色 を示 す0 ～ 255の値 。

Expression7:

[ペン 7] フィールドの文 字 列 引 数 。

Colour7:

ト レンド [ペン 7] の色 を示 す0 ～ 255の値 。

Expression8:

[ペン 8] フィールドの文 字 列 引 数 。

Colour8:

ト レンド [ペン 8] の色 を示 す0 ～ 255の値 。

戻 り値
要 求 された値 (文 字 列 )。

注 :戻 り値 とエラー値 の処 理 の詳 細 については、エラー処 理 を参 照 してください。

関連項目
PropertiesTrendPut

PropertiesTrendGetEx
[オブジェクト のプロパティ] ダイアログ ボックスの [表 示 | 全 般 ] タブで設 定 されている、ト レンド
オブジェクト の値 を読 み込 みます。

313
Chapter: 6 グラフィックス ビルダー オートメーション インターフェース

シンタックス
PropertiesTrendGetEx(NumberOfSamples, PixelPerSample, Expression1, OnColour1,
OffColour1, Expression2, OnColour2, OffColour2, Expression3, OnColour3, OffColour3,
Expression4, OnColour4, OffColour4, Expression5, OnColour5, OffColour5, Expression6,
OnColour6, OffColour6, Expression7, OnColour7, OffColour7, Expression8, OnColour8,
OffColour8)
NumberOfSamples:

ト レンド ディスプレイのサンプル数 を表 す、0 ～ 32767の値 。

PixelPerSample:

各 サンプルの幅 をピクセル数 で表 す、1 ～ 32の値 。

Expression1:

[ペン 1] フィールドの文 字 列 引 数 。

OnColour1:

ト レンド [ペン 1] のオンの場 合 の色 を示 すRGB値 。

OffColour1:

ト レンド [ペン 1] のオフの場 合 の色 を示 すRGB値 。

Expression2:

[ペン 2] フィールドの文 字 列 引 数 。

OnColour2:

ト レンド [ペン 2] のオンの場 合 の色 を示 すRGB値 。

OffColour2:

ト レンド [ペン 2] のオフの場 合 の色 を示 すRGB値 。

Expression3:

[ペン 3] フィールドの文 字 列 引 数 。

OnColour3:

ト レンド [ペン 3] のオンの場 合 の色 を示 すRGB値 。

OffColour3:

ト レンド [ペン 3] のオフの場 合 の色 を示 すRGB値 。

Expression4:

[ペン 4] フィールドの文 字 列 引 数 。

314
 Chapter: 6 グラフィックス ビルダー オートメーション インターフェース

OnColour4:

ト レンド [ペン 4] のオンの場 合 の色 を示 すRGB値 。

OffColour4:

ト レンド [ペン 4] のオフの場 合 の色 を示 すRGB値 。

Expression5:

[ペン 5] フィールドの文 字 列 引 数 。

OnColour5:

ト レンド [ペン 5] のオンの場 合 の色 を示 すRGB値 。

OffColour5:

ト レンド [ペン 5] のオフの場 合 の色 を示 すRGB値 。

Expression6:

[ペン 6] フィールドの文 字 列 引 数 。

OnColour6:

ト レンド [ペン 6] のオンの場 合 の色 を示 すRGB値 。

OffColour6:

ト レンド [ペン 6] のオフの場 合 の色 を示 すRGB値 。

Expression7:

[ペン 7] フィールドの文 字 列 引 数 。

OnColour7:

ト レンド [ペン 7] のオンの場 合 の色 を示 すRGB値 。

OffColour７:

ト レンド [ペン 7] のオフの場 合 の色 を示 すRGB値 。

Expression8:

[ペン 8] フィールドの文 字 列 引 数 。

OnColour8:

ト レンド [ペン 8] のオンの場 合 の色 を示 すRGB値 。

OffColour8:

ト レンド [ペン 8] のオフの場 合 の色 を示 すRGB値 。

315
Chapter: 6 グラフィックス ビルダー オートメーション インターフェース

戻 り値
要 求 された値 (文 字 列 )。

注 :戻 り値 とエラー値 の処 理 の詳 細 については、エラー処 理 を参 照 してください。

関連項目
PropertiesTrendPutEx

PropertiesTrendPut
[オブジェクト のプロパティ] ダイアログ ボックスの [表 示 | 全 般 ] タブに表 示 される、ト レンド オブ
ジェクト の値 を設 定 します。

注 :この関 数 では True Color 機 能 がサポート されていないため、関 数

PropertiesTrendPutEx に置 き換 えられました。

シンタックス
PropertiesTrendGet(NumberOfSamples, PixelPerSample, Expression1, Colour1, Expression2,
Colour2, Expression3, Colour3, Expression4, Colour4, Expression5, Colour5, Expression6,
Colour6, Expression7, Colour7, Expression8, Colour8)
NumberOfSamples:

ト レンド ディスプレイのサンプル数 を表 す、0 ～ 32767の値 。

PixelPerSample:

各 サンプルの幅 をピクセル数 で表 す、1 ～ 32の値 。

Expression1:

[ペン 1] フィールドの文 字 列 引 数 。

Colour1:

ト レンド [ペン 1] の色 を示 す0 ～ 255の値 。

Expression2:

[ペン 2] フィールドの文 字 列 引 数 。

Colour2:

ト レンド [ペン 2] の色 を示 す0 ～ 255の値 。

Expression3:

[ペン 3] フィールドの文 字 列 引 数 。

316
 Chapter: 6 グラフィックス ビルダー オートメーション インターフェース

Colour3:

ト レンド [ペン 3] の色 を示 す0 ～ 255の値 。

Expression4:

[ペン 4] フィールドの文 字 列 引 数 。

Colour4:

ト レンド [ペン 4] の色 を示 す0 ～ 255の値 。

Expression5:

[ペン 5] フィールドの文 字 列 引 数 。

Colour5:

ト レンド [ペン 5] の色 を示 す0 ～ 255の値 。

Expression6:

[ペン 6] フィールドの文 字 列 引 数 。

Colour6:

ト レンド [ペン 6] の色 を示 す0 ～ 255の値 。

Expression7:

[ペン 7] フィールドの文 字 列 引 数 。

Colour7:

ト レンド [ペン 7] の色 を示 す0 ～ 255の値 。

Expression8:

[ペン 8] フィールドの文 字 列 引 数 。

Colour8:

ト レンド [ペン 8] の色 を示 す0 ～ 255の値 。

戻 り値
関 数 が正 常 に実 行 された場 合 は0 (ゼロ) が、それ以 外 の場 合 はエラーが返 されます。

注 :戻 り値 とエラー値 の処 理 の詳 細 については、エラー処 理 を参 照 してください。

関連項目
PropertiesTrendGet

PropertiesTrendPutEx

317
Chapter: 6 グラフィックス ビルダー オートメーション インターフェース

[オブジェクト のプロパティ] ダイアログ ボックスの [表 示 | 全 般 ] タブに表 示 される、ト レンド オブ

ジェクト の値 を設 定 します。

シンタックス
PropertiesTrendPutEx(NumberOfSamples, PixelPerSample, Expression1, OnColour1,
OffColour1, Expression2, OnColour2, OffColour2 , Expression3, OnColour3, OffColour3 ,
Expression4, OnColour4, OffColour4 , Expression5, OnColour5, OffColour5, Expression6,
OnColour6, OffColour6 , Expression7, OnColour7, OffColour7, Expression8, OnColour8,
OffColour8, )
NumberOfSamples:

ト レンド ディスプレイのサンプル数 を表 す、0 ～ 32767の値 。

PixelPerSample:

各 サンプルの幅 をピクセル数 で表 す、1 ～ 32の値 。

Expression1:

[ペン 1] フィールドの文 字 列 引 数 。

OnColour1:

ト レンド [ペン 1] のオンの場 合 の色 を示 すRGB値 。

OffColour1:

ト レンド [ペン 1] のオフの場 合 の色 を示 すRGB値 。

Expression2:

[ペン 2] フィールドの文 字 列 引 数 。

OnColour2:

ト レンド [ペン 2] のオンの場 合 の色 を示 すRGB値 。

OffColour2:

ト レンド [ペン 2] のオフの場 合 の色 を示 すRGB値 。

Expression3:

[ペン 3] フィールドの文 字 列 引 数 。

OnColour3:

ト レンド [ペン 3] のオンの場 合 の色 を示 すRGB値 。

OffColour3:

ト レンド [ペン 3] のオフの場 合 の色 を示 すRGB値 。

Expression4:

318
 Chapter: 6 グラフィックス ビルダー オートメーション インターフェース

[ペン 4] フィールドの文 字 列 引 数 。

OnColour4:

ト レンド [ペン 4] のオンの場 合 の色 を示 すRGB値 。

OffColour4:

ト レンド [ペン 4] のオフの場 合 の色 を示 すRGB値 。

Expression5:

[ペン 5] フィールドの文 字 列 引 数 。

OnColour5:

ト レンド [ペン 5] のオンの場 合 の色 を示 すRGB値 。

OffColour5:

ト レンド [ペン 5] のオフの場 合 の色 を示 すRGB値 。

Expression6:

[ペン 6] フィールドの文 字 列 引 数 。

OnColour6:

ト レンド [ペン 6] のオンの場 合 の色 を示 すRGB値 。

OffColour6:

ト レンド [ペン 6] のオフの場 合 の色 を示 すRGB値 。

Expression7:

[ペン 7] フィールドの文 字 列 引 数 。

OnColour7:

ト レンド [ペン 7] のオンの場 合 の色 を示 すRGB値 。

OffColour７:

ト レンド [ペン 7] のオフの場 合 の色 を示 すRGB値 。

Expression8:

[ペン 8] フィールドの文 字 列 引 数 。

OnColour8:

ト レンド [ペン 8] のオンの場 合 の色 を示 すRGB値 。

OffColour8:

ト レンド [ペン 8] のオフの場 合 の色 を示 すRGB値 。

319
Chapter: 6 グラフィックス ビルダー オートメーション インターフェース

戻 り値
関 数 が正 常 に実 行 された場 合 は0 (ゼロ) が、それ以 外 の場 合 はエラーが返 されます。

注 :戻 り値 とエラー値 の処 理 の詳 細 については、エラー処 理 を参 照 してください。

関連項目
PropertiesTrendGetEx

PropertyVisibility
[オブジェクト のプロパティ] ダイアログ ボックスの [表 示 | 可 視 性 ] タブで、[非 表 示 の条 件 ] を設
定 します。

シンタックス
PropertyVisibility(Text)
テキストの場 合

引 数 の文 字 列 。

戻 り値
現 在 の設 定 を取 得 する場 合 は、引 数 の文 字 列 。オプションを有 効 または無 効 にする場 合
は、正 常 に処 理 が完 了 すれば0 (ゼロ) が返 されます。いずれの場 合 も、正 常 に完 了 しないと
エラーが返 されます。

注 :戻 り値 とエラー値 の処 理 の詳 細 については、エラー処 理 を参 照 してください。

注 :この関 数 は、C++環 境 では2つの独 立 した関 数 として実 行 されます。put_

PropertyVisibilityによってこのオプションが有 効 または無 効 になり、get_PropertyVisiblity
によって現 在 のオプション設 定 が取 得 されます。

ライブラリ オブジェクト 関 数
ライブラリ オブジェクト 関 数 を使 用 した場 合 、プロジェクト のライブラリに保 管 されているオブジェ
クト を使 用 および操 作 できます。これには、ジニー、スーパー ジニー、シンボルなどのオブジェクト
も含 まれます。

320
 Chapter: 6 グラフィックス ビルダー オートメーション インターフェース

LibraryObjectFirstProperty アクティブなジニーの最 初 のプロパティの名 前 と値 を返 します。

LibraryObjectFirstPropertyEx 指 定 したジニーの最 初 のプロパティの名 前 と値 を返 します。

LibraryObjectHotspotGet ジニー、またはシンボル ページのホット スポット マーカーを取

得 します。

LibraryObjectHotspotPut ジニー、またはシンボル ページにホット スポット マーカーを配

置 します。

LibraryObjectName 選 択 したオブジェクト の名 前 を返 します。

LibraryObjectNextProperty LibraryObjectFirstProperty 関 数 の呼 び出 しに続 いて実

行 された場 合 、アクティブなジニーの次 のプロパティの名 前 と
値 を返 します。

LibraryObjectNextPropertyEx LibraryObjectFirstPropertyEx関 数 によって指 定 されたジ

ニーの次 のプロパティの名 前 と値 を返 します。

LibraryObjectPlace ライブラリ オブジェクト (シンボルまたはジニー) をアクティブ

なCitectSCADAグラフィックス ページのデフォルト の場 所 (左
上 のコーナー) に配 置 します。

LibraryObjectPlaceEx ライブラリ オブジェクト (シンボルまたはジニー) をアクティブ

なCitectSCADA グラフィックス ページの指 定 した場 所 に配 置
します。

LibraryObjectPutProperty アクティブなジニーの指 定 されたプロパティの値 を設 定 します。

LibSelectionHooksEnabled この関 数 で真 (TRUE) の値 を書 き込 むと、ライブラリ選 択 フッ

クが有 効 になります。有 効 の場 合 、[ジニーの貼 り付 け] また
は [シンボル貼 り付 け] をクリックすると (または、これらのツー
ルバー ボタンと同 じ機 能 を押 すと)、標 準 の選 択 ダイアログ ボ
ックスは表 示 されず、代 わりにオート メーション イベント の [シン
ボル貼 り付 け] または [ジニーの貼 り付 け] が発 生 します。

LibraryShowPasteDialog [ジニーの貼 り付 け] または [シンボル貼 り付 け] ダイアログ ボ

ックスを表 示 します。

戻 り値 とエラー値 の処 理 の詳 細 については、「エラー処 理 」を参 照 してください。

LibraryObjectFirstProperty
アクティブなジニーの最 初 のプロパティの名 前 と値 を返 します。LibraryObjectNextPropertyととも
に使 用 して、ジニーのすべてのプロパティを順 番 に取 得 することもできます。

321
Chapter: 6 グラフィックス ビルダー オートメーション インターフェース

シンタックス
LibraryObjectFirstProperty(PropertyName, PropertyValue)
PropertyName:

アクティブなジニーの最 初 のプロパティの名 前 を文 字 列 として返 します。

PropertyValue:

アクティブなジニーの最 初 のプロパティの名 前 を文 字 列 として返 します。

戻 り値
ジニーの最 初 のプロパティの名 前 と値 を、文 字 列 の値 として返 します。

注 : 戻 り値 とエラー値 の処 理 の詳 細 については、エラー処 理 を参 照 してください。

関連項目
LibraryObjectPlace, LibraryObjectNextProperty, LibraryObjectPutProperty,
LibraryObjectName

On Error Resume Next

Err.Clear
GraphicsBuilder.LibraryObjectFirstProperty PropName, PropValue
While Err.Number = 0
Debug.Print PropName, PropValue
GraphicsBuilder.LibraryObjectNextProperty PropName, PropValue
Wend

LibraryObjectFirstPropertyEx
指 定 したジニーの最 初 のプロパティの名 前 と値 を返 します。LibraryObjectNextPropertyExとと
もに使 用 して、指 定 したジニーのプロパティを順 番 にすべて取 得 することもできます。

シンタックス
LibraryObjectFirstPropertyEx(Project, Library, Object, PropertyName, PropertyValue)
Project:

ジニーの属 するプロジェクト の名 前 。

Library:

ジニーの属 するライブラリの名 前 。

322
 Chapter: 6 グラフィックス ビルダー オートメーション インターフェース

Object:

ジニーの名 前 。

PropertyName:

アクティブなジニーの最 初 のプロパティの名 前 を文 字 列 として返 します。

PropertyValue:

アクティブなジニーの最 初 のプロパティの名 前 を文 字 列 として返 します。

戻 り値
指 定 したジニーの最 初 のプロパティの名 前 と値 を、文 字 列 の値 として返 します。

注 : 戻 り値 とエラー値 の処 理 の詳 細 については、エラー処 理 を参 照 してください。

関連項目
LibraryObjectPlace, LibraryObjectNextProperty, LibraryObjectPutProperty,
LibraryObjectName

' Retrieves the first property of the specified Genie

GraphicsBuilder.LibraryObjectFirstPropertyEx "include", "motors", "Motor_2_east",
PropName, PropValue

LibraryObjectHotspotGet
ジニー、またはシンボル ページのホット スポット マーカーを取 得 します。ジニーまたはシンボルの
ページではない場 合 は、失 敗 します。

シンタックス
LibraryObjectHotspotGet(Xposition, YPosition)
Xposition:

ページの左 側 からの、ピクセルによる絶 対 X位 置 です。

YPosition:

ページの上 部 からの、ピクセルによる絶 対 Y位 置 です。

323
Chapter: 6 グラフィックス ビルダー オートメーション インターフェース

戻 り値
ホット スポット のXとY の値 。ここで Xはページの左 側 からのピクセル数 を、Yはページの上 部 から
のピクセル数 を表 します。

注 : 戻 り値 とエラー値 の処 理 の詳 細 については、エラー処 理 を参 照 してください。

関連項目
LibraryObjectHotspotPut

LibraryObjectHotspotPut
ジニー、またはシンボル ページにホット スポット マーカーを配 置 します。ジニーまたはシンボルの
ページではない場 合 は、失 敗 します。

シンタックス
LibraryObjectHotspotPut(Xposition, YPosition)
Xposition:

ページの左 側 からの、ピクセルによる絶 対 X位 置 です。

YPosition:

ページの上 部 からの、ピクセルによる絶 対 Y位 置 です。

戻 り値
関 数 が正 常 に実 行 された場 合 は0 (ゼロ) が、それ以 外 の場 合 はエラーが返 されます。

注 : 戻 り値 とエラー値 の処 理 の詳 細 については、エラー処 理 を参 照 してください。

関連項目
LibraryObjectHotspotGet

LibraryObjectName
ライブラリ オブジェクト の場 合 、選 択 したオブジェクト の名 前 を返 します。

シンタックス
LibraryObjectName(Project, Library, Object, GenieOrSymbol)
Project:

324
 Chapter: 6 グラフィックス ビルダー オートメーション インターフェース

ソースとして使 用 するオブジェクト ライブラリを含 むプロジェクト の名 前 。

Library:

名 前 を取 得 するシンボルまたはジニーを含 むライブラリを指 定 します。

Object:

シンボルやジニーの名 前 の文 字 列 。

GenieOrSymbol:

名 前 を取 得 するオブジェクト が、シンボルかジニーかを識 別 します。

l 1 = ジニー
l 2 = シンボル

戻 り値
指 定 したオブジェクト の名 前 を文 字 列 として返 します。

注 : 戻 り値 とエラー値 の処 理 の詳 細 については、エラー処 理 を参 照 してください。

関連項目
LibraryObjectFirstProperty, LibraryObjectNextProperty, LibraryObjectPutProperty

On Error Resume Next

Err.Clear
GraphicsBuilder.LibraryObjectName Project, File, Page, LibType
If Err.Number = 0 Then
Debug.Print Project; "."; File; "."; Page
Else
Debug.Print "not a library object"
End If

LibraryObjectNextProperty
LibraryObjectFirstProperty関 数 の呼 び出 しに続 いて実 行 された場 合 、アクティブなジニーの
次 のプロパティの名 前 と値 を返 します。この関 数 を繰 り返 し呼 び出 すことで、オブジェクト のプロ
パティすべてを取 得 することができます。

シンタックス
LibraryObjectNextPropertyEx(PropertyName, PropertyValue)
PropertyName:

325
Chapter: 6 グラフィックス ビルダー オートメーション インターフェース

アクティブなジニーの次 のプロパティの名 前 を文 字 列 として返 します。

PropertyValue:

アクティブなジニーの次 のプロパティの値 を文 字 列 として返 します。

戻 り値
ジニーの次 のプロパティの名 前 と値 を、文 字 列 の値 として返 します。

注 : 戻 り値 とエラー値 の処 理 の詳 細 については、エラー処 理 を参 照 してください。

関連項目
LibraryObjectPlace, LibraryObjectFirstProperty, LibraryObjectPutProperty,
LibraryObjectName

On Error Resume Next

Err.Clear
GraphicsBuilder.LibraryObjectFirstProperty PropName, PropValue
While Err.Number = 0
Debug.Print PropName, PropValue
GraphicsBuilder.LibraryObjectNextProperty PropName, PropValue
Wend

LibraryObjectNextPropertyEx
LibraryObjectFirstPropertyEx関 数 によって指 定 されたジニーの次 のプロパティの名 前 と値 を返
します。この関 数 を繰 り返 し呼 び出 すことで、指 定 したジニーのプロパティすべてを取 得 すること
ができます。

シンタックス
LibraryObjectNextPropertyEx(PropertyName, PropertyValue)
PropertyName:

アクティブなジニーの次 のプロパティの名 前 を文 字 列 として返 します。

PropertyValue:

アクティブなジニーの次 のプロパティの値 を文 字 列 として返 します。

戻 り値
ジニーの次 のプロパティの名 前 と値 を、文 字 列 の値 として返 します。

326
 Chapter: 6 グラフィックス ビルダー オートメーション インターフェース

注 : 戻 り値 とエラー値 の処 理 の詳 細 については、エラー処 理 を参 照 してください。

関連項目
LibraryObjectFirstPropertyEx

On Error Resume Next

Err.Clear
GraphicsBuilder.LibraryObjectFirstPropertyEx "include", "motors", "Motor_2_east",
PropName, PropValue
While Err.Number = 0
Debug.Print PropName, PropValue
GraphicsBuilder.LibraryObjectNextProperty PropName, PropValue
Wend

LibraryObjectPlace
ライブラリ オブジェクト (シンボルまたはジニー) をアクティブなCitectSCADAグラフィックス ページの
デフォルト の場 所 (左 上 のコーナー) に配 置 します。指 定 したオブジェクト が見 つからない場 合 、
この関 数 は成 功 しません。

シンタックス
LibraryObjectPlace(Project, Library, Object, GenieOrSymbol, Linked)
Project:

ソースとして使 用 するオブジェクト ライブラリを含 むプロジェクト の名 前 。

Library:

アクティブな CitectSCADA グラフィックス ページに配 置 するシンボルまたはジニーを含 むライブラリを指 定

します。

Object:

アクティブな CitectSCADA グラフィックス ページに配 置 するシンボルまたはジニーの名 前 。

GenieOrSymbol:

使 用 するオブジェクト が、シンボルかジニーかを識 別 します。

l 0 = 不 明 なライブラリ タイプ (ジニーかシンボルを自 動 的 に選 択 )
l 1 = ジニー
l 2 = シンボル
Linked:

327
Chapter: 6 グラフィックス ビルダー オートメーション インターフェース

真 (TRUE) に設 定 した場 合 、オブジェクト は元 のライブラリへのリンクを保 持 したままになります。(ジニーの

場 合 は真 (TRUE) を選 択 します)。GenieOrSymbolが2 (シンボル) に設 定 されている場 合 にのみ偽
(FALSE) に設 定 できます。

戻 り値
関 数 が正 常 に実 行 された場 合 は0 (ゼロ) が、それ以 外 の場 合 はエラーが返 されます。

注 : 戻 り値 とエラー値 の処 理 の詳 細 については、エラー処 理 を参 照 してください。

関連項目
LibraryObjectFirstProperty, LibraryObjectNextProperty, LibraryObjectPutProperty,
LibraryObjectName

' Adds an object to the current CitectSCADA graphics page

GraphicsBuilder.LibraryObjectPlace "include", "agitator", "agit_1_Pos1_g", 2, True
GraphicsBuilder.PositionAt 200, 200

LibraryObjectPlaceEx
ライブラリ オブジェクト (シンボルまたはジニー) をアクティブなCitectSCADA グラフィックス ページ
の指 定 した場 所 に配 置 します。指 定 したオブジェクト が見 つからない場 合 、この関 数 は成 功
しません。

シンタックス
LibraryObjectPlaceEx(Project, Library, Object, GenieOrSymbol, Linked, Xposition, YPosition)
Project:

ソースとして使 用 するオブジェクト ライブラリを含 むプロジェクト の名 前 。

Library:

アクティブな CitectSCADA グラフィックス ページに配 置 するシンボルまたはジニーを含 むライブラリを指 定

します。

Object:

アクティブな CitectSCADA グラフィックス ページに配 置 するシンボルまたはジニーの名 前 。

GenieOrSymbol:

使 用 するオブジェクト が、シンボルかジニーかを識 別 します。

328
 Chapter: 6 グラフィックス ビルダー オートメーション インターフェース

l 0 = 不 明 なライブラリ タイプ (ジニーかシンボルを自 動 的 に選 択 )

l 1 = ジニー
l 2 = シンボル
Linked:

真 (TRUE) に設 定 した場 合 、オブジェクト は元 のライブラリへのリンクを保 持 したままになります。(ジニーの

場 合 は真 (TRUE) を選 択 します)。

Xposition:

ページの左 側 からの、ピクセルによる絶 対 X位 置 です。

YPosition:

ページの上 部 からの、ピクセルによる絶 対 Y位 置 です。

戻 り値
関 数 が正 常 に実 行 された場 合 は0 (ゼロ) が、それ以 外 の場 合 はエラーが返 されます。

注 : 戻 り値 とエラー値 の処 理 の詳 細 については、エラー処 理 を参 照 してください。

関連項目
LibraryObjectFirstProperty, LibraryObjectNextProperty, LibraryObjectPutProperty,
LibraryObjectName

' Adds an object to the current graphics page at 200 pixels from the left and top
GraphicsBuilder.LibraryObjectPlaceEx "include", "agitator", "agit_1_Pos1_g",
2, True, 200, 200

LibraryObjectPutProperty
アクティブなジニーの指 定 されたプロパティの値 を設 定 します。フィールド 名 では、大 文 字 と小 文
字 が区 別 されます。

シンタックス
LibraryObjectPutProperty(PropertyName, PropertyValue)
PropertyName:

LibraryObjectFirstProperty関 数 、またはLibraryObjectNextProperty関 数 から返 された、編 集 するプロパ

ティの名 前 。

329
Chapter: 6 グラフィックス ビルダー オートメーション インターフェース

PropertyValue:

プロパティに文 字 列 として書 き込 まれる値 です。

戻 り値
関 数 が正 常 に実 行 された場 合 は0 (ゼロ) が、それ以 外 の場 合 はエラーが返 されます。

注 : 戻 り値 とエラー値 の処 理 の詳 細 については、エラー処 理 を参 照 してください。

関連項目
LibraryObjectPlace, LibraryObjectFirstProperty, LibraryObjectNextProperty,
LibraryObjectName

GraphicsBuilder.LibraryObjectPlace "include", "motors", "Motor_1_east", 1, True

GraphicsBuilder.LibraryObjectPutProperty "Tag", "My test genie"

LibraryShowPasteDialog
[ジニーの貼 り付 け] または [シンボル貼 り付 け] ダイアログ ボックスを表 示 します。

シンタックス
LibraryShowPasteDialog(GenieOrSymbol)
GenieOrSymbol:

使 用 するオブジェクト が、シンボルかジニーかを識 別 します。

l 1 = ジニー
l 2 = シンボル

注 : 戻 り値 とエラー値 の処 理 の詳 細 については、エラー処 理 を参 照 してください。

関連項目
PasteSymbol, PasteGenie

LibSelectionHooksEnabled

330
 Chapter: 6 グラフィックス ビルダー オートメーション インターフェース

この関 数 で真 (TRUE) の値 を書 き込 むと、ライブラリ選 択 フックが有 効 になります。有 効 の場

合 、[ジニーの貼 り付 け] または [シンボルの貼 り付 け] をクリックすると (または、これらのツール
バー ボタンと同 じ機 能 )、標 準 の選 択 ダイアログ ボックスは表 示 されず、代 わりにオート メーショ
ン イベント の [PasteSymbol] または [PasteGenie] が発 生 します。
また、フックが有 効 になっている場 合 、Ctrl キーとShift キーを押 しながら CitectSCADAのペー
ジをダブルクリックすると、イベント SwapObject が発 生 します。

シンタックス
LibSelectionHooksEnabled(HooksEnabled)
HooksEnabled:

真 (TRUE) に設 定 した場 合 、ライブラリ選 択 フックが有 効 になります。

戻 り値
ライブラリ選 択 フックを有 効 にするか、現 在 のライブラリ選 択 フックの設 定 を取 得 します。

注 : 戻 り値 とエラー値 の処 理 の詳 細 については、エラー処 理 を参 照 してください。

関連項目
PasteSymbol, PasteGenie

注 : この関 数 は、C++環 境 では2つの独 立 した関 数 として実 行 されます。put_

LibSelectionHooksEnabledによって選 択 フックが有 効 となり、get_ LibSelectionHooksEnabled
によって現 在 の選 択 フックの設 定 が取 得 されます。

メタデータ関 数
メタデータ関 数 を使 用 して、ページに現 在 あるメタデータを設 定 します。

PropertiesAddMetadata 新 しいメタデータ エント リーを現 在 のオブジェクト のプロパティに追 加 し

ます。

ProperitiesSelectFirstMetadata 現 在 のオブジェクト のプロパティから最 初 のメタデータ エント リーを選

択 します。

PropertiesSelectNextMetadata 現 在 のオブジェクト のプロパティから次 のメタデータ エント リーを選 択

します。

PropertiesSelectMetadataByName 現 在 のページの指 定 したメタデータ エント リーを選 択 します。

PropertiesDeleteMetadata 現 在 のオブジェクト のプロパティから選 択 したメタデータ エント リーを削

331
Chapter: 6 グラフィックス ビルダー オートメーション インターフェース

除 します。

PropertiesMetadataName 現 在 選 択 されているオブジェクト のメタデータの名 前 を設 定 また

は取 得 します。

PropertiesMetadataValue 現 在 選 択 されているオブジェクト のメタデータの値 を設 定 または

取 得 します。

戻 り値 とエラー値 の処 理 の詳 細 、および Visual Basic のサンプルについては、エラー処 理 を参

照 してください。

PropertiesAddMetadata
現 在 のオブジェクト プロパティに新 しいメタデータ エント リーを追 加 します。指 定 した名 前 のメタ
データが既 に存 在 する場 合 、この関 数 はエラーを返 します。

シンタックス
PropertiesAddMetadata (Name, Value)
Name:

現 在 のオブジェクト のプロパティに追 加 される新 しいメタデータ エント リーの名 前

値 :

現 在 のオブジェクト プロパティに追 加 される新 しいメタデータの値

戻 り値
関 数 が正 常 に実 行 された場 合 は0 (ゼロ) が、それ以 外 の場 合 はエラーが返 されます。

例
新 規 要 素 を追 加 し、次 のようにプロパティを設 定 します。

GraphicsBuilder.PropertiesAddMetadata("MyName","MyValue")

関連項目
PropertiesMetadataValue
、
PropertiesMetadataName
、
PropertiesSelectNextMetadata
、

332
 Chapter: 6 グラフィックス ビルダー オートメーション インターフェース

PropertiesSelectFirstMetadata
、PropertiesDeleteMetadata、PropertiesSelectMetadataByName

PropertiesDeleteMetadata
現 在 のオブジェクト のプロパティから選 択 したメタデータを削 除 します。項 目 を削 除 した
後 、PropertiesSelectNextMetadata を呼 び出 すと、削 除 した項 目 の直 後 の項 目 が選 択 され
ます。

シンタックス
PropertiesDeleteMetadata()

戻 り値
関 数 が正 常 に実 行 された場 合 は0 (ゼロ) が、それ以 外 の場 合 はエラーが返 されます。

例
「a」で始 まるすべてのメタデータを削 除 。

Dim name As String

On Error Resume Next
Err.Clear()
GraphicsBuilder.PropertiesSelectFirstMetadata()
While (Err.Number = 0)
name = GraphicsBuilder.PropertiesMetadataName
If (name.ToLower().StartsWith("a")) Then
GraphicsBuilder.PropertiesDeleteMetadata()
End If
GraphicsBuilder.PropertiesSelectNextMetadata()
End While

関連項目
PropertiesMetadataValue
、
PropertiesMetadataName
、
PropertiesSelectNextMetadata
、
PropertiesSelectFirstMetadata
、PropertiesAddMetadata、PropertiesSelectMetadataByName

PropertiesMetadataName
現 在 選 択 しているオブジェクト のメタデータの名 前 を設 定 または取 得 します。

333
Chapter: 6 グラフィックス ビルダー オートメーション インターフェース

シンタックス
Name = PropertiesMetadataName
PropertiesMetadataName (Name)

戻 り値
現 在 選 択 しているメタデータ項 目 の名 前 (文 字 列 )。正 常 に完 了 しないとエラーが返 されま
す。

関連項目
PropertiesMetadataValue
、
PropertiesDeleteMetadata
、
PropertiesSelectNextMetadata
、
PropertiesSelectFirstMetadata
、PropertiesAddMetadata、PropertiesSelectMetadataByName

PropertiesMetadataValue
現 在 選 択 しているオブジェクト のメタデータの値 を設 定 または取 得 します。

シンタックス
Val = PropertiesMetadataValue
PropertiesMetadataValue(Def)

戻 り値
現 在 選 択 しているメタデータ (文 字 列 ) またはデフォルト 値 の設 定 が正 常 に使 用 された場 合
は、0(ゼロ) 。正 常 に完 了 しないとエラーが返 されます。

関連項目
PropertiesMetadataName
、
PropertiesDeleteMetadata
、
PropertiesSelectNextMetadata
、

334
 Chapter: 6 グラフィックス ビルダー オートメーション インターフェース

PropertiesSelectFirstMetadata
、PropertiesAddMetadata、PropertiesSelectMetadataByName

PropertiesSelectFirstMetadata
現 在 のオブジェクト のプロパティから最 初 のメタデータ エント リを選 択 します。

シンタックス
PropertiesSelectFirstMetadata()

戻 り値
関 数 が正 常 に実 行 された場 合 は0 (ゼロ) が、それ以 外 の場 合 はエラーが返 されます。

例
現 在 のオブジェクト のページ プロパティがメタデータを定 義 したかどうかを決 定 します。

On Error Resume Next

Err.Clear()
GraphicsBuilder.PropertiesSelectFirstMetadata()
If (Err.Number <> 0)
' The object has no metadata
End If

関連項目
PropertiesMetadataValue
、
PropertiesMetadataName
、
PropertiesSelectNextMetadata
、PropertiesDeleteMetadata、PropertiesAddMetadata、PropertiesSelectMetadataByName

PropertiesSelectMetadataByName
現 在 のページにある指 定 のメタデータを選 択 します。

シンタックス
PropertiesSelectMetadataByName(BSTR Name)
Name:

選 択 するメタデータの名 前 。

335
Chapter: 6 グラフィックス ビルダー オートメーション インターフェース

戻 り値
関 数 が正 常 に実 行 された場 合 は0 (ゼロ) が、それ以 外 の場 合 はエラーが返 されます。

例
特 定 の名 前 のメタデータが存 在 するかどうか決 定 します。

On Error Resume Next

Err.Clear()
GraphicsBuilder.PropertiesSelectMetadataByName("MyName")
If (Err.Number <> 0)
' The metadata does not exist
End If

関連項目
PropertiesDeleteMetadata, PropertiesMetadataValue, PropertiesMetadataName,
PropertiesSelectNextMetadata, PropertiesSelectFirstMetadata

PropertiesSelectNextMetadata
現 在 のオブジェクト のプロパティから次 のメタデータ エント リを選 択 します。

シンタックス
PropertiesSelectNextMetadata()

戻 り値
関 数 が正 常 に実 行 された場 合 は0 (ゼロ) が、それ以 外 の場 合 はエラーが返 されます。

例
現 在 のオブジェクト プロパティ内 のすべてのメタデータ エント リを印 刷 します。

On Error Resume Next

Err.Clear()
GraphicsBuilder.PropertiesSelectFirstMetadata()
While (Err.Number = 0)
Console.Out.WriteLine(GraphicsBuilder.PropertiesMetadataName)
GraphicsBuilder.PropertiesSelectNextMetadata()
End While

336
 Chapter: 6 グラフィックス ビルダー オートメーション インターフェース

関連項目
PropertiesMetadataValue
、
PropertiesMetadataName
、
PropertiesSelectNextMetadata
、
PropertiesSelectFirstMetadata
、PropertiesAddMetadata、PropertiesSelectMetadataByName

その他 の関 数
これらの関 数 は、グラフィックス ビルダーの特 別 な操 作 に使 用 します。例 えば、アクティブなウィ
ンド ウのハンド ルを要 求 して、外 部 とのド ラッグ アンド ド ロップを実 行 できます。

BrokenLinkCancelEnabled 真 (TRUE) の値 を書 き込 むと、ProjectUpdatePages 関

数 または PageOpen 関 数 の実 行 中 に最 初 の破 損 したリンク
(参 照 の欠 落 ) が見 つかった場 合 に、関 数 は終 了 し、E-
POINTER エラーが発 生 します。

ClipboardCopy 選 択 したオブジェクト をWindowsのクリップボードにコピーしま

す。

ClipboardCut 選 択 したオブジェクト をWindowsのクリップボードに切 り取 りま

す。

ClipboardPaste Windowsのクリップボードからアクティブなページに要 素 を貼
り付 けます。

ConvertToBitmap アクティブなオブジェクト をビット マップに変 換 します。アクティブ

なオブジェクト に変 換 できません。

Quit CitectSCADA開 発 環 境 を終 了 します。

SelectionEventEnabled この関 数 で真 (TRUE) を書 き込 むと、グラフィックス ページで

選 択 を行 うたびにイベント が発 生 します。また、この関 数 を使
用 して、このオプションの現 在 の設 定 を取 得 することもできま
す。

UnLockObject オブジェクト を選 択 可 能 に設 定 します。

戻 り値 とエラー値 の処 理 の詳 細 、および Visual Basic のサンプルについては、エラー処 理 を参

照 してください。

BrokenLinkCancelEnabled

337
Chapter: 6 グラフィックス ビルダー オートメーション インターフェース

真 (TRUE) の値 を書 き込 むと、ProjectUpdatePages 関 数 または PageOpen 関 数 の実 行 中

に最 初 の破 損 したリンク (参 照 の欠 落 ) が見 つかった場 合 に、関 数 は終 了 し、E-POINTER エ
ラーが発 生 します。偽 (FALSE) に設 定 した場 合 、これらの関 数 の実 行 は完 了 しますが、ペー
ジ内 の未 解 決 の参 照 ごとに BrokenLink イベント が発 生 します。

シンタックス
BrokenLinkCancelEnabled(CancelEnabled)
CancelEnabled:

有 効 の場 合 は真 (TRUE)。

戻 り値
現 在 の設 定 を取 得 する場 合 は、真 (TRUE) または偽 (FALSE)。このオプションを設 定 する場
合 は、正 常 に設 定 が完 了 した場 合 は 0 (ゼロ) を返 します。いずれの場 合 も、正 常 に完 了 し
ないとエラーが返 されます。
戻 り値 とエラー値 の処 理 の詳 細 、およびVisual Basicのサンプルについては、エラー処 理 を参
照 してください。

関連項目
BrokenLink、ProjectUpdatePages、PageOpen

注 ：この関 数 は、C++ 環 境 では 2 つの独 立 した関 数 として実 行 されます。put_

BrokenLinkCancelEnabledによってこのオプションが有 効 または無 効 になり、get_
BrokenLinkCancelEnabledによって現 在 の設 定 が取 得 されます。

ClipboardCopy
選 択 したオブジェクト を Windows のクリップボード にコピーします。

シンタックス
ClipboardCopy

関連項目
ClipboardCut、ClipboardPaste

ClipboardCut
選 択 したオブジェクト を Windows のクリップボード に切 り取 ります。

338
 Chapter: 6 グラフィックス ビルダー オートメーション インターフェース

シンタックス
ClipboardCut

関連項目
ClipboardCopy、ClipboardPaste

ClipboardPaste
Windows のクリップボード からアクティブなページに要 素 を貼 り付 けます。

シンタックス
ClipboardPaste

関連項目
ClipboardCut、ClipboardCopy

ConvertToBitmap
アクティブなオブジェクト をビット マップに変 換 します。アクティブなオブジェクト がない場 合 は失 敗
します。

シンタックス
ConvertToBitmap

Quit
CitectSCADA開 発 環 境 を終 了 します。

SelectionEventEnabled
この関 数 で真 (TRUE) を書 き込 むと、グラフィックス ページで選 択 を行 うたびにイベント が発 生
します。また、この関 数 を使 用 して、このオプションの現 在 の設 定 を取 得 することもできます。

シンタックス
SelectionEventEnabled(EventEnabled)
EventEnabled:

選 択 したイベント を有 効 にするには真 (TRUE) に設 定 します。

339
Chapter: 6 グラフィックス ビルダー オートメーション インターフェース

戻 り値
現 在 の設 定 を取 得 する場 合 は、真 (TRUE) または偽 (FALSE)。このオプションを設 定 する場
合 は、正 常 に設 定 が完 了 した場 合 は 0 (ゼロ) が返 されます。いずれの場 合 も、正 常 に完 了
しないとエラーが返 されます。

注 :戻 り値 とエラー値 の処 理 の詳 細 については、エラー処 理 を参 照 してください。

関連項目
Selection

注 :この関 数 は、C++環 境 では2つの独 立 した関 数 として実 行 されます。put_

SelectionEventEnabledによってこのオプションが有 効 または無 効 になり、get_
SelectionEventEnabledによって現 在 のオプション設 定 が取 得 されます。

UnLockObject
オブジェクト を選 択 可 能 に設 定 します。

シンタックス
UnLockObject

戻 り値
適 用 なし

注 ：戻 り値 とエラー値 の処 理 の詳 細 については、エラー処 理 を参 照 してください。

例
Public Sub Example()
Dim gb As GraphicsBuilder.GraphicsBuilder
.
.
.
gb.PageSelectFirstObjectInGenie()
gb.PageSelectNextObjectInGenie()
gb.PageTemplateSelectFirstObject()
gb.PageTemplateSelectNextObject()
gb.UnLockObject()
End Sub

340
 Chapter: 6 グラフィックス ビルダー オートメーション インターフェース

関連項目
適 用 なし

オブジェクト の描 画 とプロパティの関 数
これらの関 数 を使 用 して、オブジェクト を描 画 し、オブジェクト のプロパティを操 作 できます。

注 : フリーハンド 線 の描 画 は、DrawPolygon関 数 を使 用 して同 じ結 果 を得 ることができる

ため、サポート されていません。

サポート されているプロパティは、[全 般 ] と [3D] のみです。[移 動 ]、[スケーリング]、[塗 り込 み]

などにはアクセスできません。
設 定 は選 択 されているオブジェクト に適 用 されるか、選 択 されているオブジェクト から読 み込 ま
れます。一 般 的 に、選 択 されているオブジェクト は最 後 に配 置 したオブジェクト で
す。PageSelectFirstObject()関 数 とPageSelectNextObject()関 数 を使 用 すれば、すべてのオブ
ジェクト にアクセスして、プロパティを変 更 または読 み込 むことができます。

Attribute3dEffects オブジェクト に3D効 果 を適 用 するか、または現 在 の3D効 果 の設

定 を取 得 します。

Attribute3dEffectDepth 3D効 果 に奥 行 きのレベルを適 用 するか、または現 在 の奥 行 き

の設 定 を取 得 します。

AttributeAN アクティブなオブジェクト のアニメーション番 号 (AN) を取 得 しま

す。

AttributeBaseCoordinates オブジェクト の基 本 座 標 を返 します。

AttributeClass アクティブなオブジェクト のクラスを、文 字 列 として取 得 します。

AttributeCornerRadius 現 在 のオブジェクト の角 半 径 の値 を設 定 または取 得 します。

AttributeEllipseStyle 楕 円 にスタイルを適 用 します。または、現 在 の楕 円 のスタイルの

設 定 を取 得 します。

AttributeEndAngle 弧 または扇 形 の終 了 角 度 を設 定 するか、取 得 します。

AttributeExtentX アクティブなオブジェクト の範 囲 を表 すX座 標 を取 得 します。

AttributeExtentY アクティブなオブジェクト の範 囲 を表 すY座 標 を取 得 します。

AttributeFillColour オブジェクト の塗 り込 み色 を設 定 するか、現 在 の塗 り込 み色 を示

341
Chapter: 6 グラフィックス ビルダー オートメーション インターフェース

す値 を取 得 します。

AttributeFillOffColourEx オブジェクト の塗 り込 み色 を設 定 するか、現 在 の塗 り込 み色 を示

す値 を取 得 します。

AttributeFillOnColourEx オブジェクト の塗 り込 み色 を設 定 するか、現 在 の塗 り込 み色 を示

す値 を取 得 します。

AttributeGradientMode 現 在 のオブジェクト の階 調 度 の方 向 を設 定 または取 得 します。

AttributeGradientOffColour 現 在 のオブジェクト に対 する、「オフ」の部 分 の階 調 度 の色 を設

定 または取 得 します。

AttributeGradientOnColour 現 在 のオブジェクト に対 する、「オン」の部 分 の階 調 度 の色 を設

定 または取 得 します。

AttributeHiLightColour 3D効 果 の [浮 き出 し]、[凹 み]、または [浮 き彫 り] に適 用 する

ハイライト 色 を設 定 するか、または現 在 のハイライト 色 の設 定 を
取 得 します。

AttributeLineColour 直 線 に色 を適 用 します。または、現 在 の色 の設 定 を取 得 しま
す。この関 数 は、AttributeLineOnColourEx関 数 と
AttributeLineOffColourEx関 数 に置 き換 えられました。

AttributeLineOnColourEx この関 数 はTrue Color機 能 をサポート してお

り、AttributeLineColour関 数 を置 き換 えるものです。

AttributeLineOffColourEx この関 数 はTrue Color機 能 をサポート してお

り、AttributeLineColour関 数 を置 き換 えるものです。

AttributeLineStyle 直 線 にスタイルを適 用 します。または、現 在 のスタイルの設 定 を

取 得 します。

AttributeLineWidth 直 線 の幅 を設 定 します。または現 在 の幅 を取 得 します。

AttributeLoLightColour 3D効 果 の [浮 き出 し]、[凹 み]、または [浮 き彫 り] に適 用 する

ローライト 色 を設 定 するか、または現 在 のローライト 色 の設 定 を
取 得 します。この関 数 ではTrue Colour機 能 がサポート されてい
ないため、AttributeLoLightOffColourEx関 数 、およ
びAttributeLoLightOnColourEx関 数 に置 き換 えられました。

AttributeLoLightOffColourEx 3D 効 果 の [浮 き出 し]、[凹 み]、または [浮 き彫 り] に適 用 す

る「オフ」の場 合 のローライト 色 を設 定 するか、現 在 のローライト
色 の設 定 を取 得 します。

AttributeLoLightOnColourEx 3D 効 果 の [浮 き出 し]、[凹 み]、または [浮 き彫 り] に適 用 す

る「オン」の場 合 のローライト 色 を設 定 するか、現 在 のローライト
色 の設 定 を取 得 します。

342
 Chapter: 6 グラフィックス ビルダー オートメーション インターフェース

AttributeNodeCoordinatesFirst フリーハンド線 、多 角 形 、またはパイプの最 初 のノードの座 標 を

返 します。

AttributeNodeCoordinatesNext AttributeNodeCoordinatesFirst の実 装 後 に、次 のフリー ハ

ンド線 、多 角 形 、またはパイプのノード の座 標 を返 します。

AttributePolygonOpen 多 角 形 (ポリライン) がオープン モード (つまり、2 つの終 点 が結

合 されていない) に設 定 されているか、クローズ モード (2 つの終
点 が結 合 されている) かを定 義 します。

AttributeRectangleStyle 四 角 形 のスタイルを設 定 します。または、四 角 形 のスタイルの設

定 を取 得 します。

AttributeSetFill オブジェクト を塗 り込 みとして表 示 します。または現 在 の塗 り込 み

の値 を取 得 します。

AttributeShadowColour 影 付 きの3D効 果 を使 用 する場 合 に、影 の色 を設 定 します。ま

たは現 在 の影 の色 の設 定 を取 得 します。この関 数 ではTrue
Colour機 能 がサポート されていないた
め、AttributeShadowOffColourEx関 数 、およ
びAttributeShadownOnColourEx関 数 に置 き換 えられまし
た。

AttributeShadowOffColourEx 影 付 きの3D効 果 を使 用 する場 合 に、「オフ」の場 合 の影 の色 を

設 定 します。または、現 在 の影 の色 の設 定 を取 得 します。

AttributeShadowOnColourEx 影 付 きの3D効 果 を使 用 する場 合 に、「オン」の場 合 の影 の色 を

設 定 します。または、現 在 の影 の色 の設 定 を取 得 します。

AttributeStartAngle 弧 または扇 形 の開 始 角 度 を設 定 するか、取 得 します。

AttributeTransformationMatrixG- 変 換 マト リクスの要 素 を読 み込 みます。

et

AttributeTransformationMatrixP- 変 換 マト リクスの要 素 を設 定 します。

ut

AttributeX アクティブなオブジェクト のX座 標 を取 得 します。

AttributeY アクティブなオブジェクト のY座 標 を取 得 します。

DrawButton アクティブなページにボタンを描 画 します。

DrawCicodeObject ページの指 定 した場 所 のページにCicodeオブジェクト を配 置 しま

す。

DrawEllipse アクティブなページに楕 円 を描 画 します。

343
Chapter: 6 グラフィックス ビルダー オートメーション インターフェース

DrawLine アクティブなページに直 線 を描 画 します。

DrawNumber ページの指 定 した位 置 に数 値 オブジェクト を配 置 します。

DrawPipeEnd アクティブなページでパイプの描 画 を終 了 します。

DrawPipeSection アクティブなページにパイプの部 分 を描 画 します。

DrawPipeStart DrawPipeSection() を適 用 する開 始 ポイント を定 義 して、アク

ティブなページでパイプの描 画 を開 始 します。

DrawPolygonEnd アクティブなページで多 角 形 の描 画 を終 了 します。

DrawPolygonLine アクティブなページに、多 角 形 を構 成 する直 線 を描 画 します。

DrawPolygonStart DrawPolygonLine() を適 用 する開 始 ポイント を定 義 して、アク

ティブなページで多 角 形 の描 画 を開 始 します。

DrawRectangle アクティブなページに長 方 形 を描 画 します。

DrawSymbolSet ページの指 定 した位 置 にシンボル セット オブジェクト を配 置 しま

す。

DrawText 指 定 した位 置 に英 数 字 の文 字 列 を描 画 します。

DrawTrend アクティブなページにト レンド オブジェクト を描 画 します。

戻 り値 とエラー値 の処 理 の詳 細 、および Visual Basic のサンプルについては、エラー処 理 を参

照 してください。

Attribute3dEffects
オブジェクト に 3D 効 果 を適 用 するか、または現 在 の3D効 果 の設 定 を取 得 します。
この関 数 は、選 択 されているオブジェクト (一 般 的 に、最 後 に配 置 したオブジェクト ) に適 用 さ
れます。PageSelectFirstObject()関 数 とPageSelectNextObject()関 数 を使 用 すれば、すべての
オブジェクト にアクセスして、プロパティを変 更 または読 み込 むことができます。

シンタックス
Attribute3dEffects(Effects)
Effects:

3D 効 果 のタイプを示 す 0 ～ 4 の値 。

344
 Chapter: 6 グラフィックス ビルダー オートメーション インターフェース

l 0 = なし
l 1 = 浮 き出 し
l 2 = 凹み
l 3 = 影付き
l 4 = 浮 き彫 り

戻 り値
現 在 の3D効 果 の設 定 を取 得 する場 合 は、効 果 のタイプを示 す 0 ～ 4 の値 。3D 効 果 を適
用 する場 合 は、正 常 に適 用 が終 了 した場 合 は 0 (ゼロ) を返 します。いずれの場 合 も、正 常
に完 了 しないとエラーが返 されます。属 性 への書 き込 み時 に値 が範 囲 外 の場 合 は、関 数 は
終 了 し、エラー E_INVALIDARG が発 生 します。アクティブなオブジェクト がない場 合 は、関 数
は終 了 し、E_HANDLE を返 します。

注 :戻 り値 とエラー値 の処 理 の詳 細 については、エラー処 理 を参 照 してください。

関連項目
Attribute3dEffectDepth, AttributeShadowColour, AttributeHiLightColour,
AttributeLoLightColour

' Applies a 3D effect (embossed) to an object

GraphicsBuilder.Attribute3dEffects = 4

' Retrieves the current 3D effect applied to an object

MyVariable = GraphicsBuilder.Attribute3dEffects

注 :この関 数 は、C++環 境 では2つの独 立 した関 数 として実 行 されます。put_

Attribute3dEffectによって 3D 効 果 が適 用 され、get_Attribute3dEffect 現 在 の3D効 果
が取 得 されます。

Attribute3dEffectDepth
3D効 果 に奥 行 きのレベルを適 用 するか、または現 在 の奥 行 きの設 定 を取 得 します。
この関 数 は、選 択 されているオブジェクト (一 般 的 に、最 後 に配 置 したオブジェクト ) に適 用 さ
れます。PageSelectFirstObject()関 数 とPageSelectNextObject()関 数 を使 用 すれば、すべての
オブジェクト にアクセスして、プロパティを変 更 または読 み込 むことができます。

シンタックス
Attribute3dEffectDepth(EffectDepth)

345
Chapter: 6 グラフィックス ビルダー オートメーション インターフェース

EffectDepth:

使 用 する 3D 効 果 の奥 行 きを示 す、0 ～ 32 の値 。

戻 り値
3D 効 果 の現 在 の奥 行 きの設 定 を取 得 する場 合 は、0 ～ 32 の値 。3D 効 果 に奥 行 きを適
用 する場 合 は、正 常 に適 用 が完 了 すれば 0 (ゼロ)。いずれの場 合 も、正 常 に完 了 しないとエ
ラーが返 されます。属 性 への書 き込 み時 に値 が範 囲 外 の場 合 は、関 数 は終 了 し、エラー E_
INVALIDARG が発 生 します。アクティブなオブジェクト がない場 合 は、関 数 は終 了 し、E_
HANDLE を返 します。

注 :戻 り値 とエラー値 の処 理 の詳 細 については、エラー処 理 を参 照 してください。

関連項目
Attribute3dEffects, AttributeShadowColour, AttributeHiLightColour,
AttributeLoLightColour

' Applies depth to a 3D effect for the current object

GraphicsBuilder.Attribute3dEffectDepth = 28

' Retrieves the 3D depth for the current object

MyVariable = GraphicsBuilder.Attribute3dEffectDepth

注 :この関 数 は、C++ 環 境 では 2 つの独 立 した関 数 として実 行 されます。put_

Attribute3dEffectDepthによって 3D 効 果 の奥 行 きが適 用 され、get_
Attribute3dEffectDepth 現 在 の 3D の奥 行 きが取 得 されます。

AttributeAN
アクティブなオブジェクト のアニメーション番 号 (AN) を取 得 します。この関 数 が読 み取 り専 用 で
あることにご注 意 ください。
この関 数 は、選 択 されているオブジェクト (一 般 的 に、最 後 に配 置 したオブジェクト ) に適 用 さ
れます。PageSelectFirstObject()関 数 とPageSelectNextObject()関 数 を使 用 すれば、すべての
オブジェクト にアクセスして、プロパティを変 更 または読 み込 むことができます。

シンタックス
AttributeAN(AN)
AN:

346
 Chapter: 6 グラフィックス ビルダー オートメーション インターフェース

0 ～ 65536 の値 。

戻 り値
0 ～ 65536 の値 。属 性 への書 き込 み時 に値 が範 囲 外 の場 合 は、関 数 は終 了 し、エラー E_
INVALIDARG が発 生 します。アクティブなオブジェクト がない場 合 は、関 数 は終 了 し、E_
HANDLE を返 します。

注 ：戻 り値 とエラー値 の処 理 の詳 細 については、エラー処 理 を参 照 してください。

関連項目
AttributeX, AttributeY

' Retrieves the AN for the current object

MyVariable = GraphicsBuilder.AttributeAN

AttributeBaseCoordinates
オブジェクト の基 本 座 標 を返 します。これらの座 標 を使 用 する場 合 は、変 換 マト リクスも適 用
します。詳 細 については、AttributeTransformationMatrixPut関 数
とAttributeTransformationMatrixGet関 数 を参 照 してください。
この関 数 は、選 択 されているオブジェクト (一 般 的 に、最 後 に配 置 したオブジェクト ) に適 用 さ
れます。PageSelectFirstObject()関 数 と PageSelectNextObject()関 数 を使 用 すれば、すべての
オブジェクト にアクセスして、プロパティを変 更 または読 み込 むことができます。

シンタックス
AttributeBaseCoordinates(FromXPosition, FromYPosition, ToXPosition, ToYPosition)
FromXPosition:

ページの左 側 からオブジェクト の左 上 のコーナーまでの、ピクセルによる距 離 です。

FromYPosition:

ページの上 部 からオブジェクト の左 上 のコーナーまでの、ピクセルによる距 離 です。

ToXPosition:

ページの左 側 からオブジェクト の右 下 のコーナーまでの、ピクセルによる距 離 です。

ToYPosition:

ページの上 部 からオブジェクト の右 下 のコーナーまでの、ピクセルによる距 離 です。

347
Chapter: 6 グラフィックス ビルダー オートメーション インターフェース

戻 り値
現 在 のオブジェクト の基 本 座 標 。属 性 への書 き込 み時 に値 が範 囲 外 の場 合 は、関 数 は終
了 し、エラー E_INVALIDARG が発 生 します。アクティブなオブジェクト がない場 合 は、関 数 は
終 了 し、E_HANDLE を返 します。

注 ：戻 り値 とエラー値 の処 理 の詳 細 については、エラー処 理 を参 照 してください。

関連項目
AttributeTransformationMatrixPut, AttributeTransformationMatrixGet

AttributeClass
アクティブなオブジェクト のクラスを、文 字 列 として取 得 します。この関 数 が読 み取 り専 用 である
ことにご注 意 ください。
この関 数 は、選 択 されているオブジェクト (一 般 的 に、最 後 に配 置 したオブジェクト ) に適 用 さ
れます。PageSelectFirstObject()関 数 とPageSelectNextObject()関 数 を使 用 すれば、すべての
オブジェクト にアクセスして、プロパティを変 更 または読 み込 むことができます。

シンタックス
AttributeClass(Class)
Class:

オブジェクト のクラスを示 す文 字 列 。クラスに

は、"Draw"、"Line"、"Square"、"Circle"、"Polyline"、"Pipe"、"Text"、"Button"、"Set"、"Trend"、"Advanced
Animation"、"Bitmap"、"Group"、"ActiveX"、"Symbol"、および "Genie" があります。

戻 り値
オブジェクト のクラスを示 す文 字 列 。属 性 への書 き込 み時 に値 が範 囲 外 の場 合 は、関 数 は
終 了 し、エラー E_INVALIDARG が発 生 します。アクティブなオブジェクト がない場 合 は、関 数
は終 了 し、E_HANDLE を返 します。

注 ：戻 り値 とエラー値 の処 理 の詳 細 については、エラー処 理 を参 照 してください。

' Retrieves the Class for the current object

MyVariable = GraphicsBuilder.AttributeClass

AttributeCornerRadius

348
 Chapter: 6 グラフィックス ビルダー オートメーション インターフェース

現 在 のオブジェクト に対 し、[オブジェクト のプロパティ] ダイアログ ボックスの [全 般 | 表 示 ] タブ

で角 の半 径 値 を設 定 または取 得 します。この関 数 は、四 角 形 のオブジェクト でのみサポート さ
れています。

シンタックス
AttributeCornerRadius(nRadius)
nRadius:

コーナーの丸 みを定 義 します。0 ～ 32 ピクセルの値 を使 用 できます。

戻 り値
現 在 のコーナーの丸 みを取 得 する場 合 は 0 ～ 32 の値 。コーナーの丸 みを適 用 する場 合 は、
適 用 が正 常 に完 了 すれば 0 (ゼロ) を返 します。いずれの場 合 も、正 常 に完 了 しないとエラー
が返 されます。属 性 への書 き込 み時 に値 が範 囲 外 の場 合 は、関 数 は終 了 し、エラー E_
INVALIDARG が発 生 します。アクティブなオブジェクト がない場 合 は、関 数 は終 了 し、E_
HANDLE を返 します。

AttributeEllipseStyle
楕 円 にスタイルを適 用 します。または、現 在 の楕 円 のスタイルの設 定 を取 得 します。
この関 数 は、選 択 されているオブジェクト (一 般 的 に、最 後 に配 置 したオブジェクト ) に適 用 さ
れます。PageSelectFirstObject()関 数 とPageSelectNextObject()関 数 を使 用 すれば、すべての
オブジェクト にアクセスして、プロパティを変 更 または読 み込 むことができます。

シンタックス
AttributeEllipseStyle(EllipseStyle)
EllipseStyle:

現 在 の楕 円 のスタイルを表 す値 。
l 0 = 標 準 の楕 円
l 1 = 扇形
l 2=弧

戻 り値
現 在 の楕 円 のスタイルの設 定 を取 得 する場 合 は、0と2の間 の値 が3つのスタイルのオプションの
うち1つを示 しています。スタイルの設 定 を適 用 する場 合 は、正 常 に適 用 が終 了 した場 合 は 0
(ゼロ) を返 します。いずれの場 合 も、正 常 に完 了 しないとエラーが返 されます。属 性 への書 き
込 み時 に値 が範 囲 外 の場 合 は、関 数 は終 了 し、エラー E_INVALIDARG が発 生 します。ア
クティブなオブジェクト がない場 合 は、関 数 は終 了 し、E_HANDLE を返 します。

349
Chapter: 6 グラフィックス ビルダー オートメーション インターフェース

注 :戻 り値 とエラー値 の処 理 の詳 細 については、エラー処 理 を参 照 してください。

' Applies a style (arc) to an ellipse

GraphicsBuilder.AttributeEllipseStyle = 2

' Retrieves a value representing the style applied to an ellipse

MyVariable = GraphicsBuilder.AttributeEllipseStyle

注 :この関 数 は、C++環 境 では2つの独 立 した関 数 として実 行 されます。put_

AttributeEllipseStyleは、楕 円 にスタイルを適 用 し、get_AttributeEllipseStyleは、現 在
の楕 円 のスタイルの設 定 を取 得 します。

AttributeEndAngle
弧 または扇 形 の終 了 角 度 を設 定 するか、取 得 します。
この関 数 は、選 択 されているオブジェクト (一 般 的 に、最 後 に配 置 したオブジェクト ) に適 用 さ
れます。PageSelectFirstObject()関 数 とPageSelectNextObject()関 数 を使 用 すれば、すべての
オブジェクト にアクセスして、プロパティを変 更 または読 み込 むことができます。

シンタックス
AttributeEndAngle(Angle)
Angle:

終 点 の角 度 を度 で示 す、0 ～ 360 の値 。

戻 り値
終 点 の角 度 を取 得 する場 合 は 0 ～ 360 の値 。終 点 の角 度 を適 用 する場 合 は、適 用 が正
常 に完 了 すれば 0 (ゼロ) を返 します。いずれの場 合 も、正 常 に完 了 しないとエラーが返 されま
す。属 性 への書 き込 み時 に値 が範 囲 外 の場 合 は、関 数 は終 了 し、エラー E_INVALIDARG
が発 生 します。アクティブなオブジェクト がない場 合 は、関 数 は終 了 し、E_HANDLE を返 しま
す。

注 :戻 り値 とエラー値 の処 理 の詳 細 については、エラー処 理 を参 照 してください。

関連項目
AttributeStartAngle

350
 Chapter: 6 グラフィックス ビルダー オートメーション インターフェース

' Sets the end angle of an arc

GraphicsBuilder.AttributeEndAngle = 45

' Retrieves the start angle for an arc

MyVariable = GraphicsBuilder.AttributeEndAngle

注 :この関 数 は、C++ 環 境 では 2 つの独 立 した関 数 として実 行 されます。put_

AttributeEndAngleによって終 点 の角 度 の設 定 が適 用 され、get_AttributeEndAngleによって
現 在 の終 点 の角 度 の設 定 が取 得 されます。

AttributeExtentX
アクティブなオブジェクト の範 囲 を表 すX座 標 を取 得 します。例 えば、アクティブなオブジェクト が
直 線 の場 合 、終 点 の座 標 が返 されます。この関 数 が読 み取 り専 用 であることにご注 意 くださ
い。
この関 数 は、選 択 されているオブジェクト (一 般 的 に、最 後 に配 置 したオブジェクト ) に適 用 さ
れます。PageSelectFirstObject()関 数 とPageSelectNextObject()関 数 を使 用 すれば、すべての
オブジェクト にアクセスして、プロパティを変 更 または読 み込 むことができます。

シンタックス
AttributeExtentX(XPosition)
XPosition:

0 ～ 65536 の値 。

戻 り値
0 ～ 65536 の値 。属 性 への書 き込 み時 に値 が範 囲 外 の場 合 は、関 数 は終 了 し、エラー E_
INVALIDARG が発 生 します。アクティブなオブジェクト がない場 合 は、関 数 は終 了 し、E_
HANDLE を返 します。

注 ：戻 り値 とエラー値 の処 理 の詳 細 については、エラー処 理 を参 照 してください。

関連項目
AttributeExtentY, AttributeAN

351
Chapter: 6 グラフィックス ビルダー オートメーション インターフェース

' Retrieves the X coordinate for the extent of the current object
MyVariable = GraphicsBuilder.AttributeExtentX

AttributeExtentY
アクティブなオブジェクト の範 囲 を表 す Y 座 標 を取 得 します。例 えば、アクティブなオブジェクト が
直 線 の場 合 、終 点 の座 標 が返 されます。この関 数 が読 み取 り専 用 であることにご注 意 くださ
い。
この関 数 は、選 択 されているオブジェクト (一 般 的 に、最 後 に配 置 したオブジェクト ) に適 用 さ
れます。PageSelectFirstObject()関 数 とPageSelectNextObject()関 数 を使 用 すれば、すべての
オブジェクト にアクセスして、プロパティを変 更 または読 み込 むことができます。

シンタックス
AttributeExtentY(YPosition)
YPosition:

0 ～ 65536 の値

戻 り値
0 ～ 65536 の値 。属 性 への書 き込 み時 に値 が範 囲 外 の場 合 は、関 数 は終 了 し、エラー E_
INVALIDARG が発 生 します。アクティブなオブジェクト がない場 合 は、関 数 は終 了 し、E_
HANDLE を返 します。

注 ：戻 り値 とエラー値 の処 理 の詳 細 については、エラー処 理 を参 照 してください。

関連項目
AttributeExtentX, AttributeAN

' Retrieves the Y coordinate for the extent of the current object
MyVariable = GraphicsBuilder.AttributeExtentY

AttributeFillColour
オブジェクト の塗 込 み色 を設 定 するか、現 在 の塗 込 み色 を示 す値 を取 得 します。

352
 Chapter: 6 グラフィックス ビルダー オートメーション インターフェース

この関 数 は、選 択 されているオブジェクト (一 般 的 に、最 後 に配 置 したオブジェクト ) に適 用 さ

れます。PageSelectFirstObject()関 数 とPageSelectNextObject()関 数 を使 用 すれば、すべての
オブジェクト にアクセスして、プロパティを変 更 または読 み込 むことができます。

注 : この関 数 では True Colour 機 能 がサポート されていないた

め、AttributeFillOffColourEx関 数 および AttributeFillOnColourEx関 数 に置 き換 えられ
ました。

シンタックス
AttributeFillColour(FillColour)
FillColour:

塗 込 み色 を示 す 0 ～ 255 の値 。

戻 り値
現 在 の塗 込 み色 を取 得 する場 合 は、0 ～ 255 の値 。塗 込 み色 を適 用 する場 合 は、正 常 に
適 用 が完 了 すれば 0 (ゼロ)。いずれの場 合 も、正 常 に完 了 しないとエラーが返 されます。属
性 への書 き込 み時 に値 が範 囲 外 の場 合 は、関 数 は終 了 し、エラー E_INVALIDARG が発
生 します。アクティブなオブジェクト がない場 合 は、関 数 は終 了 し、E_HANDLE を返 します。

注 :戻 り値 とエラー値 の処 理 の詳 細 については、エラー処 理 を参 照 してください。

関連項目
AttributeSetFill

' Sets the fill color for an object

GraphicsBuilder.AttributeFillColour = 125

' Retrieves the value of the fill color

MyVariable = GraphicsBuilder.AttributeFillColour

注 :この関 数 は、C++環 境 では2つの独 立 した関 数 として実 行 されます。put_

AttributeFillColourにより、塗 込 み色 の設 定 が適 用 され、get_AttributeFillColourによ
り、現 在 の塗 込 み色 の設 定 が取 得 されます。

AttributeFillOffColourEx
オブジェクト の塗 込 み色 を設 定 するか、現 在 の塗 込 み色 を示 す値 を取 得 します。

353
Chapter: 6 グラフィックス ビルダー オートメーション インターフェース

この関 数 は、選 択 されているオブジェクト (一 般 的 に、最 後 に配 置 したオブジェクト ) に適 用 さ

れます。PageSelectFirstObject()関 数 とPageSelectNextObject()関 数 を使 用 すれば、すべての
オブジェクト にアクセスして、プロパティを変 更 または読 み込 むことができます。

シンタックス
AttributeFillOffColourEx(FillColour)
FillColour:

RGB 値 。

戻 り値
現 在 の塗 込 み色 を取 得 する場 合 は、RGB 値 。塗 込 み色 を適 用 する場 合 は、正 常 に適 用
が終 了 した場 合 は 0 (ゼロ) を返 します。いずれの場 合 も、正 常 に完 了 しないとエラーが返 され
ます。属 性 への書 き込 み時 に値 が範 囲 外 の場 合 は、関 数 は終 了 し、エラー E_
INVALIDARG が発 生 します。アクティブなオブジェクト がない場 合 は、関 数 は終 了 し、E_
HANDLE を返 します。

注 ：戻 り値 とエラー値 の処 理 の詳 細 については、エラー処 理 を参 照 してください。

関連項目
AttributeSetFill

' Sets the fill color for an object

GraphicsBuilder.AttributeFillOffColourEx = &hFF0000

' Retrieves the value of the fill color

MyVariable = GraphicsBuilder.AttributeFillOffColourEx

この関 数 は、C++ 環 境 では 2 つの独 立 した関 数 として実 行 されます。put_

AttributeFillOffColourExにより、塗 込 み色 の設 定 が適 用 され、get_
AttributeFillOffColourExにより、現 在 の塗 込 み色 の設 定 が取 得 されます。

AttributeFillOnColourEx
オブジェクト の塗 り込 み色 を設 定 するか、現 在 の塗 り込 み色 を示 す値 を取 得 します。
この関 数 は、選 択 されているオブジェクト (一 般 的 に、最 後 に配 置 したオブジェクト ) に適 用 さ
れます。PageSelectFirstObject()関 数 とPageSelectNextObject()関 数 を使 用 すれば、すべての
オブジェクト にアクセスして、プロパティを変 更 または読 み込 むことができます。

354
 Chapter: 6 グラフィックス ビルダー オートメーション インターフェース

シンタックス
AttributeFillOnColourEx (FillColour)
FillColour:

RGB 値 。

戻 り値
現 在 の塗 り込 み色 を取 得 する場 合 は、RGB 値 。塗 り込 み色 を適 用 する場 合 は、正 常 に適
用 が終 了 した場 合 は 0 (ゼロ) を返 します。いずれの場 合 も、正 常 に完 了 しないとエラーが返
されます。属 性 への書 き込 み時 に値 が範 囲 外 の場 合 は、関 数 は終 了 し、エラー E_
INVALIDARG が発 生 します。アクティブなオブジェクト がない場 合 は、関 数 は終 了 し、E_
HANDLE を返 します。

注 ：戻 り値 とエラー値 の処 理 の詳 細 については、エラー処 理 を参 照 してください。

関連項目
AttributeSetFill

' Sets the fill color for an object

GraphicsBuilder.AttributeFillOnColourEx = &hFF0000

' Retrieves the value of the fill color

MyVariable = GraphicsBuilder.AttributeFillOnColourEx

この関 数 は、C++ 環 境 では 2 つの独 立 した関 数 として実 行 されます。put_

AttributeFillOnColourExにより、塗 り込 み色 の設 定 が適 用 され、get_AttributeFillOnColourEx
により、現 在 の塗 り込 み色 の設 定 が取 得 されます。

AttributeGradientMode
現 在 のオブジェクト に対 する [オブジェクト のプロパティ] ダイアログ ボックスの [全 般 | 表 示 ] タブ
で、階 調 度 の方 向 を設 定 または取 得 します。
この関 数 は、四 角 形 のオブジェクト でのみサポート されています。

シンタックス
AttributeGradientMode(Mode)
モード :

階 調 度 の方 向 です。

355
Chapter: 6 グラフィックス ビルダー オートメーション インターフェース

0 - オフ
1 - 左 から右 へ
2 - 右 から左 へ
3 - 先 頭 から終 わりまで
4 - 終 わりから先 頭 まで
5 - 水 平 方 向 のエッジから中 央 へ
6 - 中 央 から水 平 方 向 のエッジへ
7 - 垂 直 方 向 のエッジから中 央 へ
8 - 中 央 から垂 直 方 向 のエッジへ

戻 り値
階 調 度 のモード を取 得 する場 合 は、上 記 の階 調 度 の方 向 。階 調 度 のモード を適 用 する場
合 は、正 常 に適 用 が終 了 した場 合 は 0 (ゼロ) を返 します。いずれの場 合 も、正 常 に完 了 し
ないとエラーが返 されます。属 性 への書 き込 み時 に値 が範 囲 外 の場 合 は、関 数 は終 了 し、エ
ラー E_INVALIDARG が発 生 します。アクティブなオブジェクト がない場 合 は、関 数 は終 了
し、E_HANDLE を返 します。

AttributeGradientOffColour
現 在 のオブジェクト に対 する [オブジェクト のプロパティ] ダイアログ ボックスの [全 般 | 表 示 ] タブ
で、「オフ」部 分 の階 調 度 の色 を設 定 または取 得 します。
この関 数 は、四 角 形 のオブジェクト でのみサポート されています。

シンタックス
AttributeGradientOffColour(Color)
色:

「オフ」の部 分 の階 調 度 の色 です。

戻 り値
階 調 度 の色 を取 得 する場 合 は、RGB でエンコード された値 。階 調 度 の色 を適 用 する場 合 、
正 常 に適 用 が終 了 した場 合 は 0 (ゼロ) を返 します。いずれの場 合 も、正 常 に完 了 しないとエ
ラーが返 されます。属 性 への書 き込 み時 に値 が範 囲 外 の場 合 は、関 数 は終 了 し、エラー E_
INVALIDARG が発 生 します。アクティブなオブジェクト がない場 合 は、関 数 は終 了 し、E_
HANDLE を返 します。

AttributeGradientOnColour
現 在 のオブジェクト に対 する [オブジェクト のプロパティ] ダイアログ ボックスの [全 般 | 表 示 ] タブ
で、「オン」部 分 の階 調 度 の色 を設 定 または取 得 します。
この関 数 は、四 角 形 のオブジェクト でのみサポート されています。

356
 Chapter: 6 グラフィックス ビルダー オートメーション インターフェース

シンタックス
AttributeGradientOnColour(Color)
色:

「オン」の部 分 の階 調 度 の色 です。

戻 り値
階 調 度 の色 を取 得 する場 合 は、RGB でエンコード された値 。階 調 度 の色 を適 用 する場 合 、
正 常 に適 用 が終 了 した場 合 は 0 (ゼロ) を返 します。いずれの場 合 も、正 常 に完 了 しないとエ
ラーが返 されます。属 性 への書 き込 み時 に値 が範 囲 外 の場 合 は、関 数 は終 了 し、エラー E_
INVALIDARG が発 生 します。アクティブなオブジェクト がない場 合 は、関 数 は終 了 し、E_
HANDLE を返 します。

AttributeHiLightColour
3D 効 果 の [浮 き出 し]、[凹 み]、または [浮 き彫 り] に適 用 するハイライト 色 を設 定 するか、また
は現 在 のハイライト 色 の設 定 を取 得 します。
この関 数 は、選 択 されているオブジェクト (一 般 的 に、最 後 に配 置 したオブジェクト ) に適 用 さ
れます。PageSelectFirstObject()関 数 と PageSelectNextObject()関 数 を使 用 すれば、すべての
オブジェクト にアクセスして、プロパティを変 更 または読 み込 むことができます。

注 : この関 数 では True Colour 機 能 がサポート されていないた

め、AttributeHiLightOnColourEx関 数 および AttributeHiLightOffColourEx関 数 に置 き
換 えられました。

シンタックス
AttributeHiLightColour(HiLightColour)
HiLightColour:

ハイライト 色 を示 す 0 ～ 255 の値 。

戻 り値
現 在 のハイライト 色 の設 定 を取 得 する場 合 は、0 ～ 255 の値 。ハイライト 色 を適 用 する場 合
は、正 常 に適 用 が完 了 すれば 0 (ゼロ)。いずれの場 合 も、正 常 に完 了 しないとエラーが返 さ
れます。属 性 への書 き込 み時 に値 が範 囲 外 の場 合 は、関 数 は終 了 し、エラー E_
INVALIDARG が発 生 します。アクティブなオブジェクト がない場 合 は、関 数 は終 了 し、E_
HANDLE を返 します。

注 :戻 り値 とエラー値 の処 理 の詳 細 については、エラー処 理 を参 照 してください。

357
Chapter: 6 グラフィックス ビルダー オートメーション インターフェース

関連項目
Attribute3dEffects, Attribute3dEffectDepth, AttributeShadowColour,
AttributeLoLightColour

' Applies a highlight color to a 3D effect

GraphicsBuilder.AttributeHiLightColour = 125

' Retrieves a value representing a 3D effect's highlight color

MyVariable = GraphicsBuilder.AttributeHiLightColour

注 :この関 数 は、C++ 環 境 では 2 つの独 立 した関 数 として実 行 されます。put_

AttributeHiLightColourによってハイライト 色 の設 定 が適 用 され、get_
AttributeHiLightColourによって現 在 のハイライト 色 の設 定 が取 得 されます。

AttributeHiLightOffColourEx
3D効 果 の [浮 き出 し]、[凹 み]、または [浮 き彫 り] に適 用 するハイライト 色 を設 定 するか、また
は現 在 のハイライト 色 の設 定 を取 得 します。
この関 数 は、選 択 されているオブジェクト (一 般 的 に、最 後 に配 置 したオブジェクト ) に適 用 さ
れます。PageSelectFirstObject()関 数 とPageSelectNextObject()関 数 を使 用 すれば、すべての
オブジェクト にアクセスして、プロパティを変 更 または読 み込 むことができます。

シンタックス
AttributeHiLightOffColourEx(HiLightColour)
HiLightColour:

RGB 値 。

戻 り値
現 在 のハイライト 色 の設 定 を取 得 する場 合 は、RGB 値 。ハイライト 色 を適 用 する場 合 は、正
常 に適 用 が終 了 した場 合 は 0 (ゼロ) を返 します。いずれの場 合 も、正 常 に完 了 しないとエ
ラーが返 されます。属 性 への書 き込 み時 に値 が範 囲 外 の場 合 は、関 数 は終 了 し、エラー E_
INVALIDARG が発 生 します。アクティブなオブジェクト がない場 合 は、関 数 は終 了 し、E_
HANDLE を返 します。

注 ：戻 り値 とエラー値 の処 理 の詳 細 については、エラー処 理 を参 照 してください。

358
 Chapter: 6 グラフィックス ビルダー オートメーション インターフェース

関連項目
Attribute3dEffects, Attribute3dEffectDepth, AttributeShadowOffColourEx,
AttributeShadowOnColourEx, AttributeLoLightOffColourEx,
AttributeLoLightOnColourEx

' Applies a highlight color to a 3D effect

GraphicsBuilder.AttributeHiLightOffColourEx = &hFF0000

' Retrieves a value representing a 3D effect's highlight color

MyVariable = GraphicsBuilder.AttributeHiLightOffColourEx

この関 数 は、C++ 環 境 では 2 つの独 立 した関 数 として実 行 されます。put_

AttributeHiLightOffColourExによってハイライト 色 の設 定 が適 用 され、get_
AttributeHiLightOffColourExによって現 在 のハイライト 色 の設 定 が取 得 されます。

AttributeHiLightOnColourEx
3D 効 果 の [浮 き出 し]、[凹 み]、または [浮 き彫 り] に適 用 するハイライト 色 を設 定 するか、また
は現 在 のハイライト 色 の設 定 を取 得 します。
この関 数 は、選 択 されているオブジェクト (一 般 的 に、最 後 に配 置 したオブジェクト ) に適 用 さ
れます。PageSelectFirstObject()関 数 とPageSelectNextObject()関 数 を使 用 すれば、すべての
オブジェクト にアクセスして、プロパティを変 更 または読 み込 むことができます。

シンタックス
AttributeHiLightOnColourEx(HiLightColour)
HiLightColour:

RGB 値 。

戻 り値
現 在 のハイライト 色 の設 定 を取 得 する場 合 は、RGB 値 。ハイライト 色 を適 用 する場 合 は、正
常 に適 用 が終 了 した場 合 は 0 (ゼロ) を返 します。いずれの場 合 も、正 常 に完 了 しないとエ
ラーが返 されます。属 性 への書 き込 み時 に値 が範 囲 外 の場 合 は、関 数 は終 了 し、エラー E_
INVALIDARG が発 生 します。アクティブなオブジェクト がない場 合 は、関 数 は終 了 し、E_
HANDLE を返 します。

注 ：戻 り値 とエラー値 の処 理 の詳 細 については、エラー処 理 を参 照 してください。

359
Chapter: 6 グラフィックス ビルダー オートメーション インターフェース

関連項目
Attribute3dEffects, Attribute3dEffectDepth, AttributeShadowOffColourEx,
AttributeShadowOnColourEx, AttributeLoLightOffColourEx,
AttributeLoLightOnColourEx

' Applies a highlight color to a 3D effect

GraphicsBuilder.AttributeHiLightOnColourEx = &hFF0000

' Retrieves a value representing a 3D effect's highlight color

MyVariable = GraphicsBuilder.AttributeHiLightOnColourEx

この関 数 は、C++ 環 境 では 2 つの独 立 した関 数 として実 行 されます。put_

AttributeHiLightOnColourExによってハイライト 色 の設 定 が適 用 され、get_
AttributeHiLightOnColourExによって現 在 のハイライト 色 の設 定 が取 得 されます。

AttributeLineColour
直 線 に色 を適 用 します。または、現 在 の色 の設 定 を取 得 します。
この関 数 は、選 択 されているオブジェクト (一 般 的 に、最 後 に配 置 したオブジェクト ) に適 用 さ
れます。PageSelectFirstObject()関 数 とPageSelectNextObject()関 数 を使 用 すれば、すべての
オブジェクト にアクセスして、プロパティを変 更 または読 み込 むことができます。

注 :この関 数 では True Colour 機 能 がサポート されていないた

め、AttributeLineOnColourEx関 数 および AttributeLineOffColourEx関 数 に置 き換 えら
れました。

シンタックス
AttributeLineColour(LineColour)
LineColour:

特 定 の色 を表 す 0 ～ 255 の値 。

戻 り値
現 在 の線 の色 を取 得 する場 合 は、0 ～ 255 の値 。線 の色 を設 定 する場 合 は、正 常 に設 定
が完 了 すれば 0 (ゼロ)。いずれの場 合 も、正 常 に完 了 しないとエラーが返 されます。属 性 への
書 き込 み時 に値 が範 囲 外 の場 合 は、関 数 は終 了 し、エラー E_INVALIDARG が発 生 しま
す。アクティブなオブジェクト がない場 合 は、関 数 は終 了 し、E_HANDLE を返 します。

360
 Chapter: 6 グラフィックス ビルダー オートメーション インターフェース

注 :戻 り値 とエラー値 の処 理 の詳 細 については、エラー処 理 を参 照 してください。

関連項目
AttributeLineWidth, AttributeLineStyle

' Applies a color to the current line

GraphicsBuilder.AttributeLineColour = 125

' Retrieves the value of the color applied to the current line
MyVariable = GraphicsBuilder.AttributeLineColour

注 :この関 数 は、C++ 環 境 では 2 つの独 立 した関 数 として実 行 されます。put_

AttributeLineColourは、直 線 に特 定 の色 を適 用 し、get_AttributeLineColourは、現 在 の
色 の設 定 を取 得 します。

AttributeLineOffColourEx
直 線 に色 を適 用 するか、現 在 の「オフ」の色 の設 定 を取 得 します。この関 数 では、パレット イン
デックスではなく、各 マルチステート の色 に RGB 色 が使 用 されます。
この関 数 は、選 択 されているオブジェクト (一 般 的 に、最 後 に配 置 したオブジェクト ) に適 用 さ
れます。PageSelectFirstObject()関 数 とPageSelectNextObject()関 数 を使 用 すれば、すべての
オブジェクト にアクセスして、プロパティを変 更 または読 み込 むことができます。

シンタックス
AttributeLineOffColourEx (LineColour)
LineColour:

RGB 値 。

戻 り値
現 在 の線 の色 を取 得 する場 合 は、RGB 値 。線 の色 を設 定 する場 合 は、正 常 に設 定 が完
了 した場 合 は 0 (ゼロ) を返 します。いずれの場 合 も、正 常 に完 了 しないとエラーが返 されま
す。属 性 への書 き込 み時 に値 が範 囲 外 の場 合 は、関 数 は終 了 し、エラー E_INVALIDARG
が発 生 します。アクティブなオブジェクト がない場 合 は、関 数 は終 了 し、E_HANDLE を返 しま
す。

注 ：戻 り値 とエラー値 の処 理 の詳 細 については、エラー処 理 を参 照 してください。

361
Chapter: 6 グラフィックス ビルダー オートメーション インターフェース

関連項目
AttributeLineWidth, AttributeLineStyle

' Applies a color to the current line

GraphicsBuilder.AttributeLineOffColourEx = &hFF0000

' Retrieves the value of the color applied to the current line
MyVariable = GraphicsBuilder.AttributeLineOffColourEx

この関 数 は、C++ 環 境 では 2 つの独 立 した関 数 として実 行 されます。put_

AttributeLineOffColourExは、直 線 に特 定 の色 を適 用 し、get_AttributeLineOffColourExは、
現 在 の色 の設 定 を取 得 します。

AttributeLineOnColourEx
直 線 に色 を適 用 するか、現 在 の「オン」の色 の設 定 を取 得 します。この関 数 では、パレット イ
ンデックスではなく、各 マルチステート の色 に RGB 色 が使 用 されます。
この関 数 は、選 択 されているオブジェクト (一 般 的 に、最 後 に配 置 したオブジェクト ) に適 用 さ
れます。PageSelectFirstObject()関 数 とPageSelectNextObject()関 数 を使 用 すれば、すべての
オブジェクト にアクセスして、プロパティを変 更 または読 み込 むことができます。

シンタックス
AttributeLineOnColourEx (LineColour)
LineColour:

RGB 値 。

戻 り値
現 在 の線 の色 を取 得 する場 合 は、RGB 値 。線 の色 を設 定 する場 合 は、正 常 に設 定 が完
了 した場 合 は 0 (ゼロ) を返 します。いずれの場 合 も、正 常 に完 了 しないとエラーが返 されま
す。属 性 への書 き込 み時 に値 が範 囲 外 の場 合 は、関 数 は終 了 し、エラー E_INVALIDARG
が発 生 します。アクティブなオブジェクト がない場 合 は、関 数 は終 了 し、E_HANDLE を返 しま
す。

注 ：戻 り値 とエラー値 の処 理 の詳 細 については、エラー処 理 を参 照 してください。

関連項目
AttributeLineWidth, AttributeLineStyle

362
 Chapter: 6 グラフィックス ビルダー オートメーション インターフェース

' Applies a color to the current line

GraphicsBuilder.AttributeLineOnColourEx = &hFF0000

' Retrieves the value of the color applied to the current line
MyVariable = GraphicsBuilder.AttributeLineOnColourEx

この関 数 は、C++ 環 境 では 2 つの独 立 した関 数 として実 行 されます。put_

AttributeLineOnColourExは、直 線 に特 定 の色 を適 用 し、get_AttributeLineOnColourExは、現
在 の色 の設 定 を取 得 します。

AttributeLineStyle
直 線 にスタイルを適 用 します。または、現 在 のスタイルの設 定 を取 得 します。直 線 にスタイルを
適 用 できるのは、線 の幅 が 1 に設 定 されている場 合 のみです。
この関 数 は、選 択 されているオブジェクト (一 般 的 に、最 後 に配 置 したオブジェクト ) に適 用 さ
れます。PageSelectFirstObject()関 数 とPageSelectNextObject()関 数 を使 用 すれば、すべての
オブジェクト にアクセスして、プロパティを変 更 または読 み込 むことができます。

シンタックス
AttributeLineStyle (LineStyle)
LineStyle:

直 線 に適 用 するスタイルを示 す 0 ～ 4 の値 。直 線 のスタイルは、線 の幅 が 1 に設 定 されている場 合 にの

み使 用 できます。
l 0 = 実線
l 1 = 破線
l 2 = 点線
l 3 = 1点 破 線
l 4 = 2点 破 線

戻 り値
現 在 の直 線 のスタイルを取 得 する場 合 は、特 定 のスタイルを示 す 0 ～ 4 の値 。直 線 のスタイ
ルを設 定 する場 合 は、正 常 に設 定 が完 了 した場 合 は 0 (ゼロ) を返 します。いずれの場 合
も、正 常 に完 了 しないとエラーが返 されます。属 性 への書 き込 み時 に値 が範 囲 外 の場 合 は、
関 数 は終 了 し、エラー E_INVALIDARG が発 生 します。アクティブなオブジェクト がない場 合
は、関 数 は終 了 し、E_HANDLE を返 します。

注 :戻 り値 とエラー値 の処 理 の詳 細 については、エラー処 理 を参 照 してください。

363
Chapter: 6 グラフィックス ビルダー オートメーション インターフェース

関連項目
AttributeLineWidth, AttributeLineColour

' Applies a style (dash dot) to the current line

GraphicsBuilder.AttributeLineStyle = 3

' Retrieves the style applied to the current line

MyVariable = GraphicsBuilder.AttributeLineStyle

注 :この関 数 は、C++ 環 境 では 2 つの独 立 した関 数 として実 行 されます。put_

AttributeLineStyleによって特 定 の直 線 のスタイルが適 用 され、get_AttributeLineStyleに
よって現 在 のスタイルの設 定 が取 得 されます。

AttributeLineWidth
直 線 の幅 を設 定 します。または現 在 の幅 を取 得 します。
この関 数 は、選 択 されているオブジェクト (一 般 的 に、最 後 に配 置 したオブジェクト ) に適 用 さ
れます。PageSelectFirstObject() 関 数 とPageSelectNextObject()関 数 を使 用 すれば、すべての
オブジェクト にアクセスして、プロパティを変 更 または読 み込 むことができます。

シンタックス
AttributeLineWidth (LineWidth)
LineWidth:

線 の幅 をピクセル数 で示 す、0 ～ 32 の値 。

戻 り値
現 在 の線 の幅 を取 得 する場 合 は、線 の幅 を示 す 1 ～ 32 の値 (ピクセル数 ) が返 されます。
線 の幅 を設 定 する場 合 は、正 常 に設 定 が完 了 した場 合 は 0 (ゼロ) を返 します。いずれの場
合 も、正 常 に完 了 しないとエラーが返 されます。属 性 への書 き込 み時 に値 が範 囲 外 の場 合
は、関 数 は終 了 し、エラー E_INVALIDARG が発 生 します。アクティブなオブジェクト がない場
合 は、関 数 は終 了 し、E_HANDLE を返 します。

注 ：戻 り値 とエラー値 の処 理 の詳 細 については、エラー処 理 を参 照 してください。

関連項目
AttributeLineStyle, AttributeLoLightColour

364
 Chapter: 6 グラフィックス ビルダー オートメーション インターフェース

' Sets the width for the current line

GraphicsBuilder.AttributeLineWidth = 1

' Retrieves the width of the current line

MyVariable = GraphicsBuilder.AttributeLineWidth

この関 数 は、C++ 環 境 では 2 つの独 立 した関 数 として実 行 されます。put_

AttributeLineWidthによって線 の幅 の値 が設 定 され、get_AttributeLineWidthによって現 在 の
線 幅 の設 定 が取 得 されます。

AttributeLoLightColour
3D 効 果 の [浮 き出 し]、[凹 み]、または [浮 き彫 り] に適 用 するローライト 色 を設 定 するか、また
は現 在 のローライト 色 の設 定 を取 得 します。
この関 数 は、選 択 されているオブジェクト (一 般 的 に、最 後 に配 置 したオブジェクト ) に適 用 さ
れます。PageSelectFirstObject()関 数 とPageSelectNextObject()関 数 を使 用 すれば、すべての
オブジェクト にアクセスして、プロパティを変 更 または読 み込 むことができます。

シンタックス
AttributeLoLightColour(LoLightColour)
LoLightColour:

ローライト 色 を示 す 0 ～ 255 の値 。

戻 り値
現 在 のローライト 色 の設 定 を取 得 する場 合 は、0 ～ 255 の値 。ローライト 色 を適 用 する場 合
は、正 常 に適 用 が完 了 すれば 0 (ゼロ)。いずれの場 合 も、正 常 に完 了 しないとエラーが返 さ
れます。属 性 への書 き込 み時 に値 が範 囲 外 の場 合 は、関 数 は終 了 し、エラー E_
INVALIDARG が発 生 します。アクティブなオブジェクト がない場 合 は、関 数 は終 了 し、E_
HANDLE を返 します。

注 ：戻 り値 とエラー値 の処 理 の詳 細 については、エラー処 理 を参 照 してください。

関連項目
Attribute3dEffects, Attribute3dEffectDepth, AttributeShadowColour,
AttributeHiLightColour

365
Chapter: 6 グラフィックス ビルダー オートメーション インターフェース

' Applies a lowlight color to a 3D effect

GraphicsBuilder.AttributeLoLightColour = 45

' Retrieves a value representing a 3D effect's lowlight color

MyVariable = GraphicsBuilder.AttributeLoLightColour

この関 数 は、C++ 環 境 では 2 つの独 立 した関 数 として実 行 されます。put_

AttributeLoLightColourによってローライト 色 の設 定 が適 用 され、get_AttributeLoLightColour
によって現 在 のローライト 色 の設 定 が取 得 されます。

AttributeLoLightOffColourEx
3D効 果 の [浮 き出 し]、[凹 み]、または [浮 き彫 り] に適 用 するローライト 色 を設 定 するか、また
は現 在 のローライト 色 の設 定 を取 得 します。
この関 数 は、選 択 されているオブジェクト (一 般 的 に、最 後 に配 置 したオブジェクト ) に適 用 さ
れます。PageSelectFirstObject()関 数 とPageSelectNextObject()関 数 を使 用 すれば、すべての
オブジェクト にアクセスして、プロパティを変 更 または読 み込 むことができます。

シンタックス
AttributeLoLightOffColourEx(LoLightColour)
LoLightColour:

RGB 値 。

戻 り値
現 在 のローライト 色 の設 定 を取 得 する場 合 は、RGB 値 。ローライト 色 を適 用 する場 合 は、正
常 に適 用 が終 了 した場 合 は 0 (ゼロ) を返 します。いずれの場 合 も、正 常 に完 了 しないとエ
ラーが返 されます。属 性 への書 き込 み時 に値 が範 囲 外 の場 合 は、関 数 は終 了 し、エラー E_
INVALIDARG が発 生 します。アクティブなオブジェクト がない場 合 は、関 数 は終 了 し、E_
HANDLE を返 します。

注 ：戻 り値 とエラー値 の処 理 の詳 細 については、エラー処 理 を参 照 してください。

関連項目
Attribute3dEffects, Attribute3dEffectDepth,
AttributeShadowOffColourEx,AttributeShadowOnColourEx,
AttributeHiLightOffColourEx, AttributeHiLightOnColourEx

366
 Chapter: 6 グラフィックス ビルダー オートメーション インターフェース

' Applies a lowlight color to a 3D effect

GraphicsBuilder.AttributeLoLightOffColourEx = &hFF0000

' Retrieves a value representing a 3D effect's lowlight color

MyVariable = GraphicsBuilder.AttributeLoLightOffColourEx

この関 数 は、C++ 環 境 では 2 つの独 立 した関 数 として実 行 されます。put_

AttributeLoLightOffColourExによってローライト 色 の設 定 が適 用 され、get_
AttributeLoLightOffColourExによって現 在 のローライト 色 の設 定 が取 得 されます。

AttributeLoLightOnColourEx
3D 効 果 の [浮 き出 し]、[凹 み]、または [浮 き彫 り] に適 用 するローライト 色 を設 定 するか、また
は現 在 のローライト 色 の設 定 を取 得 します。
この関 数 は、選 択 されているオブジェクト (一 般 的 に、最 後 に配 置 したオブジェクト ) に適 用 さ
れます。PageSelectFirstObject()関 数 とPageSelectNextObject()関 数 を使 用 すれば、すべての
オブジェクト にアクセスして、プロパティを変 更 または読 み込 むことができます。

シンタックス
AttributeLoLightOnColourEx(LoLightColour)
LoLightColour:

RGB 値 。

戻 り値
現 在 のローライト 色 の設 定 を取 得 する場 合 は、RGB 値 。ローライト 色 を適 用 する場 合 は、正
常 に適 用 が終 了 した場 合 は 0 (ゼロ) を返 します。いずれの場 合 も、正 常 に完 了 しないとエ
ラーが返 されます。属 性 への書 き込 み時 に値 が範 囲 外 の場 合 は、関 数 は終 了 し、エラー E_
INVALIDARG が発 生 します。アクティブなオブジェクト がない場 合 は、関 数 は終 了 し、E_
HANDLE を返 します。

注 ：戻 り値 とエラー値 の処 理 の詳 細 については、エラー処 理 を参 照 してください。

関連項目
Attribute3dEffects, Attribute3dEffectDepth,
AttributeShadowOffColourEx,AttributeShadowOnColourEx,
AttributeHiLightOffColourEx, AttributeHiLightOnColourEx

367
Chapter: 6 グラフィックス ビルダー オートメーション インターフェース

' Applies a lowlight color to a 3D effect

GraphicsBuilder.AttributeLoLightOnColourEx = &hFF0000

' Retrieves a value representing a 3D effect's lowlight color

MyVariable = GraphicsBuilder.AttributeLoLightOnColourEx

この関 数 は、C++ 環 境 では 2 つの独 立 した関 数 として実 行 されます。put_

AttributeLoLightOnColourExによってローライト 色 の設 定 が適 用 され、get_
AttributeLoLightOnColourExによって現 在 のローライト 色 の設 定 が取 得 されます。

AttributeNodeCoordinatesFirst
フリーハンド 線 、多 角 形 、またはパイプの最 初 のノード の座 標 を返 します。
この関 数 は、選 択 されているオブジェクト (一 般 的 に、最 後 に配 置 したオブジェクト ) に適 用 さ
れます。PageSelectFirstObject()関 数 とPageSelectNextObject()関 数 を使 用 すれば、すべての
オブジェクト にアクセスして、プロパティを変 更 または読 み込 むことができます。

シンタックス
AttributeNodeCoordinatesFirst(XPosition, YPosition)
XPosition:

ページの左 側 からオブジェクト の最 初 のノードまでの、ピクセルによる距 離 です。

YPosition:

ページの最 上 部 からオブジェクト の最 初 のノードまでの、ピクセルによる距 離 です。

戻 り値
現 在 のオブジェクト の最 初 のノード の座 標 。属 性 への書 き込 み時 に値 が範 囲 外 の場 合 は、
関 数 は終 了 し、エラー E_INVALIDARG が発 生 します。アクティブなオブジェクト がない場 合
は、関 数 は終 了 し、E_HANDLE を返 します。

注 ：戻 り値 とエラー値 の処 理 の詳 細 については、エラー処 理 を参 照 してください。

関連項目
AttributeNodeCoordinatesNext

AttributeNodeCoordinatesNext

368
 Chapter: 6 グラフィックス ビルダー オートメーション インターフェース

AttributeNodeCoordinatesFirst の実 装 後 に、次 のフリー ハンド 線 、多 角 形 、またはパイプの

後 続 のノード の座 標 を返 します。
この関 数 は、選 択 されているオブジェクト (一 般 的 に、最 後 に配 置 したオブジェクト ) に適 用 さ
れます。PageSelectFirstObject()関 数 とPageSelectNextObject()関 数 を使 用 すれば、すべての
オブジェクト にアクセスして、プロパティを変 更 または読 み込 むことができます。

シンタックス
AttributeNodeCoordinatesNext(XPosition, YPosition)
XPosition:

ページの左 側 からオブジェクト の最 初 のノードまでの、ピクセルによる距 離 です。

YPosition:

ページの最 上 部 からオブジェクト の最 初 のノードまでの、ピクセルによる距 離 です。

オブジェクト の後 続 ノード の座 標 、またはノード が残 っていない場 合 、E_ABORT が発 生 しま

す。属 性 への書 き込 み時 に値 が範 囲 外 の場 合 は、関 数 は終 了 し、エラー E_INVALIDARG
が発 生 します。アクティブなオブジェクト がない場 合 は、関 数 は終 了 し、E_HANDLE を返 しま
す。

注 ：戻 り値 とエラー値 の処 理 の詳 細 については、エラー処 理 を参 照 してください。

関連項目
AttributeNodeCoordinatesFirst

AttributePolygonOpen
多 角 形 (ポリライン) がオープン モード (つまり、2 つの終 点 が結 合 されていない) に設 定 されて
いるか、クローズ モード (2 つの終 点 が結 合 されている) かを定 義 します。また、現 在 のオープン
モード 設 定 を取 得 することもできます。
この関 数 は、選 択 されているオブジェクト (一 般 的 に、最 後 に配 置 したオブジェクト ) に適 用 さ
れます。PageSelectFirstObject()関 数 とPageSelectNextObject()関 数 を使 用 すれば、すべての
オブジェクト にアクセスして、プロパティを変 更 または読 み込 むことができます。

シンタックス
AttributePolygonOpen(OpenClose)
OpenClose:

TRUE = 多 角 形 はオープン モードで描 画 されます。FALSE = 多 角 形 はクローズ モードで描 画 されます。

369
Chapter: 6 グラフィックス ビルダー オートメーション インターフェース

戻 り値
多 角 形 の現 在 のモード 設 定 を取 得 する場 合 、真 (TRUE) または偽 (FALSE) が返 されます。
モード を設 定 する場 合 、設 定 が正 常 に完 了 した場 合 は 0 (ゼロ) を返 します。いずれの場 合
も、正 常 に完 了 しないとエラーが返 されます。属 性 への書 き込 み時 に値 が範 囲 外 の場 合 は、
関 数 は終 了 し、エラー E_INVALIDARG が発 生 します。アクティブなオブジェクト がない場 合
は、関 数 は終 了 し、E_HANDLE を返 します。

注 :戻 り値 とエラー値 の処 理 の詳 細 については、エラー処 理 を参 照 してください。

' Sets a polygon to Open mode

GraphicsBuilder.AttributePolygonOpen = TRUE

' Determines if the current polygon is defined as Open

MyVariable = GraphicsBuilder.AttributePolygonOpen

注 :この関 数 は、C++ 環 境 では 2 つの独 立 した関 数 として実 行 されます。put_

AttributePolygonOpenは、多 角 形 のオープン モード を設 定 し、get_AttributePolygonOpen
は、現 在 のオープン モード を取 得 します。

AttributeRectangleStyle
四 角 形 のスタイルを設 定 します。または、四 角 形 のスタイルの設 定 を取 得 します。
この関 数 は、選 択 されているオブジェクト (一 般 的 に、最 後 に配 置 したオブジェクト ) に適 用 さ
れます。PageSelectFirstObject()関 数 とPageSelectNextObject()関 数 を使 用 すれば、すべての
オブジェクト にアクセスして、プロパティを変 更 または読 み込 むことができます。

シンタックス
AttributeRectangleStyle(Style)
Style:

0 = なし

1 = 枠線

2 = 罫線

3 = 枠 線 と罫 線

370
 Chapter: 6 グラフィックス ビルダー オートメーション インターフェース

戻 り値
現 在 の四 角 形 のスタイル設 定 を取 得 する場 合 は、0 ～ 3 の値 。四 角 形 のスタイルを適 用 す
る場 合 、正 常 に適 用 が完 了 すれば 0 (ゼロ)。いずれの場 合 も、正 常 に完 了 しないとエラーが
返 されます。属 性 への書 き込 み時 に値 が範 囲 外 の場 合 は、関 数 は終 了 し、エラー E_
INVALIDARG が発 生 します。アクティブなオブジェクト がない場 合 は、関 数 は終 了 し、E_
HANDLE を返 します。

注 :戻 り値 とエラー値 の処 理 の詳 細 については、エラー処 理 を参 照 してください。

関連項目
Attribute3dEffects, Attribute3dEffectDepth, AttributeShadowColour,
AttributeHiLightColour

' Applies a style to a rectangle

GraphicsBuilder.AttributeRectangleStyle = 1

' Retrieves a value representing a rectangle style

MyVariable = GraphicsBuilder.AttributeRectangleStyle

注 :この関 数 は、C++ 環 境 では 2 つの独 立 した関 数 として実 行 されます。put_

AttributeRectangleStyleにより、四 角 形 のスタイルが適 用 され、get_
AttributeRectangleStyleにより、現 在 の四 角 形 のスタイル設 定 が取 得 されます。

AttributeSetFill
オブジェクト を塗 り込 みとして表 示 します。または現 在 の塗 り込 みの値 を取 得 します。
この関 数 は、選 択 されているオブジェクト (一 般 的 に、最 後 に配 置 したオブジェクト ) に適 用 さ
れます。PageSelectFirstObject()関 数 とPageSelectNextObject()関 数 を使 用 すれば、すべての
オブジェクト にアクセスして、プロパティを変 更 または読 み込 むことができます。

シンタックス
AttributeSetFill(SetFill)
SetFill:

オブジェクト が塗 り込 まれる場 合 、TRUE。

371
Chapter: 6 グラフィックス ビルダー オートメーション インターフェース

戻 り値
現 在 の塗 り込 み設 定 を取 得 する場 合 、オブジェクト が塗 り込 まれれて表 示 されている場 合 は
真 (TRUE)。塗 り込 み設 定 を適 用 する場 合 は、正 常 に適 用 が終 了 した場 合 は 0 (ゼロ) を返
します。いずれの場 合 も、正 常 に完 了 しないとエラーが返 されます。属 性 への書 き込 み時 に値
が範 囲 外 の場 合 は、関 数 は終 了 し、エラー E_INVALIDARG が発 生 します。アクティブなオ
ブジェクト がない場 合 は、関 数 は終 了 し、E_HANDLE を返 します。

注 :戻 り値 とエラー値 の処 理 の詳 細 については、エラー処 理 を参 照 してください。

関連項目
AttributeFillColour

' Displays an object as filled

GraphicsBuilder.AttributeSetFill = TRUE

' Retrieves the current fill setting

MyVariable = GraphicsBuilder.AttributeSetFill

注 :この関 数 は、C++ 環 境 では 2 つの独 立 した関 数 として実 行 されます。put_

AttributeSetFillにより、塗 り込 み設 定 が適 用 され、get_AttributeSetFillにより、現 在 の
塗 り込 み設 定 が取 得 されます。

AttributeShadowColour
影 付 きの3D効 果 を使 用 する場 合 に、影 の色 を設 定 します。または現 在 の影 の色 の設 定 を
取 得 します。
この関 数 は、選 択 されているオブジェクト (一 般 的 に、最 後 に配 置 したオブジェクト ) に適 用 さ
れます。PageSelectFirstObject()関 数 とPageSelectNextObject()関 数 を使 用 すれば、すべての
オブジェクト にアクセスして、プロパティを変 更 または読 み込 むことができます。

注 : この関 数 では True Colour 機 能 がサポート されていないた

め、AttributeShadowOffColourEx関 数 および AttributeShadowOnColourEx関 数 に置 き
換 えられました。

シンタックス
AttributeShadowColour(ShadowColour)

372
 Chapter: 6 グラフィックス ビルダー オートメーション インターフェース

ShadowColour:

影 の色 を示 す 0 ～ 255 の値 。

戻 り値
現 在 の影 の色 の設 定 を取 得 する場 合 は、0 ～ 255 の値 。影 の色 を適 用 する場 合 は、正 常
に適 用 が完 了 すれば 0 (ゼロ)。いずれの場 合 も、正 常 に完 了 しないとエラーが返 されます。属
性 への書 き込 み時 に値 が範 囲 外 の場 合 は、関 数 は終 了 し、エラー E_INVALIDARG が発
生 します。アクティブなオブジェクト がない場 合 は、関 数 は終 了 し、E_HANDLE を返 します。

注 :戻 り値 とエラー値 の処 理 の詳 細 については、エラー処 理 を参 照 してください。

関連項目
Attribute3dEffects, Attribute3dEffectDepth, AttributeHiLightColour,
AttributeLoLightColour

' Applies a shadow color to a shadowed 3D effect

GraphicsBuilder.AttributeShadowColour = 125

' Retrieves the current shadow color

MyVariable = GraphicsBuilder.AttributeShadowColour

注 :この関 数 は、C++ 環 境 では 2 つの独 立 した関 数 として実 行 されます。put_

AttributeShadowColourによって影 の色 の設 定 が適 用 され、get_AttributeShadowColourに
よって現 在 の影 の色 の設 定 が取 得 されます。

AttributeShadowOffColourEx
影 付 きの3D効 果 を使 用 する場 合 に、影 の色 を設 定 します。または現 在 の影 の色 の設 定 を
取 得 します。
この関 数 は、選 択 されているオブジェクト (一 般 的 に、最 後 に配 置 したオブジェクト ) に適 用 さ
れます。PageSelectFirstObject()関 数 とPageSelectNextObject()関 数 を使 用 すれば、すべての
オブジェクト にアクセスして、プロパティを変 更 または読 み込 むことができます。

シンタックス
AttributeShadowOffColourEx(ShadowColour)
ShadowColour:

RGB 値 。

373
Chapter: 6 グラフィックス ビルダー オートメーション インターフェース

戻 り値
現 在 の影 の色 の設 定 を取 得 する場 合 は、RGB 値 。影 の色 を適 用 する場 合 は、正 常 に適
用 が終 了 した場 合 は 0 (ゼロ) を返 します。いずれの場 合 も、正 常 に完 了 しないとエラーが返
されます。属 性 への書 き込 み時 に値 が範 囲 外 の場 合 は、関 数 は終 了 し、エラー E_
INVALIDARG が発 生 します。アクティブなオブジェクト がない場 合 は、関 数 は終 了 し、E_
HANDLE を返 します。

注 ：戻 り値 とエラー値 の処 理 の詳 細 については、エラー処 理 を参 照 してください。

関連項目
Attribute3dEffects, Attribute3dEffectDepth, AttributeHiLightOffColourEx,
AttributeHiLightOnColourEx, AttributeLoLightOffColourEx, AttributeLoLightOnColourEx

' Applies a shadow color to a shadowed 3D effect

GraphicsBuilder.AttributeShadowOffColourEx = &hFF0000

' Retrieves the current shadow color

MyVariable = GraphicsBuilder.AttributeShadowOffColourEx

この関 数 は、C++ 環 境 では 2 つの独 立 した関 数 として実 行 されます。put_

AttributeShadowOffColourExによって影 の色 の設 定 が適 用 され、get_
AttributeShadowOffColourExによって現 在 の影 の色 の設 定 が取 得 されます。

AttributeShadowOnColourEx
影 付 きの3D効 果 を使 用 する場 合 に、影 の色 を設 定 します。または現 在 の影 の色 の設 定 を
取 得 します。
この関 数 は、選 択 されているオブジェクト (一 般 的 に、最 後 に配 置 したオブジェクト ) に適 用 さ
れます。PageSelectFirstObject()関 数 とPageSelectNextObject()関 数 を使 用 すれば、すべての
オブジェクト にアクセスして、プロパティを変 更 または読 み込 むことができます。

シンタックス
AttributeShadowOnColourEx(ShadowColour)
ShadowColour:

RGB 値 。

374
 Chapter: 6 グラフィックス ビルダー オートメーション インターフェース

戻 り値
現 在 の影 の色 の設 定 を取 得 する場 合 は、RGB 値 。影 の色 を適 用 する場 合 は、正 常 に適
用 が終 了 した場 合 は 0 (ゼロ) を返 します。いずれの場 合 も、正 常 に完 了 しないとエラーが返
されます。属 性 への書 き込 み時 に値 が範 囲 外 の場 合 は、関 数 は終 了 し、エラー E_
INVALIDARG が発 生 します。アクティブなオブジェクト がない場 合 は、関 数 は終 了 し、E_
HANDLE を返 します。

注 ：戻 り値 とエラー値 の処 理 の詳 細 については、エラー処 理 を参 照 してください。

関連項目
Attribute3dEffects, Attribute3dEffectDepth, AttributeHiLightOffColourEx,
AttributeHiLightOnColourEx, AttributeLoLightOffColourEx, AttributeLoLightOnColourEx

' Applies a shadow color to a shadowed 3D effect

GraphicsBuilder.AttributeShadowOnColourEx = &hFF0000

' Retrieves the current shadow color

MyVariable = GraphicsBuilder.AttributeShadowOnColourEx

この関 数 は、C++ 環 境 では 2 つの独 立 した関 数 として実 行 されます。put_

AttributeShadowOnColourExによって影 の色 の設 定 が適 用 され、get_AttributeShadowOnColourEx
によって現 在 の影 の色 の設 定 が取 得 されます。

AttributeStartAngle
弧 または扇 形 の開 始 角 度 を設 定 するか、取 得 します。
この関 数 は、選 択 されているオブジェクト (一 般 的 に、最 後 に配 置 したオブジェクト ) に適 用 さ
れます。PageSelectFirstObject()関 数 とPageSelectNextObject()関 数 を使 用 すれば、すべての
オブジェクト にアクセスして、プロパティを変 更 または読 み込 むことができます。

シンタックス
AttributeStartAngle(Angle)
Angle:

始 点 の角 度 を度 で示 す、0 ～ 360 の値 。

375
Chapter: 6 グラフィックス ビルダー オートメーション インターフェース

始 点 の角 度 を取 得 する場 合 は 0 ～ 360 の値 。始 点 の角 度 を適 用 する場 合 は、適 用 が正

常 に完 了 すれば 0 (ゼロ) を返 します。いずれの場 合 も、正 常 に完 了 しないとエラーが返 されま
す。属 性 への書 き込 み時 に値 が範 囲 外 の場 合 は、関 数 は終 了 し、エラー E_INVALIDARG
が発 生 します。アクティブなオブジェクト がない場 合 は、関 数 は終 了 し、E_HANDLE を返 しま
す。

注 ：戻 り値 とエラー値 の処 理 の詳 細 については、エラー処 理 を参 照 してください。

関連項目
AttributeEndAngle

' Sets the start angle of an arc

GraphicsBuilder.AttributeStartAngle = 45

' Retrieves the start angle for an arc

MyVariable = GraphicsBuilder.AttributeStartAngle

この関 数 は、C++ 環 境 では 2 つの独 立 した関 数 として実 行 されます。put_

AttributeStartAngleによって始 点 の角 度 の設 定 が適 用 され、get_AttributeStartAngle によっ
て現 在 の始 点 の角 度 の設 定 が取 得 されます。

AttributeTransformationMatrixGet
変 換 マト リクスの要 素 を読 み込 みます。A と D が共 に 1 で、他 が 0 の場 合 、オブジェクト は変
換 されません (単 位 マト リクス)。
この関 数 は、選 択 されているオブジェクト (一 般 的 に、最 後 に配 置 したオブジェクト ) に適 用 さ
れます。PageSelectFirstObject()関 数 とPageSelectNextObject()関 数 を使 用 すれば、すべての
オブジェクト にアクセスして、プロパティを変 更 または読 み込 むことができます。

シンタックス
AttributeTransformationMatrixGet(A, B, C, D, H, K)
A:

変 換 マト リクスの要 素 A

B:

変 換 マト リクスの要 素 A

C:

変 換 マト リクスの要 素 A

376
 Chapter: 6 グラフィックス ビルダー オートメーション インターフェース

D:

変 換 マト リクスの要 素 A

H:

変 換 マト リクスの要 素 A

K:

変 換 マト リクスの要 素 A

戻 り値
変 換 マト リクスの要 素 。属 性 への書 き込 み時 に値 が範 囲 外 の場 合 は、関 数 は終 了 し、エ
ラー E_INVALIDARG が発 生 します。アクティブなオブジェクト がない場 合 は、関 数 は終 了
し、E_HANDLE を返 します。

注 ：戻 り値 とエラー値 の処 理 の詳 細 については、エラー処 理 を参 照 してください。

関連項目
AttributeTransformationMatrixPut

AttributeTransformationMatrixPut
変 換 マト リクスの要 素 を設 定 します。
この関 数 は、選 択 されているオブジェクト (一 般 的 に、最 後 に配 置 したオブジェクト ) に適 用 さ
れます。PageSelectFirstObject()関 数 とPageSelectNextObject()関 数 を使 用 すれば、すべての
オブジェクト にアクセスして、プロパティを変 更 または読 み込 むことができます。

シンタックス
AttributeTransformationMatrixGet(A, B, C, D, H, K)
A:

変 換 マト リクスの要 素 A

B:

変 換 マト リクスの要 素 A

C:

変 換 マト リクスの要 素 A

D:

変 換 マト リクスの要 素 A

377
Chapter: 6 グラフィックス ビルダー オートメーション インターフェース

H:

変 換 マト リクスの要 素 A

K:

変 換 マト リクスの要 素 A

戻 り値
関 数 が正 常 に実 行 された場 合 は0 (ゼロ) が、それ以 外 の場 合 はエラーが返 されます。属 性 へ
の書 き込 み時 に値 が範 囲 外 の場 合 は、関 数 は終 了 し、エラー E_INVALIDARG が発 生 し
ます。アクティブなオブジェクト がない場 合 は、関 数 は終 了 し、E_HANDLE を返 します。

注 ：戻 り値 とエラー値 の処 理 の詳 細 については、エラー処 理 を参 照 してください。

関連項目
AttributeTransformationMatrixGet

AttributeX
アクティブなオブジェクト のX座 標 を取 得 します。この関 数 が読 み取 り専 用 であることにご注 意 く
ださい。
この関 数 は、選 択 されているオブジェクト (一 般 的 に、最 後 に配 置 したオブジェクト ) に適 用 さ
れます。PageSelectFirstObject()関 数 とPageSelectNextObject()関 数 を使 用 すれば、すべての
オブジェクト にアクセスして、プロパティを変 更 または読 み込 むことができます。

シンタックス
AttributeX(XPosition)
XPosition:

0 ～ 65536 の値 。

戻 り値
0 ～ 65536 の値 。属 性 への書 き込 み時 に値 が範 囲 外 の場 合 は、関 数 は終 了 し、エラー E_
INVALIDARG が発 生 します。アクティブなオブジェクト がない場 合 は、関 数 は終 了 し、E_
HANDLE を返 します。

注 ：戻 り値 とエラー値 の処 理 の詳 細 については、エラー処 理 を参 照 してください。

378
 Chapter: 6 グラフィックス ビルダー オートメーション インターフェース

関連項目
AttributeY, AttributeAN

' Retrieves the X coordinate for the current object

MyVariable = GraphicsBuilder.AttributeX

AttributeY
アクティブなオブジェクト のY座 標 を取 得 します。この関 数 が読 み取 り専 用 であることにご注 意 く
ださい。
この関 数 は、選 択 されているオブジェクト (一 般 的 に、最 後 に配 置 したオブジェクト ) に適 用 さ
れます。PageSelectFirstObject()関 数 とPageSelectNextObject()関 数 を使 用 すれば、すべての
オブジェクト にアクセスして、プロパティを変 更 または読 み込 むことができます。

シンタックス
AttributeY(YPosition)
YPosition:

0 ～ 65536 の値 。

戻 り値
0 ～ 65536 の値 。属 性 への書 き込 み時 に値 が範 囲 外 の場 合 は、関 数 は終 了 し、エラー E_
INVALIDARG が発 生 します。アクティブなオブジェクト がない場 合 は、関 数 は終 了 し、E_
HANDLE を返 します。

注 ：戻 り値 とエラー値 の処 理 の詳 細 については、エラー処 理 を参 照 してください。

関連項目
AttributeX, AttributeAN

' Retrieves the Y coordinate for the current object

MyVariable = GraphicsBuilder.AttributeY

DrawButton

379
Chapter: 6 グラフィックス ビルダー オートメーション インターフェース

アクティブなページにボタンを描 画 します。

シンタックス
DrawButton(FromXPosition, FromYPosition, ToXPosition, ToYPosition)
FromXPosition:

ページの左 側 から描 画 するボタンの左 上 隅 までの、ピクセルによる距 離 です。

FromYPosition:

ページの上 部 から描 画 するボタンの左 上 隅 までの、ピクセルによる距 離 です。

ToXPosition:

ページの左 側 から描 画 するボタンの右 下 隅 までの、ピクセルによる距 離 です。

ToYPosition:

ページの上 部 から描 画 するボタンの右 下 隅 までの、ピクセルによる距 離 です。

戻 り値
正 常 に関 数 が実 行 された場 合 は0 (ゼロ) が、それ以 外 の場 合 はエラーが返 されます。

注 : 戻 り値 とエラー値 の処 理 の詳 細 については、エラー処 理 を参 照 してください。

関連項目
DrawLine, DrawEllipse, DrawRectangle, DrawPolygonStart, DrawPolygonLine,
DrawPolygonEnd, DrawPipeStart, DrawPipeSection, DrawPipeEnd, DrawText,
DrawNumber, DrawSymbolSet, DrawTrend, DrawCicodeObject

GraphicsBuilder.DrawButton 50, 70, 400, 200

DrawCicodeObject
ページの指 定 した場 所 のページにCicodeオブジェクト を配 置 します。

シンタックス
DrawCicodeObject(XPosition, YPosition)
XPosition:

ページの左 側 からCicodeオブジェクト を配 置 する位 置 までの、ピクセルによる距 離 です。

380
 Chapter: 6 グラフィックス ビルダー オートメーション インターフェース

YPosition:

ページの上 部 からCicodeオブジェクト を配 置 する位 置 までの、ピクセルによる距 離 です。

戻 り値
関 数 が正 常 に実 行 された場 合 は0 (ゼロ) が、それ以 外 の場 合 はエラーが返 されます。

注 : 戻 り値 とエラー値 の処 理 の詳 細 については、エラー処 理 を参 照 してください。

関連項目
DrawButton, DrawLine, DrawEllipse, DrawRectangle, DrawPolygonStart,
DrawPolygonLine, DrawPolygonEnd, DrawPipeStart, DrawPipeSection, DrawPipeEnd,
DrawText, DrawNumber, DrawSymbolSet, DrawTrend

GraphicsBuilder.DrawCicodeObject 500, 100

DrawEllipse
アクティブなページに楕 円 を描 画 します。

シンタックス
DrawEllipse(FromXPosition, FromYPosition, ToXPosition, ToYPosition)
FromXPosition:

ページの左 側 から楕 円 を囲 む四 角 形 の左 上 角 までの、ピクセルによる距 離 です。

FromYPosition:

ページの上 部 から楕 円 を囲 む四 角 形 の左 上 角 までの、ピクセルによる距 離 です。

ToXPosition:

ページの左 側 から楕 円 を囲 む四 角 形 の右 下 角 での、ピクセルによる距 離 です。

ToYPosition:

ページの上 部 から楕 円 を囲 む四 角 形 の右 下 角 までの、ピクセルによる距 離 です。

戻 り値
関 数 が正 常 に実 行 された場 合 は0 (ゼロ) が、それ以 外 の場 合 はエラーが返 されます。

381
Chapter: 6 グラフィックス ビルダー オートメーション インターフェース

注 : 戻 り値 とエラー値 の処 理 の詳 細 については、エラー処 理 を参 照 してください。

関連項目
DrawButton, DrawLine, DrawRectangle, DrawPolygonStart, DrawPolygonLine,
DrawPolygonEnd, DrawPipeStart, DrawPipeSection, DrawPipeEnd, DrawText,
DrawNumber, DrawSymbolSet, DrawTrend, DrawCicodeObject

GraphicsBuilder.DrawEllipse 50, 70, 400, 200

DrawLine
アクティブなページに直 線 を描 画 します。

シンタックス
DrawLine(FromXPosition, FromYPosition, ToXPosition, ToYPosition)
FromXPosition:

ページの左 側 から直 線 を囲 む四 角 形 の左 上 角 までの、ピクセルによる距 離 です。

FromYPosition:

ページの上 部 から直 線 を囲 む四 角 形 の左 上 角 までの、ピクセルによる距 離 です。

ToXPosition:

ページの左 側 から直 線 を囲 む四 角 形 の右 下 角 までの、ピクセルによる距 離 です。

ToYPosition:

ページの上 部 から直 線 を囲 む四 角 形 の右 下 角 までの、ピクセルによる距 離 です。

戻 り値
関 数 が正 常 に実 行 された場 合 は0 (ゼロ) が、それ以 外 の場 合 はエラーが返 されます。

注 : 戻 り値 とエラー値 の処 理 の詳 細 については、エラー処 理 を参 照 してください。

382
 Chapter: 6 グラフィックス ビルダー オートメーション インターフェース

関連項目
DrawButton, DrawEllipse, DrawRectangle, DrawPolygonStart, DrawPolygonLine,
DrawPolygonEnd, DrawPipeStart, DrawPipeSection, DrawPipeEnd, DrawText,
DrawNumber, DrawSymbolSet, DrawTrend, DrawCicodeObject

GraphicsBuilder.DrawLine 50, 70, 400, 70

DrawNumber
ページの指 定 した位 置 に数 値 オブジェクト を配 置 します。

シンタックス
DrawNumber(XPosition, YPosition)
XPosition:

ページの左 側 から数 値 オブジェクト を配 置 する位 置 までの、ピクセルによる距 離 です。

YPosition:

ページの上 から数 値 オブジェクト を配 置 する位 置 までの、ピクセルによる距 離 です。

戻 り値
関 数 が正 常 に実 行 された場 合 は0 (ゼロ) が、それ以 外 の場 合 はエラーが返 されます。

注 : 戻 り値 とエラー値 の処 理 の詳 細 については、エラー処 理 を参 照 してください。

関連項目
DrawLine, DrawEllipse, DrawRectangle, DrawPolygonStart, DrawPolygonLine,
DrawPolygonEnd, DrawPipeStart, DrawPipeSection, DrawPipeEnd, DrawText,
DrawButton, DrawSymbolSet, DrawTrend, DrawCicodeObject

GraphicsBuilder.DrawNumber 500, 100

DrawPipeEnd

383
Chapter: 6 グラフィックス ビルダー オートメーション インターフェース

アクティブなページでパイプの描 画 を終 了 します。正 常 に終 了 するには、DrawPipeSectionのイ

ンスタンスの後 にこの関 数 を続 ける必 要 があります。

シンタックス
DrawPipeEnd

戻 り値
関 数 が正 常 に実 行 された場 合 は0 (ゼロ) が、それ以 外 の場 合 はエラーが返 されます。

注 : 戻 り値 とエラー値 の処 理 の詳 細 については、エラー処 理 を参 照 してください。

関連項目
DrawPipeSection, DrawPipeStart

GraphicsBuilder.DrawPipeStart 50, 290

GraphicsBuilder.DrawPipeSection 200, 350
GraphicsBuilder.DrawPipeSection 350, 250
GraphicsBuilder.DrawPipeSection 400, 350
GraphicsBuilder.DrawPipeEnd

DrawPipeSection
アクティブなページにパイプの部 分 を描 画 します。この関 数 が正 常 に機 能 するには、この関 数
が関 数 DrawPipeStartによって定 義 された開 始 点 を持 っているか、またこの関 数 自 体 が以 前
に実 行 されていることが必 要 です。

シンタックス
DrawPipeSection(XPosition, YPosition)
XPosition:

ページの左 側 からパイプのセクションを終 了 する位 置 までの、ピクセルによる距 離 です。

YPosition:

ページの上 部 からパイプのセクションを終 了 する位 置 までの、ピクセルによる距 離 です。

戻 り値
関 数 が正 常 に実 行 された場 合 は0 (ゼロ) が、それ以 外 の場 合 はエラーが返 されます。

384
 Chapter: 6 グラフィックス ビルダー オートメーション インターフェース

注 : 戻 り値 とエラー値 の処 理 の詳 細 については、エラー処 理 を参 照 してください。

関連項目
DrawPipeStart, DrawPipeEnd

GraphicsBuilder.DrawPipeStart 50, 290

GraphicsBuilder.DrawPipeSection 200, 350
GraphicsBuilder.DrawPipeSection 350, 250
GraphicsBuilder.DrawPipeSection 400, 350
GraphicsBuilder.DrawPipeEnd

DrawPipeStart
DrawPipeSectionを適 用 可 能 な開 始 ポイント を定 義 して、アクティブなページでパイプの描 画
を開 始 します。

シンタックス
DrawPipeStart(XPosition, YPosition)
XPosition:

ページの左 側 からパイプのセクションを開 始 する位 置 までの、ピクセルによる距 離 です。

YPosition:

ページの上 部 からパイプのセクションを開 始 する位 置 までの、ピクセルによる距 離 です。

戻 り値
関 数 が正 常 に実 行 された場 合 は0 (ゼロ) が、それ以 外 の場 合 はエラーが返 されます。

注 : 戻 り値 とエラー値 の処 理 の詳 細 については、エラー処 理 を参 照 してください。

関連項目
DrawPipeSection, DrawPipeEnd

GraphicsBuilder.DrawPipeStart 50, 290

385
Chapter: 6 グラフィックス ビルダー オートメーション インターフェース

GraphicsBuilder.DrawPipeSection 200, 350

GraphicsBuilder.DrawPipeSection 350, 250
GraphicsBuilder.DrawPipeSection 400, 350
GraphicsBuilder.DrawPipeEnd

DrawPolygonEnd
アクティブなページで多 角 形 の描 画 を終 了 します。正 常 に実 行 するには、DrawPolygonLine
のインスタンスの後 にこの関 数 を続 ける必 要 があります。

シンタックス
DrawPolygonEnd

戻 り値
関 数 が正 常 に実 行 された場 合 は0 (ゼロ) が、それ以 外 の場 合 はエラーが返 されます。

注 : 戻 り値 とエラー値 の処 理 の詳 細 については、エラー処 理 を参 照 してください。

関連項目
DrawPolygonLine、DrawPolygonStart

GraphicsBuilder.DrawPolygonStart 50, 290

GraphicsBuilder.DrawPolygonLine 200, 350
GraphicsBuilder.DrawPolygonLine 350, 250
GraphicsBuilder.DrawPolygonLine 400, 350
GraphicsBuilder.DrawPolygonEnd

DrawPolygonLine
アクティブなページに、多 角 形 を構 成 する直 線 を描 画 します。この関 数 が正 常 に機 能 するに
は、この関 数 が関 数 DrawPolygonStartによって定 義 された開 始 点 をもっているか、この関 数
が以 前 に実 行 されていることが必 要 です。

シンタックス
DrawPolygonLine(XPosition, YPosition)
XPosition:

ページの左 側 から直 線 を終 了 する位 置 までの、ピクセルによる距 離 です。

386
 Chapter: 6 グラフィックス ビルダー オートメーション インターフェース

YPosition:

ページの上 部 から直 線 を終 了 する位 置 までの、ピクセルによる距 離 です。

戻 り値
関 数 が正 常 に実 行 された場 合 は0 (ゼロ) が、それ以 外 の場 合 はエラーが返 されます。

注 : 戻 り値 とエラー値 の処 理 の詳 細 については、エラー処 理 を参 照 してください。

関連項目
DrawPolygonStart, DrawPolygonEnd

GraphicsBuilder.DrawPolygonStart 50, 290

GraphicsBuilder.DrawPolygonLine 200, 350
GraphicsBuilder.DrawPolygonLine 350, 250
GraphicsBuilder.DrawPolygonLine 400, 350
GraphicsBuilder.DrawPolygonEnd

DrawPolygonStart
DrawPolygonLineを適 用 できる開 始 ポイント を定 義 して、アクティブなページで多 角 形 の描
画 を開 始 します。

シンタックス
DrawPolygonStart(XPosition, YPosition)
XPosition:

ページの左 側 から多 角 形 を開 始 する位 置 までの、ピクセルによる距 離 です。

YPosition:

ページの上 部 から多 角 形 を開 始 する位 置 までの、ピクセルによる距 離 です。

戻 り値
関 数 が正 常 に実 行 された場 合 は0 (ゼロ) が、それ以 外 の場 合 はエラーが返 されます。

注 : 戻 り値 とエラー値 の処 理 の詳 細 については、エラー処 理 を参 照 してください。

387
Chapter: 6 グラフィックス ビルダー オートメーション インターフェース

関連項目
DrawPolygonLine, DrawPolygonEnd

GraphicsBuilder.DrawPolygonStart 50, 290

GraphicsBuilder.DrawPolygonLine 200, 350
GraphicsBuilder.DrawPolygonLine 350, 250
GraphicsBuilder.DrawPolygonLine 400, 350
GraphicsBuilder.DrawPolygonEnd

DrawRectangle
アクティブなページに長 方 形 を描 画 します。

シンタックス
DrawRectangle(FromXPosition, FromYPosition, ToXPosition, ToYPosition)
FromXPosition:

ページの左 側 から描 画 する長 方 形 の左 上 角 までの、ピクセルによる距 離 です。

FromYPosition:

ページの上 部 から描 画 する長 方 形 の左 上 角 までの、ピクセルによる距 離 です。

ToXPosition:

ページの左 側 から描 画 する長 方 形 の右 下 角 までの、ピクセルによる距 離 です。

ToYPosition:

ページの上 部 から描 画 する長 方 形 の右 下 角 までの、ピクセルによる距 離 です。

戻 り値
関 数 が正 常 に実 行 された場 合 は0 (ゼロ) が、それ以 外 の場 合 はエラーが返 されます。

注 : 戻 り値 とエラー値 の処 理 の詳 細 については、エラー処 理 を参 照 してください。

関連項目
DrawLine, DrawEllipse, DrawPolygonStart, DrawPolygonLine, DrawPolygonEnd,
DrawPipeStart, DrawPipeSection, DrawPipeEnd, DrawText, DrawNumber, DrawButton,
DrawSymbolSet, DrawTrend, DrawCicodeObject

388
 Chapter: 6 グラフィックス ビルダー オートメーション インターフェース

GraphicsBuilder.DrawRectangle 50, 70, 400, 200

DrawSymbolSet
ページの指 定 した位 置 にシンボル セット オブジェクト を配 置 します。

シンタックス
DrawSymbolSet(XPosition, YPosition)
XPosition:

ページの左 側 からオブジェクト を配 置 する位 置 までの、ピクセルによる距 離 です。

YPosition:

ページの上 からオブジェクト を配 置 する位 置 までの、ピクセルによる距 離 です。

戻 り値
関 数 が正 常 に実 行 された場 合 は0 (ゼロ) が、それ以 外 の場 合 はエラーが返 されます。

注 : 戻 り値 とエラー値 の処 理 の詳 細 については、エラー処 理 を参 照 してください。

関連項目
DrawLine, DrawEllipse, DrawPolygonStart, DrawPolygonLine, DrawPolygonEnd,
DrawPipeStart, DrawPipeSection, DrawPipeEnd, DrawText, DrawNumber, DrawButton,
DrawTrend, DrawCicodeObject, DrawRectangle

GraphicsBuilder.DrawSymbolSet 500, 100

DrawText
指 定 した位 置 に英 数 字 の文 字 列 を描 画 します。

シンタックス
DrawText(Text, XPosition, YPosition)
テキストの場 合

389
Chapter: 6 グラフィックス ビルダー オートメーション インターフェース

アクティブなグラフィックス ページに貼 り付 けるテキスト です。

XPosition:

ページの左 側 からテキスト を配 置 する位 置 までの、ピクセルによる距 離 です。

YPosition:

ページの上 部 からテキスト を配 置 する位 置 までの、ピクセルによる距 離 です。

戻 り値
関 数 が正 常 に実 行 された場 合 は0 (ゼロ) が、それ以 外 の場 合 はエラーが返 されます。

注 : 戻 り値 とエラー値 の処 理 の詳 細 については、エラー処 理 を参 照 してください。

関連項目
DrawLine, DrawEllipse, DrawPolygonStart, DrawPolygonLine, DrawPolygonEnd,
DrawPipeStart, DrawPipeSection, DrawPipeEnd, DrawNumber, DrawButton,
DrawTrend, DrawCicodeObject, DrawRectangle, DrawSymbolSet

GraphicsBuilder.DrawText "My Text", 500, 100

DrawTrend
アクティブなページにト レンド オブジェクト を描 画 します。

シンタックス
DrawTrend(FromXPosition, FromYPosition, ToXPosition, ToYPosition)
FromXPosition:

ページの左 側 からト レンド オブジェクト の左 上 角 までの、ピクセルによる距 離 です。

FromYPosition:

ページの上 部 からト レンド オブジェクト の左 上 角 までの、ピクセルによる距 離 です。

ToXPosition:

ページの左 側 からト レンド オブジェクト の右 下 角 までの、ピクセルによる距 離 です。

ToYPosition:

ページの上 部 からト レンド オブジェクト の右 下 角 までの、ピクセルによる距 離 です。

390
 Chapter: 6 グラフィックス ビルダー オートメーション インターフェース

戻 り値
関 数 が正 常 に実 行 された場 合 は0 (ゼロ) が、それ以 外 の場 合 はエラーが返 されます。

注 : 戻 り値 とエラー値 の処 理 の詳 細 については、エラー処 理 を参 照 してください。

関連項目
DrawLine, DrawEllipse, DrawPolygonStart, DrawPolygonLine, DrawPolygonEnd,
DrawPipeStart, DrawPipeSection, DrawPipeEnd, DrawNumber, DrawButton,
DrawCicodeObject, DrawRectangle, DrawSymbolSet, DrawText

GraphicsBuilder.DrawTrend 50, 70, 400, 200

オプション関 数
これらの関 数 は、グラフィックス ビルダーの [ツール] メニューにあるオプションに関 連 します。これら
の関 数 はVisual Basicで例 外 処 理 を実 行 しません。

OptionDisplayPropertiesOnN- グラフィックス ビルダーの [ツール] メニューにある、新 しいオブジェクト

ew を挿 入 した際 に自 動 的 にプロパティを表 示 するオプションをシミュ
レート します。この関 数 を使 用 して、このオプションを設 定 したり、現
在 の設 定 を取 得 することができます。

OptionSnapToGrid グラフィックス ビルダーの [ツール] メニューにある、オブジェクト を自 動

的 にグリッドにスナップするオプションをシミュレート します。この関 数 を
使 用 して、このオプションを設 定 したり、現 在 の設 定 を取 得 すること
ができます。

OptionSnapToGuidelines グラフィックス ビルダーの [ツール] メニューにある、オブジェクト を自 動

的 にガイドラインにスナップするオプションをシミュレート します。この関
数 を使 用 して、このオプションを設 定 したり、現 在 の設 定 を取 得 する
ことができます。

戻 り値 とエラー値 の処 理 の詳 細 、および Visual Basic のサンプルについては、オート メーション

エラー処 理 を参 照 してください。

OptionDisplayPropertiesOnNew

391
Chapter: 6 グラフィックス ビルダー オートメーション インターフェース

グラフィックス ビルダーの [ツール] メニューにある、新 しいオブジェクト を挿 入 した際 に自 動 的 にプ

ロパティを表 示 するオプションをシミュレート します。この関 数 を使 用 して、このオプションを設 定
したり、現 在 の設 定 を取 得 することができます。

シンタックス
OptionDisplayPropertiesOnNew(OptionValue)
OptionValue:

真 (TRUE) ではオプションがオンに、偽 (FALSE) ではオプションがオフになります。

戻 り値
現 在 の設 定 を取 得 する場 合 は、真 (TRUE) または偽 (FALSE)。オプションを有 効 または無 効
にする場 合 は、正 常 に処 理 が完 了 すれば0 (ゼロ) が返 されます。いずれの場 合 も、正 常 に完
了 しないとエラーが返 されます。

注 : 戻 り値 とエラー値 の処 理 の詳 細 については、エラー処 理 を参 照 してください。

関連項目
OptionSnapToGrid, OptionSnapToGuidelines

注 : この関 数 は、C++環 境 では2つの独 立 した関 数 として実 行 されます。put_

OptionDisplayPropertiesOnNewによってこのオプションが有 効 または無 効 になり、get_
OptionDisplayPropertiesOnNewによって現 在 のオプション設 定 が取 得 されます。

OptionSnapToGrid
グラフィックス ビルダーの [ツール] メニューにある、オブジェクト を自 動 的 にグリッド にスナップするオ
プションをシミュレート します。この関 数 を使 用 して、このオプションを設 定 したり、現 在 の設 定 を
取 得 することができます。

シンタックス
OptionSnapToGrid(OptionValue)
OptionValue:

真 (TRUE) ではオプションがオンに、偽 (FALSE) ではオプションがオフになります。

392
 Chapter: 6 グラフィックス ビルダー オートメーション インターフェース

戻 り値
現 在 の設 定 を取 得 する場 合 は、真 (TRUE) または偽 (FALSE)。オプションを有 効 または無 効
にする場 合 は、正 常 に処 理 が完 了 すれば0 (ゼロ) が返 されます。いずれの場 合 も、正 常 に完
了 しないとエラーが返 されます。

注 : 戻 り値 とエラー値 の処 理 の詳 細 については、エラー処 理 を参 照 してください。

関連項目
OptionDisplayPropertiesOnNew, OptionSnapToGuidelines

注 : この関 数 は、C++環 境 では2つの独 立 した関 数 として実 行 されます。put_

OptionSnapToGridによってこのオプションが有 効 または無 効 になり、get_OptionSnapToGridに
よって現 在 のオプション設 定 が取 得 されます。

OptionSnapToGuidelines
グラフィックス ビルダーの [ツール] メニューにある、オブジェクト を自 動 的 にガイド ラインにスナップ
するオプションをシミュレート します。この関 数 を使 用 して、このオプションを設 定 したり、現 在 の
設 定 を取 得 することができます。

シンタックス
OptionSnapToGuidelines(OptionValue)
OptionValue:

真 (TRUE) ではオプションがオンに、偽 (FALSE) ではオプションがオフになります。

戻 り値
現 在 の設 定 を取 得 する場 合 は、真 (TRUE) または偽 (FALSE)。オプションを有 効 または無 効
にする場 合 は、正 常 に処 理 が完 了 すれば0 (ゼロ) が返 されます。いずれの場 合 も、正 常 に完
了 しないとエラーが返 されます。

注 : 戻 り値 とエラー値 の処 理 の詳 細 については、エラー処 理 を参 照 してください。

関連項目
OptionDisplayPropertiesOnNew, OptionSnapToGrid

注 : この関 数 は、C++環 境 では2つの独 立 した関 数 として実 行 されます。put_

393
Chapter: 6 グラフィックス ビルダー オートメーション インターフェース

OptionSnapToGuidelinesによってこのオプションが有 効 または無 効 になり、get_

OptionSnapToGuidelinesによって現 在 のオプション設 定 が取 得 されます。

ページ関 数
ページ関 数 を使 用 した場 合 、プロジェクト のページを操 作 (開 く、閉 じる、保 存 する、削 除 する
など) し、これらのページのオブジェクト を選 択 できます。テンプレート 、シンボル、ジニー、スー
パー ジニーなどです。

PageActiveWindowHandle アクティブなページのウィンドウ ハンドルを取 得 します。

PageClose 現 在 のページを閉 じます。この関 数 では、保 存 されていないペー

ジも閉 じることに注 意 してください。

PageConvertWindowCoordinat- 加 工 ・編 集 されていないウィンドウ座 標 を、スクロール バーの位 置

es を考 慮 したページ座 標 に変 換 します。

PageDelete 指 定 したページを削 除 します。

PageDeleteEx 指 定 したシンボル、ジニー、またはスーパージニーをライブラリから削
除 します。

PageDeleteObject 現 在 選 択 されているオブジェクト を削 除 します。

PageDeleteTemplate 指 定 したグラフィックス ページのテンプレート を削 除 します。

PageGroupSelectedObjects 現 在 選 択 されているオブジェクト をグループ化 します。

PageImport グラフィックス ファイルをページにビット マップとしてインポート します。

PageNew 新 しい CitectSCADA グラフィックス ページを作 成 します。

PageNewEx 新 しいシンボル、ジニー、またはスーパージニーのページを作 成 しま
す。

PageNewLibrary 新 しいライブラリを作 成 します。プロジェクト が読 み取 り専 用 、または

無 効 の場 合 、この関 数 は成 功 しません。

PageNewTemplate 新 しい CitectSCADA グラフィックス ページテンプレート を作 成 しま

す。

PageOpen 既 存 の CitectSCADA グラフィックス ページを開 きます。

394
 Chapter: 6 グラフィックス ビルダー オートメーション インターフェース

PageOpenEx 指 定 したシンボル、ジニー、またはスーパージニーを開 きます (検

出 された場 合 )。

PageOpenTemplate 指 定 したグラフィックス ページのテンプレート を開 きます。

PagePrint 現 在 のページを印 刷 します。

PageUpdated このイベント は、グラフィックス ビルダー ページが更 新 された場 合 に発

生 します。

PageSave 現 在 の名 前 を使 用 して、ページを保 存 します。

PageSaveAs ページを指 定 したプロジェクト 内 に新 しい名 前 で保 存 します。

PageSaveAsEx シンボル、ジニー、スーパージニー、またはテンプレート ページを指

定 した場 所 に保 存 します。

PageSelect 開 いているページを選 択 します。

PageSelectFirst グラフィックス ビルダーで現 在 開 いている最 初 のページを選 択 しま

す。開 いているページがない場 合 、この関 数 は成 功 しません。

PageSelectFirstObject z orderの番 号 に基 づいて、アクティブなページで最 初 のオブジェク

ト を選 択 します。オブジェクト が存 在 しない場 合 は成 功 しません。
オブジェクト がグループ化 されたオブジェクト の場 合 は、グループ内
のアイテムに対 しこの関 数 が繰 り返 し実 行 されます。

PageSelectFirstObjectEx z orderの番 号 に基 づいて、アクティブなページで最 初 のオブジェク

ト を選 択 します。オブジェクト が存 在 しない場 合 は成 功 しません。こ
の関 数 は、グループ内 のアイテムに対 して繰 り返 し実 行 されませ
ん。

PageSelectFirstObjectInGenie 現 在 選 択 されているジニーの、最 初 のサブオブジェクト を選 択 します。

PageSelectFirstObjectInGroup グループ内 の最 初 のオブジェクト を選 択 します。

PageSelectNext グラフィックス ビルダーで現 在 開 いている次 のページを選 択 します。

開 いているページがない場 合 、この関 数 は成 功 しません。

PageSelectNextObject z orderの番 号 に基 づいて、アクティブなページで次 のオブジェクト

を選 択 します。オブジェクト が存 在 しない場 合 は、この関 数 は成 功
しません。オブジェクト がグループ化 されたオブジェクト の場 合 は、グ
ループ内 のアイテムに対 しこの関 数 が繰 り返 し実 行 されます。

PageSelectNextObjectEx z orderの番 号 に基 づいて、アクティブなページで次 のオブジェクト

を選 択 します。オブジェクト が存 在 しない場 合 は、この関 数 は成 功
しません。この関 数 は、グループ内 のアイテムに対 して繰 り返 し実
行 されません。

395
Chapter: 6 グラフィックス ビルダー オートメーション インターフェース

PageSelectNextObjectInGenie 現 在 選 択 されているジニーの、次 のサブオブジェクト を選 択 します。

PageSelectNextObjectInGroup グループ内 の次 のオブジェクト を選 択 します。

PageSelectObject 指 定 したAN番 号 を使 用 して、オブジェクト を選 択 します。

PageSelectObjectAdd 指 定 されたAN番 号 を使 用 して、追 加 オブジェクト を選 択 しま

す。PageGroupSelectedObjectsに続 けて実 行 して、複 数 のオ
ブジェクト を選 択 するのに使 用 できます。

PageTemplateSelectFirstObject テンプレート 列 挙 型 シーケンスを再 起 動 します。

PageTemplateSelectNextObject テンプレート 内 の次 のオブジェクト を選 択 します。

PageThumbnailToClipboard 現 在 のページのサムネイル イメージを作 成 して、クリップボードにコ

ピーします。

PageUngroupSelectedObject 現 在 選 択 されているグループ化 されたオブジェクト のグループ化 を

解 除 します。

戻 り値 とエラー値 の処 理 の詳 細 、および Visual Basic のサンプルについては、オート メーション

エラー処 理 を参 照 してください。

PageActiveWindowHandle
アクティブなページのウィンド ウ ハンド ルを取 得 します。

シンタックス
PageActiveWindowHandle(WindowHandle)
WindowHandle:

アクティブなウィンドウのハンドル。アクティブなウィンドウがない場 合 、ハンドルは NULL になりま

す。Visual Basic では、これが戻 り値 になります。

戻 り値
アクティブなウィンド ウのハンド ル。アクティブなウィンド ウがない場 合 、ハンド ルは NULL になりま
す。

注 : 戻 り値 とエラー値 の処 理 の詳 細 については、エラー処 理 を参 照 してください。

' Retrieves the window handle of the active page

MyVariable = GraphicsBuilder.PageActiveWindowHandle

396
 Chapter: 6 グラフィックス ビルダー オートメーション インターフェース

PageClose
現 在 のページを閉 じます。この関 数 では、保 存 されていないページも閉 じることに注 意 してくだ
さい。

シンタックス
PageClose

戻 り値
関 数 が正 常 に実 行 された場 合 は0 (ゼロ) が、それ以 外 の場 合 はエラーが返 されます。

注 : 戻 り値 とエラー値 の処 理 の詳 細 については、エラー処 理 を参 照 してください。

関連項目
PageNew, PageOpen, PageSaveAs, PageSave

' Closes the current CitectSCADA graphics page

GraphicsBuilder.PageClose

PageConvertWindowCoordinates
加 工 ・編 集 されていないウィンド ウ座 標 を、スクロール バーの位 置 を考 慮 したページ座 標 に変
換 します。

シンタックス
PageConvertWindowCoordinates(XPosition, YPosition)
XPosition:

入 力 としてのウィンドウ X 座 標 。出 力 としてのページ X 座 標 。

YPosition:

入 力 としてのウィンドウ Y 座 標 。出 力 としてのページ Y 座 標 。

397
Chapter: 6 グラフィックス ビルダー オートメーション インターフェース

戻 り値
関 数 が正 常 に実 行 された場 合 は0 (ゼロ) が、それ以 外 の場 合 はエラーが返 されます。

注 : 戻 り値 とエラー値 の処 理 の詳 細 については、エラー処 理 を参 照 してください。

PageDelete
指 定 したページを削 除 します。

シンタックス
PageDelete(Project, Page, Flag)
Project:

ページが保 存 されているプロジェクト の名 前 。

Page:

削 除 するページの名 前 。

Flag:

このフラグが設 定 されている場 合 、関 連 するレコードは削 除 されます。

戻 り値
関 数 が正 常 に実 行 された場 合 は0 (ゼロ) が、それ以 外 の場 合 はエラーが返 されます。

注 : 戻 り値 とエラー値 の処 理 の詳 細 については、エラー処 理 を参 照 してください。

関連項目
PageNew, PageOpen, PageSaveAs, PageSave

' Deletes the current CitectSCADA graphics page

GraphicsBuilder.PageDelete "Example", "TestPage", True

PageDeleteEx
指 定 したシンボル、ジニー、またはスーパージニーをライブラリから削 除 します。

398
 Chapter: 6 グラフィックス ビルダー オートメーション インターフェース

シンタックス
PageDeleteEx(Project, Library, Element, PageType)
Project:

要 素 が保 存 されているプロジェクト の名 前 。

Library:

要 素 が保 存 されているライブラリの名 前 。

Element:

シンボル、ジニー、またはスーパージニーの名 前 。

PageType:
l 0 = シンボル
l 1 = ジニー
l 2 = スーパージニー

戻 り値
関 数 が正 常 に実 行 された場 合 は0 (ゼロ) が、それ以 外 の場 合 はエラーが返 されます。

注 : 戻 り値 とエラー値 の処 理 の詳 細 については、エラー処 理 を参 照 してください。

関連項目
PageNew, PageOpen, PageSaveAs, PageSave

' Deletes the specified symbol

GraphicsBuilder.PageDeleteEx "Example", "TestLibrary", "TestObject", 0
' Deletes the specified Genie
GraphicsBuilder.PageDeleteEx "Example", "TestLibrary", "TestObject", 1
' Deletes the specified Supergenie
GraphicsBuilder.PageDeleteEx "Example", "TestLibrary", "TestObject", 2

PageDeleteObject
現 在 選 択 されているオブジェクト を削 除 します。

シンタックス
PageDeleteObject

399
Chapter: 6 グラフィックス ビルダー オートメーション インターフェース

戻 り値
関 数 が正 常 に実 行 された場 合 は0 (ゼロ) が、それ以 外 の場 合 はエラーが返 されます。

注 : 戻 り値 とエラー値 の処 理 の詳 細 については、エラー処 理 を参 照 してください。

関連項目
PageSelectObject, PageSelectFirstObject, PageSelectNextObject

PageDeleteTemplate
指 定 したグラフィックス ページのテンプレート を削 除 します。

シンタックス
PageDeleteTemplate(Project, Style, Template, Resolution, Titlebar)
Project:

テンプレート を保 管 するプロジェクト の名 前 。

Style:

削 除 するテンプレート のスタイル。

Template：

削 除 するテンプレート の名 前 。

Resolution：

テンプレート の解 像 度 。
l 0 = デフォルト
l 1 = VGA
l 2 = SVGA
l 3 = XGA
l 4 = SXGA
l 5 = ユーザー
Titlebar：

タイト ルバーを選 択 するには真 (TRUE) に設 定 します。

戻 り値
関 数 が正 常 に実 行 された場 合 は0 (ゼロ) が、それ以 外 の場 合 はエラーが返 されます。

400
 Chapter: 6 グラフィックス ビルダー オートメーション インターフェース

注 : 戻 り値 とエラー値 の処 理 の詳 細 については、エラー処 理 を参 照 してください。

関連項目
PageOpen, PageSave, PageSaveAs, PageClose

' Deletes a graphics page template

GraphicsBuilder.PageDeleteTemplate "include", "standard", "blank", 2, True

PageGroupSelectedObjects
現 在 選 択 されているオブジェクト をグループ化 します。

シンタックス
PageGroupSelectedObjects

戻 り値
関 数 が正 常 に実 行 された場 合 は0 (ゼロ) が、それ以 外 の場 合 はエラーが返 されます。

注 : 戻 り値 とエラー値 の処 理 の詳 細 については、エラー処 理 を参 照 してください。

関連項目
PageSelectObject, PageSelectObjectAdd, PageSelectFirstObject, PageSelectNextObject,
PageUngroupSelectedObject

PageImport
グラフィックス ファイルをページにビット マップとしてインポート します。

シンタックス
PageImport(FileName)
FileName:

完 全 なパスを含 む、グラフィック ファイルの名 前 。

戻 り値
関 数 が正 常 に実 行 された場 合 は0 (ゼロ) が、それ以 外 の場 合 はエラーが返 されます。

401
Chapter: 6 グラフィックス ビルダー オートメーション インターフェース

注 : 戻 り値 とエラー値 の処 理 の詳 細 については、エラー処 理 を参 照 してください。

' Imports the graphic file splash.bmp as a bitmap

GraphicsBuilder.PageImport "C:Program Files\Citect\CitectSCADA 7.10\Bin\splash.bmp"

PageNew
新 しい CitectSCADA グラフィックス ページを作 成 します。

シンタックス
PageNew(Project, Style, Template, Resolution, Titlebar, Linked)
Project:

ページに適 用 するテンプレート を含 むプロジェクト の名 前 。

Style:

新 しい CitectSCADA グラフィックス ページに適 用 するスタイル。CitectSCADA テンプレート はスタイル別

にグループ化 されます。

Template：

新 しいCitectSCADAグラフィックスページに適 用 するテンプレート 。

Resolution：

作 成 するページに適 切 な解 像 度 を設 定 します。
l 0 = デフォルト
l 1 = VGA
l 2 = SVGA
l 3 = XGA
l 4 = SXGA
l 5 = ユーザー
Titlebar：

真 (TRUE) に設 定 した場 合 、新 しい CitectSCADA グラフィックス ページにタイト ルバーが含 まれます。

Linked:

真 (TRUE) に設 定 した場 合 、ページはライブラリへリンクされます。

402
 Chapter: 6 グラフィックス ビルダー オートメーション インターフェース

戻 り値
関 数 が正 常 に実 行 された場 合 は0 (ゼロ) が、それ以 外 の場 合 はエラーが返 されます。

注 : 戻 り値 とエラー値 の処 理 の詳 細 については、エラー処 理 を参 照 してください。

関連項目
PageOpen, PageSave, PageSaveAs, PageClose

' Creates a new CitectSCADA graphics page

GraphicsBuilder.PageNew "include", "standard", "blank", 2, True, True

PageNewEx
新 しいシンボル、ジニー、またはスーパージニーのページを作 成 します。

シンタックス
PageNewEx(PageType)
PageType:

作 成 するページのタイプを指 定 します。
l 0 = シンボル
l 1 = ジニー
l 2 = スーパージニー

戻 り値
関 数 が正 常 に実 行 された場 合 は0 (ゼロ) が、それ以 外 の場 合 はエラーが返 されます。

注 : 戻 り値 とエラー値 の処 理 の詳 細 については、エラー処 理 を参 照 してください。

関連項目
PageOpen, PageSave, PageSaveAs, PageClose

403
Chapter: 6 グラフィックス ビルダー オートメーション インターフェース

' Creates a symbol as a new graphics page

GraphicsBuilder.PageOpenEx "Example", "boiler", "tubes1", 0

' Creates a Genie as a new graphics page

GraphicsBuilder.PageOpenEx "Example", "example", "dial", 1

' Creates a Supergenie as a new graphics page

GraphicsBuilder.PageOpenEx "Example", "utility", "!sysinfo", 2

PageNewLibrary
新 しいライブラリを作 成 します。プロジェクト が読 み取 り専 用 の場 合 、または無 効 の場 合 、この
関 数 は失 敗 します。

シンタックス
PageNewLibrary(Project, Library, LibraryType)
Project:

ライブラリを作 成 するプロジェクト の名 前 。

Library:

新 しいライブラリの名 前 (または、テンプレート のスタイル)。

LibraryType：

タイプ：
l 0 = シンボル
l 1 = ジニー
l 2 = スーパージニー
l 3 = テンプレート

戻 り値
関 数 が正 常 に実 行 された場 合 は0 (ゼロ) が、それ以 外 の場 合 はエラーが返 されます。

注 : 戻 り値 とエラー値 の処 理 の詳 細 については、エラー処 理 を参 照 してください。

関連項目
PageOpen, PageSave, PageSaveAs, PageClose

404
 Chapter: 6 グラフィックス ビルダー オートメーション インターフェース

' Creates a new symbol library

GraphicsBuilder.PageNewLibrary "Example", "newlibrary", 0

' Creates a new Genie library

GraphicsBuilder.PageNewLibrary "demo", "newlibrary", 1

' Creates a new Supergenie library

GraphicsBuilder.PageNewLibrary "Example", "newlibrary", 2

' Creates a new template style

GraphicsBuilder.PageNewLibrary "Example", "newstyle", 3

PageNewTemplate
新 しい CitectSCADA グラフィックス ページテンプレート を作 成 します。
PageNewTemplate(Project, Style, Template, Resolution, Titlebar, Linked)
Project:

テンプレート を保 管 するプロジェクト の名 前 。

Style:

新 しいテンプレート に適 用 するスタイル。

Template：

新 しいテンプレート に付 ける名 前 。

Resolution：

作 成 するテンプレート に適 切 な解 像 度 を設 定 します。
l 0 = デフォルト
l 1 = VGA
l 2 = SVGA
l 3 = XGA
l 4 = SXGA
l 5 = ユーザー
Titlebar：

真 (TRUE) に設 定 した場 合 、テンプレート にタイト ルバーが含 まれます。

Linked:

真 (TRUE) に設 定 した場 合 、ページはライブラリへリンクされます。

405
Chapter: 6 グラフィックス ビルダー オートメーション インターフェース

戻 り値
関 数 が正 常 に実 行 された場 合 は0 (ゼロ) が、それ以 外 の場 合 はエラーが返 されます。

注 : 戻 り値 とエラー値 の処 理 の詳 細 については、エラー処 理 を参 照 してください。

関連項目
PageOpen, PageSave, PageSaveAs, PageClose

' Creates a new CitectSCADAgraphics page template

GraphicsBuilder.PageNewTemplate "include", "standard", "blank", 2, True, True

PageOpen
既 存 の CitectSCADA グラフィックス ページを開 きます。

シンタックス
PageOpen(Project, Page)
Project:

開 くページを含 むプロジェクト の名 前 。

Page:

開 くページの名 前 。

戻 り値
関 数 が正 常 に実 行 された場 合 は0 (ゼロ) が、それ以 外 の場 合 はエラーが返 されます。

注 : 戻 り値 とエラー値 の処 理 の詳 細 については、エラー処 理 を参 照 してください。

関連項目
PageNew, PageSave, PageSaveAs, PageClose

406
 Chapter: 6 グラフィックス ビルダー オートメーション インターフェース

' Opens an existing CitectSCADA graphics page

GraphicsBuilder.PageOpen "Example", "Genies"

PageOpenEx
指 定 したシンボル、ジニー、またはスーパージニーを開 きます (検 出 された場 合 )。参 照 先 が見
つからなかった場 合 の詳 細 については、BrokenLinkCancelEnabled を参 照 してください。

シンタックス
PageOpenEx(Project, Library, Element, PageType)
Project:

要 素 が保 存 されているプロジェクト の名 前 。

Library:

要 素 が保 存 されているライブラリの名 前 。

Element:

シンボル、ジニー、またはスーパージニーの名 前 。

PageType:

タイプ：
l 0 = シンボル
l 1 = ジニー
l 2 = スーパージニー

戻 り値
関 数 が正 常 に実 行 された場 合 は0 (ゼロ) が、それ以 外 の場 合 はエラーが返 されます。

注 : 戻 り値 とエラー値 の処 理 の詳 細 については、エラー処 理 を参 照 してください。

関連項目
PageNew, PageSave, PageSaveAs, PageClose

407
Chapter: 6 グラフィックス ビルダー オートメーション インターフェース

' Opens a symbol saved as a graphics page

GraphicsBuilder.PageOpenEx "Example", "boiler", "tubes1", 0

' Opens a Genie saved as a new graphics page

GraphicsBuilder.PageOpenEx "Example", "example", "dial", 1

' Opens a Supergenie saved as a graphics page

GraphicsBuilder.PageOpenEx "Example", "utility", "!sysinfo", 2

PageOpenTemplate
指 定 したグラフィックス ページのテンプレート を開 きます。

シンタックス
PageOpenTemplate(Project, Style, Template, Resolution, Titlebar)
Project:

テンプレート を含 むプロジェクト の名 前 。

Style:

開 くテンプレート のスタイル。

Template：

開 くテンプレート の名 前 。

Resolution：

テンプレート の解 像 度 。
l 0 = デフォルト
l 1 = VGA
l 2 = SVGA
l 3 = XGA
l 4 = SXGA
l 5 = ユーザー
Titlebar：

タイト ルバーを選 択 するには真 (TRUE) に設 定 します。

戻 り値
関 数 が正 常 に実 行 された場 合 は0 (ゼロ) が、それ以 外 の場 合 はエラーが返 されます。

408
 Chapter: 6 グラフィックス ビルダー オートメーション インターフェース

注 : 戻 り値 とエラー値 の処 理 の詳 細 については、エラー処 理 を参 照 してください。

関連項目
PageOpen, PageSave, PageSaveAs, PageClose

' Opens a graphics page template

GraphicsBuilder.PageOpenTemplate "include", "standard", "blank", 2, True

PagePrint
現 在 のページを印 刷 します。

シンタックス
PagePrint

戻 り値
関 数 が正 常 に実 行 された場 合 は0 (ゼロ) が、それ以 外 の場 合 はエラーが返 されます。

注 : 戻 り値 とエラー値 の処 理 の詳 細 については、エラー処 理 を参 照 してください。

関連項目
PageSelectFirstObject, PageSelectNextObject

PageSave
現 在 の名 前 を使 用 して、ページを保 存 します。

シンタックス
PageSave

戻 り値
関 数 が正 常 に実 行 された場 合 は0 (ゼロ) が、それ以 外 の場 合 はエラーが返 されます。

注 : 戻 り値 とエラー値 の処 理 の詳 細 については、エラー処 理 を参 照 してください。

409
Chapter: 6 グラフィックス ビルダー オートメーション インターフェース

関連項目
PageOpen, PageNew, PageSaveAs, PageClose

' Saves an existing CitectSCADA graphics page

GraphicsBuilder.PageSave

PageSaveAs
ページを指 定 したプロジェクト 内 に新 しい名 前 で保 存 します。

シンタックス
PageSaveAs(Project, Page)
Project:

ページを保 存 するプロジェクト の名 前 。

Page:

ページに付 ける名 前 。

戻 り値
関 数 が正 常 に実 行 された場 合 は0 (ゼロ) が、それ以 外 の場 合 はエラーが返 されます。

注 : 戻 り値 とエラー値 の処 理 の詳 細 については、エラー処 理 を参 照 してください。

関連項目
PageNew, PageOpen, PageSave, PageClose
関連項目
CitectSCADAユーザー ガイド の「ページ プロパティ - 一 般 」

' Saves a CitectSCADA graphics page

GraphicsBuilder.PageSaveAs "Example", "MyPage"

PageSaveAsEx
シンボル、ジニー、スーパージニー、またはテンプレート ページを指 定 した場 所 に保 存 します。

410
 Chapter: 6 グラフィックス ビルダー オートメーション インターフェース

シンタックス
PageSaveAsEx(Project, Library, Element)
Project:

要 素 を保 存 するプロジェクト の名 前 。

Library:

要 素 を保 存 するライブラリ (テンプレート の場 合 はスタイル) の名 前 。

Element:

保 存 するシンボル、ジニー、スーパージニー、またはテンプレート の新 しい名 前 。

戻 り値
関 数 が正 常 に実 行 された場 合 は0 (ゼロ) が、それ以 外 の場 合 はエラーが返 されます。

注 : 戻 り値 とエラー値 の処 理 の詳 細 については、エラー処 理 を参 照 してください。

関連項目
PageNew, PageSave, PageSaveAs, PageClose

' Renames and saves the currently selected element to the specified location
GraphicsBuilder.PageSaveAsEx "Example", "TestLibrary", "TestObject"

PageSelect
開 いているページを選 択 します。

シンタックス
PageSelectFirst
sBase - ベース名
sFile - ファイル名

戻 り値
適 用 なし

注 : 戻 り値 とエラー値 の処 理 の詳 細 については、エラー処 理 を参 照 してください。

411
Chapter: 6 グラフィックス ビルダー オートメーション インターフェース

例
Public Sub Example()
Dim gb As GraphicsBuilder.GraphicsBuilder
.
.
.
gb.PageSelect("BaseName", "Filename")
End Sub

関連項目
PageSelectNext

PageSelectFirst
グラフィックス ビルダーで現 在 開 いている最 初 のページを選 択 します。開 いているページがない
場 合 、この関 数 は失 敗 します。

シンタックス
PageSelectFirst

戻 り値
関 数 が正 常 に実 行 された場 合 は0 (ゼロ) が、それ以 外 の場 合 はエラーが返 されます。

注 : 戻 り値 とエラー値 の処 理 の詳 細 については、エラー処 理 を参 照 してください。

関連項目
PageSelectNext

' Selects the first page in Graphics Builder

GraphicsBuilder.PageSelectFirst
If Err.Number <> 0 Then
Output.Print "PageSelectFirst Error" + "; Err.Number = " + Hex(Err.Number)
Else
Output.Print "PageSelectFirst OK"
End If

PageSelectFirstObject
z orderの番 号 に基 づいて、アクティブなページで最 初 のオブジェクト を選 択 します。オブジェクト
が存 在 しない場 合 、終 了 してエラーが返 されます。

412
 Chapter: 6 グラフィックス ビルダー オートメーション インターフェース

シンタックス
PageSelectFirstObject

戻 り値
関 数 が正 常 に実 行 された場 合 は0 (ゼロ) が、それ以 外 の場 合 はエラーが返 されます。

注 : 戻 り値 とエラー値 の処 理 の詳 細 については、エラー処 理 を参 照 してください。

関連項目

PageSelectObject, PageSelectNextObject, PageDeleteObject, PageSelectFirstObjectEx

PageSelectFirstObjectEx
z orderの番 号 に基 づいて、アクティブなページで最 初 のオブジェクト を選 択 します。オブジェクト
が存 在 しない場 合 、終 了 してエラーが返 されます。この関 数 は、グループ内 のアイテムに対 し
て繰 り返 し実 行 されません。

シンタックス
PageSelectFirstObjectEx

戻 り値
関 数 が正 常 に実 行 された場 合 は0 (ゼロ) が、それ以 外 の場 合 はエラーが返 されます。

注 : 戻 り値 とエラー値 の処 理 の詳 細 については、エラー処 理 を参 照 してください。

関連項目
PageSelectObject, PageSelectNextObject, PageDeleteObject, PageSelectFirstObject

PageSelectFirstObjectInGenie
現 在 選 択 されているジニーの、最 初 のサブオブジェクト を選 択 します。

シンタックス
PageSelectFirstObjectInGenie

413
Chapter: 6 グラフィックス ビルダー オートメーション インターフェース

戻 り値
適 用 なし

注 : 戻 り値 とエラー値 の処 理 の詳 細 については、エラー処 理 を参 照 してください。

例
Public Sub Example()
Dim gb As GraphicsBuilder.GraphicsBuilder
.
.
.
gb.PageSelectFirstObjectInGenie()
gb.PageSelectNextObjectInGenie()
gb.PageTemplateSelectFirstObject()
gb.PageTemplateSelectNextObject()
gb.UnLockObject()
End Sub

関連項目
PageSelectNextObjectInGenie

PageSelectFirstObjectInGroup
グループで最 初 のオブジェクト を選 択 します。

シンタックス
PageSelectFirstObjectInGroup

戻 り値
関 数 が正 常 に実 行 された場 合 は0 (ゼロ) が、それ以 外 の場 合 はエラーが返 されます。

注 : 戻 り値 とエラー値 の処 理 の詳 細 については、エラー処 理 を参 照 してください。

関連項目
PageSelectObject, PageSelectNextObject, PageDeleteObject, PageSelectFirstObject

PageSelectNext
グラフィックス ビルダーで現 在 開 いている次 のページを選 択 します。開 いているページがない場
合 、この関 数 は失 敗 します。

414
 Chapter: 6 グラフィックス ビルダー オートメーション インターフェース

シンタックス
PageSelectNext

戻 り値
関 数 が正 常 に実 行 された場 合 は0 (ゼロ) が、それ以 外 の場 合 はエラーが返 されます。

注 : 戻 り値 とエラー値 の処 理 の詳 細 については、エラー処 理 を参 照 してください。

関連項目
PageSelectFirst

' Selects the next page in Graphics Builder

GraphicsBuilder.PageSelectNext
If Err.Number <> 0 Then
Output.Print "PageSelectNext Error" + "; Err.Number = " +
Hex(Err.Number)
Else
Output.Print "PageSelectNext OK"
End If

PageSelectNextObject
z orderの番 号 に基 づいて、アクティブなページで次 のオブジェクト を選 択 します。オブジェクト が
存 在 しない場 合 、この関 数 が終 了 してエラーが返 されます。オブジェクト がグループ化 されたオ
ブジェクト の場 合 は、グループ内 のアイテムに対 しこの関 数 が繰 り返 し実 行 されます。

シンタックス
PageSelectNextObject

戻 り値
関 数 が正 常 に実 行 された場 合 は0 (ゼロ) が、それ以 外 の場 合 はエラーが返 されます。

注 : 戻 り値 とエラー値 の処 理 の詳 細 については、エラー処 理 を参 照 してください。

関連項目
PageSelectObject, PageSelectFirstObject, PageDeleteObject, PageSelectNextObjectEx

415
Chapter: 6 グラフィックス ビルダー オートメーション インターフェース

PageSelectNextObjectEx
z orderの番 号 に基 づいて、アクティブなページで次 のオブジェクト を選 択 します。オブジェクト が
存 在 しない場 合 、この関 数 が終 了 してエラーが返 されます。この関 数 は、グループ内 のアイテ
ムに対 して繰 り返 し実 行 されません。

シンタックス
PageSelectNextObjectEx

戻 り値
関 数 が正 常 に実 行 された場 合 は0 (ゼロ) が、それ以 外 の場 合 はエラーが返 されます。

注 : 戻 り値 とエラー値 の処 理 の詳 細 については、エラー処 理 を参 照 してください。

関連項目
PageSelectObject, PageSelectFirstObject, PageDeleteObject, PageSelectNextObjectEx

PageSelectNextObjectInGenie
現 在 選 択 されているジニーの、次 のサブオブジェクト を選 択 します。

シンタックス
PageSelectNextObjectInGenie

戻 り値
適 用 なし

注 : 戻 り値 とエラー値 の処 理 の詳 細 については、エラー処 理 を参 照 してください。

Public Sub Example()

Dim gb As GraphicsBuilder.GraphicsBuilder
.
.
.
gb.PageSelectFirstObjectInGenie()
gb.PageSelectNextObjectInGenie()
gb.PageTemplateSelectFirstObject()
gb.PageTemplateSelectNextObject()

416
 Chapter: 6 グラフィックス ビルダー オートメーション インターフェース

gb.UnLockObject()
End Sub

関連項目
PageSelectFirstObjectInGenie

PageSelectNextObjectInGroup
グループ内 の次 のオブジェクト を選 択 します。

シンタックス
PageSelectNextObjectInGroup

戻 り値
関 数 が正 常 に実 行 された場 合 は0 (ゼロ) が、それ以 外 の場 合 はエラーが返 されます。

注 : 戻 り値 とエラー値 の処 理 の詳 細 については、エラー処 理 を参 照 してください。

関連項目
PageSelectFirstObjectInGroup

PageSelectObject
指 定 したAN番 号 を使 用 して、オブジェクト を選 択 します。

シンタックス
PageSelectObject(AN)
AN:

選 択 するオブジェクト のAN番 号 。

戻 り値
関 数 が正 常 に実 行 された場 合 は0 (ゼロ) が、それ以 外 の場 合 はエラーが返 されます。

注 : 戻 り値 とエラー値 の処 理 の詳 細 については、エラー処 理 を参 照 してください。

関連項目
PageSelectObjectAdd, PageSelectFirstObject, PageSelectNextObject, PageDeleteObject

417
Chapter: 6 グラフィックス ビルダー オートメーション インターフェース

PageSelectObjectAdd
指 定 されたAN番 号 を使 用 して、追 加 オブジェクト を選 択 します。PageGroupSelectedObjects
に続 けて実 行 して、複 数 のオブジェクト を選 択 するのに使 用 できます。

シンタックス
PageSelectObjectAdd(AN)
AN:

選 択 するオブジェクト のAN番 号 。

戻 り値
関 数 が正 常 に実 行 された場 合 は0 (ゼロ) が、それ以 外 の場 合 はエラーが返 されます。

注 : 戻 り値 とエラー値 の処 理 の詳 細 については、エラー処 理 を参 照 してください。

関連項目
PageSelectObject, PageSelectFirstObject, PageSelectNextObject, PageGroupSelectedObjects

PageTemplateSelectFirstObject
テンプレート 列 挙 型 シーケンスを再 起 動 します。

シンタックス
PageTemplateSelectFirstObject

戻 り値
適 用 なし

注 : 戻 り値 とエラー値 の処 理 の詳 細 については、エラー処 理 を参 照 してください。

Public Sub Example()

Dim gb As GraphicsBuilder.GraphicsBuilder
.
.
.
gb.PageSelectFirstObjectInGenie()

418
 Chapter: 6 グラフィックス ビルダー オートメーション インターフェース

gb.PageSelectNextObjectInGenie()
gb.PageTemplateSelectFirstObject()
gb.PageTemplateSelectNextObject()
gb.UnLockObject()
End Sub

関連項目
PageTemplateSelectNextObject

PageTemplateSelectNextObject
テンプレート 内 の次 のオブジェクト を選 択 します。

シンタックス
PageTemplateSelectNextObject

戻 り値
適 用 なし

注 : 戻 り値 とエラー値 の処 理 の詳 細 については、エラー処 理 を参 照 してください。

Public Sub Example()

Dim gb As GraphicsBuilder.GraphicsBuilder
.
.
.
gb.PageSelectFirstObjectInGenie()
gb.PageSelectNextObjectInGenie()
gb.PageTemplateSelectFirstObject()
gb.PageTemplateSelectNextObject()
gb.UnLockObject()
End Sub

関連項目
PageTemplateSelectFirstObject

PageThumbnailToClipboard
現 在 のページのサムネイル イメージを作 成 して、クリップボード にコピーします。

419
Chapter: 6 グラフィックス ビルダー オートメーション インターフェース

シンタックス
PageThumbnailToClipboard(Size)
Size:

サムネイル イメージのピクセルによるサイズ。

戻 り値
関 数 が正 常 に実 行 された場 合 は0 (ゼロ) が、それ以 外 の場 合 はエラーが返 されます。

注 : 戻 り値 とエラー値 の処 理 の詳 細 については、エラー処 理 を参 照 してください。

PageUngroupSelectedObject
現 在 選 択 されているグループ化 されたオブジェクト のグループ化 を解 除 します。

シンタックス
PageUngroupSelectedObject

戻 り値
関 数 が正 常 に実 行 された場 合 は0 (ゼロ) が、それ以 外 の場 合 はエラーが返 されます。

注 : 戻 り値 とエラー値 の処 理 の詳 細 については、エラー処 理 を参 照 してください。

関連項目
PageSelectObject, PageSelectObjectAdd, PageSelectFirstObject, PageSelectNextObject,
PageGroupSelectedObjects

PageUpdated
このイベント は、グラフィックス ビルダー ページが更 新 された場 合 に発 生 します。

シンタックス
PageUpdated(sProject, sPage)
sProject - プロジェクト 名
sPage - ページ名

420
 Chapter: 6 グラフィックス ビルダー オートメーション インターフェース

戻 り値
適 用 なし

注 : 戻 り値 とエラー値 の処 理 の詳 細 については、エラー処 理 を参 照 してください。

関連項目
PageSelectNext

例
Sub PageUpdated(ByVal bstrProject As String, ByVal bstrPage As String, ByVal bLastPage As Boolean)
' Add your code here
End sub

ページ プロパティの関 数
ページ プロパティ関 数 を使 用 して、プロジェクト のページのプロパティが操 作 できます。

PageAddAssociation 新 規 アソシエーションを現 在 のページに追 加 します。この関 数 は、指 定

した名 前 のアソシエーションが既 に存 在 する場 合 にエラーを返 します。

PageAssociationDefault 現 在 選 択 しているページ アソシエーションのデフォルト を設 定 または取

得 します。

PageAssociationDescription 現 在 選 択 しているページ アソシエーションの説 明 を設 定 または取 得 しま

す。

PageAssociationName 現 在 選 択 しているページ アソシエーションの名 前 を取 得 します。

PageAssociationValueOnError 現 在 選 択 しているページ アソシエーションのエラー値 を設 定 または取 得

します。

PageAppearanceGet ページの表 示 プロパティを取 得 します。この関 数 では True Color 機

能 がサポート されていないため、PageAppearanceGetEx 関 数 に
置 き換 えられました。

PageAppearanceGetEx ページの表 示 プロパティを取 得 します。この関 数 は True Color 機

能 をサポート しており、PageAppearanceGet 関 数 を置 き換 えるも
のです。

PageArea 現 在 のグラフィックス ページの PageArea プロパティを取 得 または設

定 します。

PageClusterInherit 現 在 のグラフィックス ページ用 のクラスタ コンテキスト 継 承 フラグを取

得 または設 定 します。

421
Chapter: 6 グラフィックス ビルダー オートメーション インターフェース

PageClusterName 現 在 のグラフィックス ページのクラスタ コンテキスト 名 プロパティを取

得 または設 定 します。

PageDeleteAssociation 選 択 したアソシエーションを現 在 のページから削 除 します。項 目 が削 除

された後 、PageSelectNextAssociation への呼 び出 しで削 除 された
項 目 の直 後 の項 目 が選 択 されます。

PageDescription アクティブな CitectSCADA グラフィックス ページに説 明 を添 付 、また

は添 付 されている説 明 を取 得 します。

PageEnvironmentAdd 新 規 環 境 変 数 を現 在 のページに追 加 します。この関 数 は、指 定 した

名 前 の環 境 変 数 が存 在 しない場 合 にエラーを返 します。

PageEnvironmentFirst 現 在 のページの、最 初 の環 境 変 数 を取 得 します。この関 数 は、ページ

に環 境 変 数 がない場 合 にエラーを返 します。

PageEnvironmentNext 現 在 のページの、次 の環 境 変 数 を取 得 します。この関 数 は、ページに

これ以 上 環 境 変 数 がない場 合 にエラーを返 します。

PageEnvironmentRemove 環 境 変 数 を、現 在 のページから削 除 します。この関 数 は、指 定 した名

前 の環 境 変 数 が既 に存 在 する場 合 にエラーを返 します。

PageLogDevice 現 在 のグラフィックス ページの LogDevice プロパティを取 得 または設

定 します。

PageName アクティブなページの名 前 を返 します。この属 性 は読 み取 り専 用 で

す。

PageNext アクティブなグラフィックス ページで現 在 「次 の」ページとして定 義 され

ているページの名 前 を取 得 します。または、次 のページとして定 義 す
るページを設 定 します。

PagePrevious アクティブなグラフィックス ページに対 し、現 在 「前 の」ページとして定

義 されているページの名 前 を取 得 します。または、前 のページとして
定 義 するページを設 定 します。

PageScanTime 現 在 のグラフィックス ページの PageScanTime プロパティを取 得 また

は設 定 します。

PageSelectAssociationByName 現 在 のページの指 定 したアソシエーションを選 択 します。

PageSelectFirstAssociation 現 在 のページの最 初 のアソシエーションを選 択 します。

PageSelectNextAssociation 現 在 のページの次 のアソシエーションを選 択 します。

PageTitle アクティブな CitectSCADA グラフィックス ページのタイト ルを設 定 また

は取 得 します。

戻 り値 とエラー値 の処 理 の詳 細 、およびVisual Basicのサンプルについては、エラー処 理 を参

照 してください。

PageAddAssociation

422
 Chapter: 6 グラフィックス ビルダー オートメーション インターフェース

新 規 アソシエーションを現 在 のページに追 加 します。この関 数 は、指 定 した名 前 のアソシエー

ションが既 に存 在 する場 合 にエラーを返 します。

シンタックス
PageAddAssociation(Name)
Name:

現 在 のページに追 加 する新 規 アソシエーションの名 前 です。

戻 り値
関 数 が正 常 に実 行 された場 合 は0 (ゼロ) が、それ以 外 の場 合 はエラーが返 されます。

注 : 戻 り値 とエラー値 の処 理 の詳 細 については、エラー処 理 を参 照 してください。

例
新 規 要 素 を追 加 し、次 のようにプロパティを設 定 します。

GraphicsBuilder.PageAddAssociation("MyAssociation")
GraphicsBuilder.SelectAssociationByName("MyAssociation")
GraphicsBuilder.PageAssociationsDefault = "TAG0"
GraphicsBuilder.PageAssociationValueOnError = "Oops"
GraphicsBuilder.PageAssociationDescription = "My Association"

関連項目
PageAssociationDefault、PageAssociationDescription

PageAppearanceGet
ページの表 示 プロパティを取 得 します。

注 : この関 数 では True Colour 機 能 がサポート されていないため、PageAppearanceGetEx

関 数 に置 き換 えられました。

シンタックス
PageAppearanceGet(Project, Style, Template, Resolution, Titlebar, Width, Height, Colour)
Project:

テンプレート を保 管 するプロジェクト の名 前 。

Style:

423
Chapter: 6 グラフィックス ビルダー オートメーション インターフェース

テンプレート のスタイル。

Template：

プロジェクト の名 前 。

Resolution：

テンプレート の解 像 度 。
l 0 = デフォルト
l 1 = VGA
l 2 = SVGA
l 3 = XGA
l 4 = SXGA
l 5 = ユーザー
Titlebar：

タイト ルバーが選 択 されている場 合 は真 (TRUE)。

Width:

ページの幅 ( ピクセル単 位 ) です。

Height:

ページの高 さ( ピクセル単 位 ) です。

Colour:

ページのバックグラウンド色 。

戻 り値
要 求 された値 (文 字 列 )。

注 : 戻 り値 とエラー値 の処 理 の詳 細 については、エラー処 理 を参 照 してください。

関連項目
PageOpen, PageSave, PageSaveAs, PageClose

PageAppearanceGetEx
ページの表 示 プロパティを取 得 します。

424
 Chapter: 6 グラフィックス ビルダー オートメーション インターフェース

シンタックス
PageAppearanceGetEx(Project, Style, Template, Resolution, Titlebar, Width, Height,
OnColour, OffColour)
Project:

テンプレート を含 むプロジェクト の名 前 。

Style:

テンプレート のスタイル。

Template：

テンプレート の名 前 。

Resolution：

テンプレート の解 像 度 。
l 0 = デフォルト
l 1 = VGA
l 2 = SVGA
l 3 = XGA
l 4 = SXGA
l 5 = ユーザー
Titlebar：

タイト ルバーが選 択 されている場 合 は真 (TRUE)。

Width:

ピクセルによるページの幅 。

Height:

ピクセルによるページの高 さ。

OnColour:

オンの場 合 のページのバックグラウンド色 を示 す RGB 値 。

OffColour:

オフの場 合 のページのバックグラウンド色 を示 す RGB 値 。

戻 り値
要 求 された値 (文 字 列 )。

425
Chapter: 6 グラフィックス ビルダー オートメーション インターフェース

注 : 戻 り値 とエラー値 の処 理 の詳 細 については、エラー処 理 を参 照 してください。

関連項目
PageOpen, PageSave, PageSaveAs, PageClose

PageArea
現 在 のグラフィックス ページの PageArea プロパティを取 得 または設 定 します。

シンタックス
PageArea(Area)
Area:

1 ～ 255の文 字 列 。または、ページをすべてのエリアに割 り当 てる場 合 は空 白 にします。

戻 り値
現 在 の PageArea 設 定 を取 得 する場 合 、1 ～ 255 が文 字 列 として返 されます。あらかじめ設
定 されたグループを使 用 してセキュリティが設 定 されている場 合 は、グループ名 が文 字 列 として
返 されます。アクティブなページがすべてのエリアに割 り当 てられている場 合 は、空 白 の文 字 列
が返 されます。
この関 数 を使 用 してエリアの設 定 を適 用 する場 合 は、正 常 に適 用 が完 了 した場 合 は 0 (ゼ
ロ) が、適 用 する値 が範 囲 外 であれば E_INVALIDARG エラーが返 されます。

注 : 戻 り値 とエラー値 の処 理 の詳 細 については、エラー処 理 を参 照 してください。

関連項目
PageName, PageTitle, PageDescription, PagePrevious, ProjectNext, PageScanTime,
PageLogDevice
関連項目
CitectSCADAユーザー ガイド の「ページ プロパティ - 一 般 」

' Assigns a page to one of the areas defined in aCitectSCADA project

GraphicsBuilder.PageArea = "1"

' Retrieves the name of the area the current page is assigned to
MyVariable = GraphicsBuilder.PageArea

426
 Chapter: 6 グラフィックス ビルダー オートメーション インターフェース

注 : この関 数 は、C++環 境 では2つの独 立 した関 数 として実 行 されます。put_PageArea は

アクティブなグラフィックスページに対 してエリア設 定 を適 用 し、get_PageArea 現 行 のエリア設
定 を取 得 します。

PageAssociationDefault
現 在 選 択 しているページ アソシエーションのデフォルト を設 定 または取 得 します。

シンタックス
Def = PageAssociationDefault
PageAssociationDefault(Def)
Def:

ページ アソシエーションが、ランタイムで Ass(..) Cicode 関 数 を使 用 して実 行 されなかった場 合 に使 用 さ

れる、デフォルト の置 き換 え文 字 列 。デフォルト は、シングル クォーテーションで囲 んだリテラル文 字 列 (例
えば 'リテラル値 ') または有 効 なタグ名 である必 要 があります。

戻 り値
現 在 選 択 しているアソシエーションのデフォルト (文 字 列 )、または、デフォルト を設 定 する場 合
は、設 定 が正 常 に完 了 すれば 0 (ゼロ)。正 常 に行 われなかった場 合 はエラーが返 されます。

関連項目
PageAddAssociation、PageAssociationDescription

PageAssociationDescription
現 在 選 択 しているページ アソシエーションの説 明 を設 定 または取 得 します。

シンタックス
Description = PageAssociationDescription
PageAssociationDescription(Description)
Description:

アソシエーションのテキスト 説 明 。

戻 り値
現 在 選 択 しているアソシエーションの説 明 (文 字 列 )、または、説 明 を設 定 する場 合 は、設 定
が正 常 に完 了 すれば 0 (ゼロ)。正 常 に行 われなかった場 合 はエラーが返 されます。

427
Chapter: 6 グラフィックス ビルダー オートメーション インターフェース

関連項目
PageAddAssociation

PageAssociationName
現 在 選 択 しているページ アソシエーションの名 前 を取 得 する。

シンタックス
Name = PageAssociationName

戻 り値
現 在 選 択 しているアソシエーションの名 前 (文 字 列 ) を返 します。正 常 に行 われなかった場 合
はエラーが返 されます。

関連項目
PageAddAssociation、PageAssociationDescription

PageAssociationValueOnError
現 在 選 択 しているページ アソシエーションのエラー値 を設 定 または取 得 します。

シンタックス
Vaｌ
OnErr = PageAssociationValueOnError
PageAssociationValueOnError(エラー値 )
ValonErr:

置 き換 えが実 行 されず、デフォルト 値 が定 義 されていない場 合 や、解 決 されないタグ名 が指 定 された場

合 に使 用 する値 。

戻 り値
現 在 選 択 しているアソシエーションのエラー値 (文 字 列 )、または、エラー値 を設 定 する場 合
は、設 定 が正 常 に完 了 すれば 0 (ゼロ)。正 常 に行 われなかった場 合 はエラーが返 されます。

関連項目
PageAddAssociation、PageAssociationDescription

PageClusterInherit
現 在 のグラフィックス ページ用 のクラスタ コンテキスト 継 承 フラグを取 得 または設 定 します。

428
 Chapter: 6 グラフィックス ビルダー オートメーション インターフェース

シンタックス
PageClusterInherit(bInherit)
bInherit:

ブール値 としてのクラスタ コンテキスト 継 承 フラグの設 定 。

戻 り値
アクティブなグラフィックス ページのクラスタコンテキスト 継 承 フラグ( ブール値 として) 、または継 承
フラグの設 定 に成 功 した場 合 は 0 (ゼロ)。いずれの場 合 も、正 常 に完 了 しないとエラーが返 さ
れます。

関連項目
PageClusterName
関連項目
CitectSCADAユーザー ガイド の「ページ プロパティ - 一 般 」

' Sets the cluster context inherit flag for current page
GraphicsBuilder.PageClusterInherit = "1"

' Retrieves the cluster context inherit flag for current page
MyVariable = GraphicsBuilder.PageClusterInherit

PageClusterName
現 在 のグラフィックス ページのクラスタ コンテキスト 名 プロパティを取 得 または設 定 します。

シンタックス
PageClusterName(ClusterName)
ClusterName:

クラスタの名 前 を文 字 列 として返 します。

戻 り値
アクティブなグラフィックス ページの ClusterName 設 定 (文 字 列 )、または、ClusterName を設
定 する場 合 は、設 定 が正 常 に完 了 すれば 0 (ゼロ)。いずれの場 合 も、正 常 に完 了 しないとエ
ラーが返 されます。

429
Chapter: 6 グラフィックス ビルダー オートメーション インターフェース

関連項目
PageClusterInherit
関連項目
CitectSCADAユーザー ガイド の「ページ プロパティ - 一 般 」

' Sets the cluster context name property setting for current page
GraphicsBuilder.PageClusterName = "Cluster1"
' Retrieves the cluster context name property setting for current page
MyVariable = GraphicsBuilder.PageClusterName

PageDeleteAssociation
選 択 したアソシエーションを現 在 のページから削 除 します。
項 目 が削 除 された後 、PageSelectNextAssociation への呼 び出 しで削 除 された項 目 の直 後
の項 目 が選 択 されます。

シンタックス
PageDeleteAssociation()

戻 り値
関 数 が正 常 に実 行 された場 合 は0 (ゼロ) が、それ以 外 の場 合 はエラーが返 されます。

注 : 戻 り値 とエラー値 の処 理 の詳 細 については、エラー処 理 を参 照 してください。

例
「a」で始 まるすべてのアソシエーションを削 除 します。

Dim name As String

On Error Resume Next
Err.Clear()
GraphicsBuilder.SelectFirstAssociation()
While (Err.Number = 0)
name = GraphicsBuilder.PageAssociationName
If (name.ToLower().StartsWith("a")) Then
GraphicsBuilder.PageDeleteAssociation()
End If
GraphicsBuilder.PageSelectNextAssociation()

430
 Chapter: 6 グラフィックス ビルダー オートメーション インターフェース

End While

関連項目
PageSelectNextAssociation

PageDescription
アクティブな CitectSCADA グラフィックス ページに説 明 を添 付 、または添 付 されている説 明 を
取 得 します。

シンタックス
PageDescription(Description)
Description:

アクティブな CitectSCADA グラフィックス ページに適 用 する説 明 (文 字 列 )。

戻 り値
アクティブなグラフィックス ページの説 明 (文 字 列 )、または、アクティブなグラフィックス ページに説
明 を適 用 する場 合 は、適 用 が正 常 に完 了 すれば 0 (ゼロ)。いずれの場 合 も、正 常 に完 了 し
ないとエラーが返 されます。

注 : 戻 り値 とエラー値 の処 理 の詳 細 については、エラー処 理 を参 照 してください。

関連項目
PageName, PageTitle, PagePrevious, ProjectNext, PageScanTime, PageLogDevice,
PageNext, PageArea
関連項目
CitectSCADAユーザー ガイド の「ページ プロパティ - 一 般 」

' Attaches a description to the active graphics page

GraphicsBuilder.PageDescription = "MyDescription"

' Retrieves the description for the active graphics page

MyVariable = GraphicsBuilder.PageDescription

注 : この関 数 は、C++環 境 では2つの独 立 した関 数 として実 行 されます。put_

431
Chapter: 6 グラフィックス ビルダー オートメーション インターフェース

PageDescription によってアクティブなグラフィックス ページのタイト ルが設 定 され、get_

PageDescription によってアクティブなグラフィックス ページのタイト ルが取 得 されます。

PageEnvironmentAdd
現 在 のページに新 規 環 境 変 数 を追 加 します。この関 数 は、指 定 した名 前 の環 境 変 数 が既
に存 在 する場 合 はエラーを返 します。

シンタックス
PageEnvironmentAdd(name, value)
Name:

新 規 環 境 変 数 の名 前 を指 定 します。

Value:

新 規 環 境 変 数 に関 連 付 ける値 を指 定

戻 り値
関 数 が正 常 に実 行 された場 合 は0 (ゼロ) が、それ以 外 の場 合 はエラーが返 されます。

例
新 規 環 境 変 数 の追 加

GraphicsBuilder.PageEnvironmentAdd("Foo", "Bar")

関連項目
PageEnvironmentFirst

PageEnvironmentFirst
現 在 のページの、最 初 の環 境 変 数 を取 得 します。この関 数 は、ページに環 境 変 数 がない場
合 にエラーを返 します。

シンタックス
PageEnvironmentFirst(name, value)
Name:

現 在 のページの、最 初 の環 境 変 数 の名 前 を取 得 します。

Value:

432
 Chapter: 6 グラフィックス ビルダー オートメーション インターフェース

最 初 の環 境 変 数 に関 連 付 けられている値 を取 得 します。

戻 り値
関 数 が正 常 に実 行 された場 合 は0 (ゼロ) が、それ以 外 の場 合 はエラーが返 されます。

例
すべての環 境 変 数 を印 刷 します。

Dim name As String

Dim value As String
Dim prevName As String
On Error Resume Next
Err.Clear()
GraphicsBuilder.PageEnvironmentFirst(name, value)
While (Err.Number = 0)
Console.Out.WriteLine(name + "=" + value)
prevName = name
GraphicsBuilder.PageEnvironmentNext(prevName, name, value)
End While

関連項目
PageEnvironmentAdd

PageEnvironmentNext
現 在 のページの、次 の環 境 変 数 を取 得 します。この関 数 は、ページにこれ以 上 環 境 変 数 が
ない場 合 にエラーを返 します。

シンタックス
PageEnvironmentNext(currentName, nextName, nextValue)
currentName:

現 在 の環 境 変 数 の名 前 を指 定 します。

nextName:

現 在 の環 境 変 数 の名 前 を受 け取 ります。

nextValue:

次 の環 境 変 数 に関 連 付 けられている値 を受 け取 ります。

戻 り値
関 数 が正 常 に実 行 された場 合 は0 (ゼロ) が、それ以 外 の場 合 はエラーが返 されます。

433
Chapter: 6 グラフィックス ビルダー オートメーション インターフェース

関連項目
PageEnvironmentFirst

PageEnvironmentRemove
環 境 変 数 を、現 在 のページから削 除 します。この関 数 は、指 定 した名 前 の環 境 変 数 が存 在
しない場 合 にエラーを返 します。

シンタックス
PageEnvironmentRemove(name)
name:

削 除 する環 境 変 数 の名 前 を指 定 します。

戻 り値
関 数 が正 常 に実 行 された場 合 は0 (ゼロ) が、それ以 外 の場 合 はエラーが返 されます。

例
既 存 の環 境 変 数 の削 除

GraphicsBuilder.PageEnvironmentRemove("Foo")

既 存 の環 境 変 数 の更 新

GraphicsBuilder.PageEnvironmentRemove("Foo")
GraphicsBuilder.PageEnvironmentAdd("Foo", "Bar2")

関連項目
PageEnvironmentFirst

PageLogDevice
現 在 のグラフィックス ページの LogDevice プロパティを取 得 または設 定 します。

シンタックス
PageLogDevice(LogDevice)
LogDevice:

ログ デバイスの名 前 (文 字 列 )。

434
 Chapter: 6 グラフィックス ビルダー オートメーション インターフェース

戻 り値
アクティブなグラフィックス ページの LogDevice 設 定 (文 字 列 )、または、LogDevice を設 定 する
場 合 は、設 定 が正 常 に完 了 すれば 0 (ゼロ)。いずれの場 合 も、正 常 に完 了 しないとエラーが
返 されます。

注 : 戻 り値 とエラー値 の処 理 の詳 細 については、エラー処 理 を参 照 してください。

関連項目
PageName, PageTitle, PageDescription, PagePrevious, PageNext, PageScanTime
関連項目
CitectSCADAユーザー ガイド の「ページ プロパティ - 一 般 」

' Sets the LogDevice for the current graphics page

GraphicsBuilder.PageLogDevice = "MyDevice"

' Retrieves the name of the LogDevice for the current page
MyVariable = GraphicsBuilder.PageLogDevice

注 : この関 数 は、C++環 境 では2つの独 立 した関 数 として実 行 されます。put_

PageLogDevice はアクティブなグラフィックスページに対 して LogDevice 設 定 を適 用 し、get_
PageLogDevice 現 行 の LogDevice 設 定 を取 得 します。

PageName
アクティブなページの名 前 を返 します。この属 性 は読 み取 り専 用 です。

シンタックス
PageName(PageName)
PageName:

アクティブなページの名 前 を文 字 列 として返 します。

戻 り値
アクティブな CitectSCADA グラフィックス ページの名 前 (文 字 列 )。

注 : 戻 り値 とエラー値 の処 理 の詳 細 については、エラー処 理 を参 照 してください。

435
Chapter: 6 グラフィックス ビルダー オートメーション インターフェース

関連項目
PageTitle, PageDescription, PagePrevious, PageNext, PageArea, PageScanTime,
PageLogDevice
関連項目
CitectSCADAユーザー ガイド の「ページ プロパティ - 一 般 」

Debug.Print "PageName"; GraphicsBuilder.PageName

PageNext
アクティブなグラフィックス ページで現 在 「次 の」ページとして定 義 されているページの名 前 を取
得 します。または、次 のページとして定 義 するページを設 定 します。

シンタックス
PageNext(PageName)
PageName:

アクティブなグラフィックス ページに対 し、次 のページとして定 義 するページの名 前 。

戻 り値
アクティブなグラフィックス ページに対 し、次 のページとして定 義 されているページの名 前 。また
は、次 のページを定 義 する場 合 は、設 定 が正 常 に完 了 すれば 0 (ゼロ)。いずれの場 合 も、正
常 に完 了 しないとエラーが返 されます。

注 : 戻 り値 とエラー値 の処 理 の詳 細 については、エラー処 理 を参 照 してください。

関連項目
PageName, PageTitle, PageDescription, PagePrevious, PageArea, PageScanTime,
PageLogDevice
関連項目
CitectSCADAユーザー ガイド の「ページ プロパティ - 一 般 」

436
 Chapter: 6 グラフィックス ビルダー オートメーション インターフェース

' Defines a page as the one that follows the current page in a browse sequence
GraphicsBuilder.PageNext = "MyPage3"
' Retrieves the name of the page that follows the current page in a browse sequence
MyVariable = GraphicsBuilder.PageNext

注 : この関 数 は、C++環 境 では2つの独 立 した関 数 として実 行 されます。put_PageNext によ

ってアクティブなグラフィックス ページの次 のページが設 定 され、get_PageNext によって次 のグ
ラフィックス ページの名 前 が取 得 されます。

PagePrevious
アクティブなグラフィックス ページに対 し、現 在 「前 の」ページとして定 義 されているページの名 前
を取 得 します。または、前 のページとして定 義 するページを設 定 します。

シンタックス
PagePrevious(PageName)
PageName:

アクティブなグラフィックス ページに対 し、前 のページとして定 義 するページの名 前 。

戻 り値
アクティブなグラフィックス ページに対 し、前 のページとして定 義 されているページの名 前 。また
は、、アクティブなグラフィックス ページに対 して前 のページを定 義 する場 合 は、設 定 が正 常 に
完 了 すれば 0 (ゼロ)。いずれの場 合 も、正 常 に完 了 しないとエラーが返 されます。

注 : 戻 り値 とエラー値 の処 理 の詳 細 については、エラー処 理 を参 照 してください。

関連項目
PageName, PageTitle, PageDescription, PageNext, PageArea, PageScanTime,
PageLogDevice
関連項目
CitectSCADAユーザー ガイド の「ページ プロパティ - 一 般 」

437
Chapter: 6 グラフィックス ビルダー オートメーション インターフェース

' Defines a page as previous to the current page in a browse sequence

GraphicsBuilder.PagePrevious = "MyPage1"
' Retrieves the name for the page defined as previous to the current page
MyVariable = GraphicsBuilder.PagePrevious

注 : この関 数 は、C++環 境 では2つの独 立 した関 数 として実 行 されます。put_PagePrevious

によってアクティブなグラフィックス ページの前 のページが設 定 され、get_PagePrevious によっ
て前 のグラフィックス ページの名 前 が取 得 されます。

PageScanTime
現 在 のグラフィックス ページの PageScanTime プロパティを取 得 または設 定 します。

シンタックス
PageScanTime(ScanTime)
ScanTime:

1 ～ 60000の文 字 列 の値 。または、デフォルト に設 定 する場 合 は空 白 。

戻 り値
現 在 の PageScanTime の設 定 を取 得 する場 合 は、1 ～ 60000 の文 字 列 の値 。または、デフ
ォルト に設 定 されている場 合 は空 白 。
この関 数 を使 用 して ScanTime の設 定 を適 用 する場 合 は、正 常 に適 用 が完 了 した場 合 は
0 (ゼロ) が、適 用 する値 が範 囲 外 であれば E_INVALIDARG エラーが返 されます。

注 : 戻 り値 とエラー値 の処 理 の詳 細 については、エラー処 理 を参 照 してください。

関連項目
PageName, PageTitle, PageDescription, PagePrevious, PageNext, PageLogDevice
関連項目
CitectSCADAユーザー ガイド の「ページ プロパティ - 一 般 」

' Assigns a ScanTime value to the current graphics page

GraphicsBuilder.PageScanTime = "2000"

438
 Chapter: 6 グラフィックス ビルダー オートメーション インターフェース

' Retrieves the ScanTime setting for the current page

MyVariable = GraphicsBuilder.PageScanTime

注 : この関 数 は、C++環 境 では2つの独 立 した関 数 として実 行 されます。put_PageScanTime

はアクティブなグラフィックスページに対 して ScanTime 設 定 を適 用 し、get_PageScanTime 現
行 の ScanTime 設 定 を取 得 します。

PageSelectAssociationByName
現 在 のページの指 定 したアソシエーションを選 択 します。

シンタックス
PageSelectAssociationByName(Name)
Name
選 択 するアソシエーションの名 前 。

戻 り値
関 数 が正 常 に実 行 された場 合 は0 (ゼロ) が、それ以 外 の場 合 はエラーが返 されます。

例
特 定 の名 前 のアソシエーションが存 在 するかの確 認

On Error Resume Next

Err.Clear()
GraphicsBuilder.SelectAssociationByName("MyAssociation")
If (Err.Number <> 0)
' The association does not exist
End If

関連項目
PageAddAssociation

PageSelectFirstAssociation
現 在 のページの最 初 のアソシエーションを選 択 します。

シンタックス
PageSelectFirstAssociation()

439
Chapter: 6 グラフィックス ビルダー オートメーション インターフェース

戻 り値
関 数 が正 常 に実 行 された場 合 は0 (ゼロ) が、それ以 外 の場 合 はエラーが返 されます。

例
現 在 のページに、このページ プロパティでのアソシエーションがあるかどうか確 認 します。

On Error Resume Next

Err.Clear()
GraphicsBuilder.SelectFirstAssociation()
If (Err.Number <> 0)
' The page has no associations
End If

関連項目
PageAddAssociation、PageAssociationDescription

PageSelectNextAssociation
現 在 のページの次 のアソシエーションを選 択 します。

シンタックス
PageSelectNextAssociation()

戻 り値
関 数 が正 常 に実 行 された場 合 は0 (ゼロ) が、それ以 外 の場 合 はエラーが返 されます。

例
現 在 のページのプロパティのすべてのアソシエーションを印 刷 します。

On Error Resume Next

Err.Clear()
GraphicsBuilder.SelectFirstAssociation()
While (Err.Number = 0)
Console.Out.WriteLine(GraphicsBuilder.PageAssociationName)
GraphicsBuilder.SelectNextAssociation()
End While

関連項目
PageAddAssociation、PageAssociationDescription

PageTitle

440
 Chapter: 6 グラフィックス ビルダー オートメーション インターフェース

アクティブな CitectSCADA グラフィックス ページのタイト ルを設 定 または取 得 します。

シンタックス
PageTitle(Title)
Title:

アクティブなページのタイト ル (文 字 列 )。

戻 り値
アクティブなグラフィックス ページのタイト ル (文 字 列 )、または、アクティブなグラフィックス ページに
タイト ルを設 定 する場 合 は、設 定 が正 常 に完 了 すれば 0 (ゼロ)。いずれの場 合 も、正 常 に完
了 しないとエラーが返 されます。

注 : 戻 り値 とエラー値 の処 理 の詳 細 については、エラー処 理 を参 照 してください。

関連項目
PageName, PageDescription, PagePrevious, PageNext, PageArea, PageScanTime,
PageLogDevice
関連項目
CitectSCADAユーザー ガイド の「ページ プロパティ - 一 般 」

' Sets the title of the active graphics page

GraphicsBuilder.PageTitle = "MyTitle"

' Retrieves the title of the active graphics page

MyVariable = GraphicsBuilder.PageTitle

注 : この関 数 は、C++環 境 では2つの独 立 した関 数 として実 行 されます。put_PageTitle に

よってアクティブなグラフィックス ページのタイト ルが設 定 され、get_PageTitle によってアクティ
ブなグラフィックス ページのタイト ルが取 得 されます。

プロジェクト 関 数
これらの関 数 は、プロジェクト レベルで機 能 します。一 部 の関 数 は、Citect プロジェクト エディタ
やプロジェクト エクスプローラの内 部 から起 動 されます。Visual Basic にエラーがあると、これらの
関 数 は戻 り値 E_FAIL の例 外 処 理 を実 行 します。

441
Chapter: 6 グラフィックス ビルダー オートメーション インターフェース

ProjectCompile この関 数 により、現 在 のプロジェクト を使 用 して CitectSCADAコンパイラが起 動

します。

ProjectFirst CitectSCADAで定 義 されている最 初 のプロジェクト の名 前 を取 得 します。

ProjectFirstInclud- 現 在 のCitectSCADAプロジェクト に定 義 されている最 初 のインクルード プロジェク

e ト の名 前 を取 得 します。

ProjectNext CitectSCADA で定 義 されている次 のプロジェクト の名 前 を取 得 します。

ProjectNextInclud- 現 在 のCitectSCADAプロジェクト に定 義 されている次 のインクルード プロジェクト

e の名 前 を取 得 します。

ProjectPackDataba- 現 在 のプロジェクト のデータベース ファイルをパックします。

se

ProjectPackLibrari- 現 在 のCitectSCADAプロジェクト のライブラリ ファイルをパックします。

es

ProjectSelect Citectエクスプローラ内 で、渡 されたプロジェクト を現 在 のプロジェクト として選 択 し

ます。

ProjectSelected CitectSCADAで現 在 選 択 しているプロジェクト の名 前 を取 得 します。

ProjectUpdatePage- 現 在 のCitectSCADAプロジェクト のすべてのページを更 新 します。

s

ProjectUpgrade 現 在 のCitectSCADAプロジェクト に対 し、プロジェクト のアップグレードを実 行 しま

す。

ProjectUpgradeAll すべてのCitectSCADAプロジェクト に対 し、プロジェクト のアップグレードを実 行 し

ます。

戻 り値 とエラー値 の処 理 の詳 細 、およびVisual Basicのサンプルについては、エラー処 理 を参

照 してください。

ProjectCompile
この関 数 により、現 在 のプロジェクト を使 用 して CitectSCADAコンパイラが起 動 します。現 時
点 では、エラーをチェックする関 数 や、コンパイラのキャンセル機 能 をト リガーする関 数 はないこと
に注 意 してください。

シンタックス
ProjectCompile

442
 Chapter: 6 グラフィックス ビルダー オートメーション インターフェース

戻 り値
関 数 が正 常 に実 行 された場 合 は0 (ゼロ) が、それ以 外 の場 合 はエラーが返 されます。

注 :戻 り値 とエラー値 の処 理 の詳 細 については、エラー処 理 を参 照 してください。

関連項目
ProjectSelect, ProjectSelected, ProjectFirst, ProjectNext, ProjectFirstInclude,
ProjectNextInclude, ProjectUpgrade, ProjectUpgradeAll, ProjectPackLibraries,
ProjectUpdatePages, ProjectPackDatabase

GraphicsBuilder.ProjectCompile
If Err.Number <> 0 Then
Debug.Print "Error in ProjectCompile"
Err.Clear
Else
Debug.Print "ProjectCompile OK"
End If

ProjectFirst
CitectSCADAで定 義 されている最 初 のプロジェクト の名 前 を取 得 します。ProjectNext とともに
使 用 して、現 在 CitectSCADA に定 義 されているプロジェクト を順 番 にすべて呼 び出 すこともで
きます。

シンタックス
ProjectFirst(Project)
Project:

プロジェクト の名 前 。

戻 り値
最 初 のCitectSCADA プロジェクト の名 前 。プロジェクト が存 在 しない場 合 は、エラーが返 されま
す。

注 :戻 り値 とエラー値 の処 理 の詳 細 については、エラー処 理 を参 照 してください。

443
Chapter: 6 グラフィックス ビルダー オートメーション インターフェース

関連項目
ProjectSelect, ProjectSelected, ProjectNext, ProjectFirstInclude, ProjectNextInclude,
ProjectUpgrade, ProjectUpgradeAll, ProjectPackLibraries, ProjectUpdatePages,
ProjectPackDatabase, ProjectCompile

On Error Resume Next

sProject = GraphicsBuilder.ProjectSelected
If Err.Number <> 0 Then
Debug.Print "Error in ProjectSelected"
Err.Clear
Else
Debug.Print "Selected project:", sProject
End If
Debug.Print "list of projects:"
sProject = GraphicsBuilder.ProjectFirst
While Err.Number = 0
Debug.Print sProject
sProject = GraphicsBuilder.ProjectNext
Wend

ProjectFirstInclude
現 在 のCitectSCADAプロジェクト に定 義 されている最 初 のインクルード プロジェクト の名 前 を取
得 します。ProjectNextInclude とともに使 用 して、現 在 の CitectSCADA プロジェクト に定 義 さ
れているインクルード プロジェクト をすべて呼 び出 すこともできます。

シンタックス
ProjectFirstInclude(Project)
Project:

プロジェクト の名 前 。

戻 り値
現 在 の CitectSCADA プロジェクト にある最 初 のインクルード プロジェクト の名 前 。プロジェクト
が存 在 しない場 合 は、エラーが返 されます。

注 :戻 り値 とエラー値 の処 理 の詳 細 については、エラー処 理 を参 照 してください。

444
 Chapter: 6 グラフィックス ビルダー オートメーション インターフェース

関連項目
ProjectSelect, ProjectSelected, ProjectFirst, ProjectNext, ProjectNextInclude,
ProjectUpgrade, ProjectUpgradeAll, ProjectPackLibraries, ProjectUpdatePages,
ProjectPackDatabase, ProjectCompile

ProjectNext
CitectSCADA で定 義 されている次 のプロジェクト の名 前 を取 得 します。ProjectFirst とともに使
用 して、現 在 CitectSCADA に定 義 されているプロジェクト をすべて呼 び出 すこともできます。

シンタックス
ProjectNext(Project)
Project:

プロジェクト の名 前 。

戻 り値
次 回 CitectSCADA プロジェクト の名 前 。プロジェクト が存 在 しない場 合 は、エラーが返 されま
す。

注 :戻 り値 とエラー値 の処 理 の詳 細 については、エラー処 理 を参 照 してください。

関連項目
ProjectSelect, ProjectSelected, ProjectFirst, ProjectFirstInclude, ProjectNextInclude,
ProjectUpgrade, ProjectUpgradeAll, ProjectPackLibraries, ProjectUpdatePages,
ProjectPackDatabase, ProjectCompile

On Error Resume Next

sProject = GraphicsBuilder.ProjectSelected
If Err.Number <> 0 Then
Debug.Print "Error in ProjectSelected"
Err.Clear
Else
Debug.Print "Selected project:", sProject
End If
Debug.Print "list of projects:"
sProject = GraphicsBuilder.ProjectFirst
While Err.Number = 0
Debug.Print sProject
sProject = GraphicsBuilder.ProjectNext

445
Chapter: 6 グラフィックス ビルダー オートメーション インターフェース

Wend

ProjectNextInclude
現 在 のCitectSCADAプロジェクト に定 義 されている次 のインクルード プロジェクト の名 前 を取 得
します。ProjectFirstInclude とともに使 用 して、現 在 の CitectSCADA プロジェクト に定 義 され
ているインクルード プロジェクト をすべて呼 び出 すこともできます。

シンタックス
ProjectNextInclude(Project)
Project:

プロジェクト の名 前 。

戻 り値
現 在 の CitectSCADA プロジェクト にあるj次 のインクルード プロジェクト の名 前 。プロジェクト が
存 在 しない場 合 は、エラーが返 されます。

注 :戻 り値 とエラー値 の処 理 の詳 細 については、エラー処 理 を参 照 してください。

関連項目
ProjectSelect, ProjectSelected, ProjectFirst, ProjectNext, ProjectFirstInclude, ProjectUpgrade,
ProjectUpgradeAll, ProjectPackLibraries, ProjectUpdatePages, ProjectPackDatabase,
ProjectCompile

ProjectPackDatabase
現 在 のプロジェクト のデータベース ファイルをパックします。

シンタックス
ProjectPackDatabase

戻 り値
関 数 が正 常 に実 行 された場 合 は0 (ゼロ) が、それ以 外 の場 合 はエラーが返 されます。

注 :この関 数 では、キャンセル ダイアログ ボックスが表 示 されます。[キャンセル] ボタンを押 す

と、関 数 は終 了 し、エラー コード E_ABORT をレポート します。戻 り値 とエラー値 の処 理 の

446
 Chapter: 6 グラフィックス ビルダー オートメーション インターフェース

詳 細 については、「エラー処 理 」を参 照 してください。

関連項目
ProjectSelect, ProjectSelected, ProjectFirst, ProjectNext, ProjectFirstInclude,
ProjectNextInclude, ProjectUpgrade, ProjectUpgradeAll, ProjectPackLibraries,
ProjectUpdatePages, ProjectCompile

GraphicsBuilder.ProjectPackDatabase
If Err.Number <> 0 Then
Debug.Print "Error in ProjectPackDatabase"
Err.Clear
Else
Debug.Print "ProjectPackDatabase OK"
End If

ProjectPackLibraries
現 在 のCitectSCADAプロジェクト のライブラリ ファイルをパックします。

シンタックス
ProjectPackLibraries

戻 り値
関 数 が正 常 に実 行 された場 合 は0 (ゼロ) が、それ以 外 の場 合 はエラーが返 されます。

注 :この関 数 では、キャンセル ダイアログ ボックスが表 示 されます。[キャンセル] ボタンを押 す

と、関 数 は終 了 し、エラー コード E_ABORT をレポート します。戻 り値 とエラー値 の処 理 の
詳 細 については、「エラー処 理 」を参 照 してください。

関連項目
ProjectSelect, ProjectSelected, ProjectFirst, ProjectNext, ProjectFirstInclude,
ProjectNextInclude, ProjectUpgrade, ProjectUpgradeAll, ProjectUpdatePages,
ProjectPackDatabase, ProjectCompile
ProjectSelect, ProjectSelected, ProjectFirst, ProjectNext, ProjectFirstInclude,
ProjectNextInclude, ProjectUpgrade, ProjectUpgradeAll, ProjectUpdatePages,
ProjectPackDatabase, ProjectCompile

447
Chapter: 6 グラフィックス ビルダー オートメーション インターフェース

GraphicsBuilder.ProjectPackLibraries
If Err.Number <> 0 Then
Debug.Print "Error in ProjectPackLibraries"
Err.Clear
Else
Debug.Print "ProjectPackLibraries OK"
End If

ProjectSelect
Citectエクスプローラ内 で、渡 されたプロジェクト を現 在 のプロジェクト として選 択 します。

シンタックス
ProjectSelect(Project)
Project:

プロジェクト の名 前 。

戻 り値
関 数 が正 常 に実 行 された場 合 は0 (ゼロ) が、それ以 外 の場 合 はエラーが返 されます。

注 :戻 り値 とエラー値 の処 理 の詳 細 については、エラー処 理 を参 照 してください。

関連項目
ProjectSelected, ProjectFirst, ProjectNext, ProjectFirstInclude, ProjectNextInclude,
ProjectUpgrade, ProjectUpgradeAll, ProjectPackLibraries, ProjectUpdatePages,
ProjectPackDatabase, ProjectCompile

GraphicsBuilder.ProjectSelect "Example"

ProjectSelected
CitectSCADAで現 在 選 択 しているプロジェクト の名 前 を取 得 します。

シンタックス
ProjectSelected(Project)

448
 Chapter: 6 グラフィックス ビルダー オートメーション インターフェース

Project:

プロジェクト の名 前 。

戻 り値
関 数 が正 常 に実 行 された場 合 は0 (ゼロ) が、それ以 外 の場 合 はエラーが返 されます。

注 :戻 り値 とエラー値 の処 理 の詳 細 については、エラー処 理 を参 照 してください。

関連項目
ProjectSelect, ProjectFirst, ProjectNext, ProjectFirstInclude, ProjectNextInclude,
ProjectUpgrade, ProjectUpgradeAll, ProjectPackLibraries, ProjectUpdatePages,
ProjectPackDatabase, ProjectCompile

On Error Resume Next

sProject = GraphicsBuilder.ProjectSelected
If Err.Number <> 0 Then
Debug.Print "Error in ProjectSelected"
Err.Clear
Else
Debug.Print "Selected project:", sProject
End If
Debug.Print "list of projects:"
sProject = GraphicsBuilder.ProjectFirst
While Err.Number = 0
Debug.Print sProject
sProject = GraphicsBuilder.ProjectNext
Wend

ProjectUpdatePages
現 在 のCitectSCADAプロジェクト のすべてのページを更 新 します。アップデート 中 に欠 落 してい
る参 照 が見 つかった場 合 は、BrokenLinkCancelEnabled を参 照 してください。

シンタックス
ProjectUpdatePages(FastUpdate)
FastUpdate:

高 速 アップデート を有 効 化 するには 真 ( TRUE) に設 定 してください。

449
Chapter: 6 グラフィックス ビルダー オートメーション インターフェース

戻 り値
関 数 が正 常 に実 行 された場 合 は0 (ゼロ) が、それ以 外 の場 合 はエラーが返 されます。

注 :この関 数 では、キャンセル ダイアログ ボックスが表 示 されます。[キャンセル] ボタンを押 す

と、関 数 は終 了 し、エラー コード E_ABORT をレポート します。戻 り値 とエラー値 の処 理 の
詳 細 については、「エラー処 理 」を参 照 してください。

関連項目
ProjectSelect, ProjectSelected, ProjectFirst, ProjectNext, ProjectFirstInclude,
ProjectNextInclude, ProjectUpgrade, ProjectUpgradeAll, ProjectPackLibraries,
ProjectPackDatabase, ProjectCompile

GraphicsBuilder.ProjectUpdatePages True
If Err.Number <> 0 Then
Debug.Print "Error in ProjectUpdatePages"
Err.Clear
Else
Debug.Print "ProjectUpdatePages OK"
End If

ProjectUpgrade
現 在 のCitectSCADAプロジェクト に対 し、プロジェクト のアップグレード を実 行 します。

シンタックス
ProjectUpgradeAll

戻 り値
関 数 が正 常 に実 行 された場 合 は0 (ゼロ) が、それ以 外 の場 合 はエラーが返 されます。

注 :この関 数 では、キャンセル ダイアログ ボックスが表 示 されます。[キャンセル] ボタンを押 す

と、関 数 は終 了 し、エラー コード E_ABORT をレポート します。戻 り値 とエラー値 の処 理 の
詳 細 については、「エラー処 理 」を参 照 してください。

450
 Chapter: 6 グラフィックス ビルダー オートメーション インターフェース

関連項目
ProjectSelect, ProjectSelected, ProjectFirst, ProjectNext, ProjectFirstInclude,
ProjectNextInclude, ProjectUpgradeAll, ProjectPackLibraries, ProjectUpdatePages,
ProjectPackDatabase, ProjectCompile

On Error Resume Next

Err.Clear
GraphicsBuilder.ProjectUpgrade
If Err.Number <> 0 Then
Debug.Print "Error in ProjectUpgrade"
Err.Clear
Else
Debug.Print "ProjectUpgrade OK"
End If

ProjectUpgradeAll
すべての CitectSCADA プロジェクト に対 し、プロジェクト のアップグレード を実 行 します。この関
数 は、Citect.INIファイルでUpgrade = 1に設 定 した場 合 と同 じ結 果 をもたらします。

シンタックス
ProjectUpgradeAll

戻 り値
関 数 が正 常 に実 行 された場 合 は0 (ゼロ) が、それ以 外 の場 合 はエラーが返 されます。

注 :戻 り値 とエラー値 の処 理 の詳 細 については、エラー処 理 を参 照 してください。

関連項目
ProjectSelect, ProjectSelected, ProjectFirst, ProjectNext, ProjectFirstInclude,
ProjectNextInclude, ProjectUpgrade, ProjectPackLibraries, ProjectUpdatePages,
ProjectPackDatabase, ProjectCompile

On Error Resume Next

Err.Clear
GraphicsBuilder.ProjectUpgrade

451
Chapter: 6 グラフィックス ビルダー オートメーション インターフェース

If Err.Number <> 0 Then

Debug.Print "Error in ProjectUpgrade"
Err.Clear
Else
Debug.Print "ProjectUpgrade OK"
End If

テキスト プロパティの関 数
これらの関 数 を使 用 して、プロジェクト のテキスト オブジェクト のプロパティを読 み込 み、および編
集 できます。

AttributeText テキスト オブジェクト のテキスト を設 定 するか、または現 在 のテキスト を取 得

します。

AttributeTextColour 選 択 したテキスト に色 を適 用 するか、または現 在 のフォント 色 の設 定 を取

得 します。

AttributeTextOffColour- 「オフ」の場 合 の色 を選 択 したテキスト に適 用 するか、または現 在 のフォント

Ex 色 の設 定 を取 得 します。

AttributeTextOnColour- 「オン」の場 合 の色 を選 択 したテキスト に適 用 するか、または現 在 のフォント

Ex 色 の設 定 を取 得 します。

AttributeTextFont 特 定 のフォント を選 択 したテキスト に適 用 するか、またはフォント 設 定 を取

得 します。

AttributeTextFontSize フォント サイズを選 択 したテキスト に適 用 するか、または現 在 のフォント サイ

ズを取 得 します。

AttributeTextJustificati- 特 定 の位 置 揃 えの設 定 を選 択 したテキスト に適 用 するか、または現 在 の

on テキスト の位 置 揃 えの値 を取 得 します。

AttributeTextStyle 特 定 のテキスト スタイルを設 定 するか、または現 在 のテキスト スタイルの設

定 を取 得 します。

テキスト オブジェクト には、次 のオブジェクト 関 数 も使 用 できます。

Attribute3dEffects オブジェクト に 3D 効 果 を適 用 するか、または現 在 の 3D 効 果 の設 定 を取

得 します。

Attribute3dEffectDep- 3D 効 果 に奥 行 きのレベルを適 用 するか、または現 在 の奥 行 きの設 定 を取

th 得 します。

452
 Chapter: 6 グラフィックス ビルダー オートメーション インターフェース

AttributeHiLightColou- 3D 効 果 の [浮 き出 し]、[凹 み]、または [浮 き彫 り] に適 用 するハイライト 色

r を設 定 するか、または現 在 のハイライト 色 の設 定 を取 得 します。

AttributeLoLightColou- 3D 効 果 の [浮 き出 し]、[凹 み]、または [浮 き彫 り] に適 用 するローライト 色

r を設 定 するか、または現 在 のローライト 色 の設 定 を取 得 します。

AttributeShadowColo- 影 付 きの 3D 効 果 を使 用 する場 合 に、影 の色 を設 定 します。または現 在 の

ur 影 の色 の設 定 を取 得 します。

戻 り値 とエラー値 の処 理 の詳 細 、および Visual Basic のサンプルについては、エラー処 理 を参

照 してください。

AttributeText
テキスト オブジェクト のテキスト を設 定 するか、または現 在 のテキスト を取 得 します。

シンタックス
AttributeText(Text)
Text:

テキスト オブジェクト のテキスト (文 字 列 )。

戻 り値
オブジェクト の現 在 のテキスト を取 得 する場 合 は、テキスト が文 字 列 として返 されます。テキスト
を設 定 する場 合 は、設 定 が正 常 に完 了 した場 合 は 0 (ゼロ) を返 します。いずれの場 合 も、
正 常 に完 了 しないとエラーが返 されます。属 性 への書 き込 み時 に値 が範 囲 外 の場 合 は、関
数 は終 了 し、エラー E_INVALIDARG が発 生 します。アクティブなテキスト オブジェクト がない
場 合 、関 数 は例 外 処 理 をし、E_HANDLE を返 します。

注 ：戻 り値 とエラー値 の処 理 の詳 細 については、エラー処 理 を参 照 してください。

関連項目
AttributeTextStyle, AttributeTextJustification, AttributeTextFont, AttributeTextFontSize,
AttributeTextColour

' Sets the text for the currently text object

GraphicsBuilder.AttributeText = "TestText"

' Retrieves text for the current text object

453
Chapter: 6 グラフィックス ビルダー オートメーション インターフェース

MyVariable = GraphicsBuilder.AttributeText

この関 数 は、C++ 環 境 では 2 つの独 立 した関 数 として実 行 されます。put_AttributeTextによ

って現 在 選 択 されているテキスト オブジェクト のテキスト が設 定 され、get_AttributeTextによって
現 在 のテキスト オブジェクト のテキスト が取 得 されます。

AttributeTextColour
選 択 したテキスト に色 を適 用 するか、または現 在 のフォント 色 の設 定 を取 得 します。

注 : この関 数 では True Colour 機 能 がサポート されていないた

め、AttributeTextOnColourEx関 数 および AttributeTextOffColourEx関 数 に置 き換 えら
れました。

シンタックス
AttributeTextColour(TextColour)
TextColour:

フォント 色 を示 す 0 ～ 255 の値 。

戻 り値
現 在 のフォント 色 を取 得 する場 合 は、0 ～ 255 の値 。特 定 のフォント 色 を適 用 する場 合 は、
正 常 に適 用 が完 了 すれば 0 (ゼロ)。いずれの場 合 も、正 常 に完 了 しないとエラーが返 されま
す。属 性 への書 き込 み時 に値 が範 囲 外 の場 合 は、関 数 は終 了 し、エラー E_INVALIDARG
が発 生 します。アクティブなテキスト オブジェクト がない場 合 、関 数 は例 外 処 理 をし、E_
HANDLE を返 します。

注 :戻 り値 とエラー値 の処 理 の詳 細 については、エラー処 理 を参 照 してください。

関連項目
AttributeText, AttributeTextStyle, AttributeTextJustification, AttributeTextFont,
AttributeTextFontSize

' Applies a color to the selected text

GraphicsBuilder.AttributeTextColour = 255

`Retrieves the current font color setting

MyVariable = GraphicsBuilder.AttributeTextColour

454
 Chapter: 6 グラフィックス ビルダー オートメーション インターフェース

この関 数 は、C++ 環 境 では 2 つの独 立 した関 数 として実 行 されます。put_

AttributeTextColourは、現 在 選 択 しているテキスト に色 を適 用 し、get_AttributeTextColour
は、現 在 のテキスト の色 を取 得 します。

AttributeTextOffColourEx
「オフ」の場 合 の色 を選 択 したテキスト に適 用 するか、または現 在 のフォント 色 の設 定 を取 得 し
ます。

シンタックス
AttributeTextOffColourEx(TextColour)
TextColour:

RGB 値 。

戻 り値
現 在 のフォント 色 を取 得 する場 合 は、RGB 値 。特 定 のフォント 色 を適 用 する場 合 は、正 常 に
適 用 が終 了 した場 合 は 0 (ゼロ) を返 します。いずれの場 合 も、正 常 に完 了 しないとエラーが
返 されます。属 性 への書 き込 み時 に値 が範 囲 外 の場 合 は、関 数 は終 了 し、エラー E_
INVALIDARG が発 生 します。アクティブなテキスト オブジェクト がない場 合 、関 数 は例 外 処
理 をし、E_HANDLE を返 します。

注 ：戻 り値 とエラー値 の処 理 の詳 細 については、エラー処 理 を参 照 してください。

関連項目
AttributeText, AttributeTextStyle, AttributeTextJustification, AttributeTextFont,
AttributeTextFontSize

' Applies a color to the selected text

GraphicsBuilder.AttributeTextOffColourEx = &hFF0000

`Retrieves the current font color setting

MyVariable = GraphicsBuilder.AttributeTextOffColourEx

この関 数 は、C++ 環 境 では 2 つの独 立 した関 数 として実 行 されます。put_

AttributeTextOffColourExは、現 在 選 択 しているテキスト に色 を適 用 し、get_
AttributeTextOffColourExは、現 在 のテキスト の色 を取 得 します。

455
Chapter: 6 グラフィックス ビルダー オートメーション インターフェース

AttributeTextOnColourEx
「オン」の場 合 の色 を選 択 したテキスト に適 用 するか、または現 在 のフォント 色 の設 定 を取 得 し
ます。

シンタックス
AttributeTextOnColourEx(TextColour)
TextColour:

RGB 値 。

戻 り値
現 在 のフォント 色 を取 得 する場 合 は、RGB 値 。特 定 のフォント 色 を適 用 する場 合 は、正 常 に
適 用 が終 了 した場 合 は 0 (ゼロ) を返 します。いずれの場 合 も、正 常 に完 了 しないとエラーが
返 されます。属 性 への書 き込 み時 に値 が範 囲 外 の場 合 は、関 数 は終 了 し、エラー E_
INVALIDARG が発 生 します。アクティブなテキスト オブジェクト がない場 合 、関 数 は例 外 処
理 をし、E_HANDLE を返 します。

注 ：戻 り値 とエラー値 の処 理 の詳 細 については、エラー処 理 を参 照 してください。

関連項目
AttributeText, AttributeTextStyle, AttributeTextJustification, AttributeTextFont,
AttributeTextFontSize

' Applies a color to the selected text

GraphicsBuilder.AttributeTextOnColourEx = &hFF0000

`Retrieves the current font color setting

MyVariable = GraphicsBuilder.AttributeTextOnColourEx

この関 数 は、C++ 環 境 では 2 つの独 立 した関 数 として実 行 されます。put_

AttributeTextOnColourExは、現 在 選 択 しているテキスト に色 を適 用 し、get_
AttributeTextOnColourExは、現 在 のテキスト の色 を取 得 します。

AttributeTextFont
特 定 のフォント を選 択 したテキスト に適 用 するか、またはフォント 設 定 を取 得 します。

456
 Chapter: 6 グラフィックス ビルダー オートメーション インターフェース

シンタックス
AttributeTextFont(TextFont)
TextFont:

文 字 列 でのフォント 名 。

戻 り値
現 在 のフォント を取 得 する場 合 は、フォント 名 が文 字 列 として返 されます (例 え
ば、「courier」)。特 定 のフォント を適 用 する場 合 は、正 常 に適 用 が終 了 した場 合 は 0 (ゼロ)
を返 します。いずれの場 合 も、正 常 に完 了 しないとエラーが返 されます。属 性 への書 き込 み時
に値 が範 囲 外 の場 合 は、関 数 は終 了 し、エラー E_INVALIDARG が発 生 します。アクティブ
なテキスト オブジェクト がない場 合 、関 数 は例 外 処 理 をし、E_HANDLE を返 します。

注 :戻 り値 とエラー値 の処 理 の詳 細 については、エラー処 理 を参 照 してください。

関連項目
AttributeText, AttributeTextStyle, AttributeTextJustification, AttributeTextFontSize,
AttributeTextColour

' Applies the font Courier to the selected text

GraphicsBuilder.AttributeTextFont = "Courier"

' Retrieves the font setting

MyVariable = GraphicsBuilder.AttributeTextFont

注 :この関 数 は、C++ 環 境 では 2 つの独 立 した関 数 として実 行 されます。put_

AttributeTextFontは、現 在 選 択 しているテキスト にフォント を適 用 し、get_
AttributeTextFontは、現 在 のフォント の設 定 を取 得 します。

AttributeTextFontSize
フォント サイズを選 択 したテキスト に適 用 するか、または現 在 のフォント サイズを取 得 します。

シンタックス
AttributeTextFontSize(TextFontSize)
TextFontSize:

457
Chapter: 6 グラフィックス ビルダー オートメーション インターフェース

フォント サイズを示 す 0 ～ 65535 の値 。

戻 り値
現 在 のフォント サイズを取 得 する場 合 は、0 ～ 65535 の値 。特 定 のフォント サイズを適 用 す
る場 合 は、正 常 に適 用 が完 了 すれば 0 (ゼロ)。いずれの場 合 も、正 常 に完 了 しないとエラー
が返 されます。属 性 への書 き込 み時 に値 が範 囲 外 の場 合 は、関 数 は終 了 し、エラー E_
INVALIDARG が発 生 します。アクティブなテキスト オブジェクト がない場 合 、関 数 は例 外 処
理 をし、E_HANDLE を返 します。

注 :戻 り値 とエラー値 の処 理 の詳 細 については、エラー処 理 を参 照 してください。

関連項目
AttributeText, AttributeTextStyle, AttributeTextJustification, AttributeTextFont,
AttributeTextColour

' Applies the font size to the selected text

GraphicsBuilder.AttributeTextFontSize = 12

' Retrieves the font size

MyVariable = GraphicsBuilder.AttributeTextFontSize

注 :この関 数 は、C++ 環 境 では 2 つの独 立 した関 数 として実 行 されます。put_

AttributeTextFontSizeは、フォント サイズを設 定 し、get_AttributeTextFontSizeは、現 在 の
フォント サイズを取 得 します。

AttributeTextJustification
特 定 の位 置 揃 えの設 定 を選 択 したテキスト に適 用 するか、または現 在 のテキスト の位 置 揃 え
の値 を取 得 します。

シンタックス
AttributeTextJustification(TextJustification)
TextJustification:

使 用 する位 置 揃 えのタイプを示 す値 。
l 0 = 左詰め
l 1 = 右詰め

458
 Chapter: 6 グラフィックス ビルダー オートメーション インターフェース

l 2 = 中央

戻 り値
現 在 のテキスト の位 置 揃 えを取 得 する場 合 は、使 用 されている位 置 揃 えのタイプを示 す 0
～ 2 の値 。位 置 揃 えを適 用 する場 合 は、正 常 に適 用 が終 了 した場 合 は 0 (ゼロ) を返 しま
す。いずれの場 合 も、正 常 に完 了 しないとエラーが返 されます。属 性 への書 き込 み時 に値 が
範 囲 外 の場 合 は、関 数 は終 了 し、エラー E_INVALIDARG が発 生 します。アクティブなテキ
スト オブジェクト がない場 合 、関 数 は例 外 処 理 をし、E_HANDLE を返 します。

注 :戻 り値 とエラー値 の処 理 の詳 細 については、エラー処 理 を参 照 してください。

関連項目
AttributeText, AttributeTextStyle, AttributeTextFont, AttributeTextFontSize,
AttributeTextColour

' Applies right justification to the selected text

GraphicsBuilder.AttributeTextJustification = 1

' Retrieves the current text justification value

MyVariable = GraphicsBuilder.AttributeTextJustification

注 :この関 数 は、C++ 環 境 では 2 つの独 立 した関 数 として実 行 されます。put_

AttributeTextJustificationは、現 在 選 択 しているテキスト に位 置 揃 えを適 用 し、get_
AttributeTextJustificationは、現 在 の位 置 揃 えの設 定 を取 得 します。

AttributeTextStyle
特 定 のテキスト スタイルを設 定 するか、または現 在 のテキスト スタイルの設 定 を取 得 します。

シンタックス
AttributeTextStyle(TextStyle)
TextStyle:

テキスト のスタイルを示 す値 。
l 0 = 標準
l 1 = 太字
l 2 = 斜体

459
Chapter: 6 グラフィックス ビルダー オートメーション インターフェース

l 4 = 下線
l 8 = 取 り消 し線

上 記 の値 を加 算 することで、複 数 のスタイルを同 時 に使 用 することができます。

戻 り値
現 在 のテキスト のスタイルを取 得 する場 合 は、適 用 されているスタイルを示 す 0 ～ 8 の値 。テ
キスト のスタイルを適 用 する場 合 は、正 常 に適 用 が完 了 した場 合 は 0 (ゼロ) を返 します。い
ずれの場 合 も、正 常 に完 了 しないとエラーが返 されます。属 性 への書 き込 み時 に値 が範 囲 外
の場 合 は、関 数 は終 了 し、エラー E_INVALIDARG が発 生 します。アクティブなテキスト オブ
ジェクト がない場 合 、関 数 は例 外 処 理 をし、E_HANDLE を返 します。

注 :戻 り値 とエラー値 の処 理 の詳 細 については、エラー処 理 を参 照 してください。

関連項目
AttributeText, AttributeTextJustification, AttributeTextFont, AttributeTextFontSize,
AttributeTextColour

' Sets the normal text style

GraphicsBuilder.AttributeTextStyle = 0

' Retrieves the current text style setting

MyVariable = GraphicsBuilder.AttributeTextStyle

注 :この関 数 は、C++ 環 境 では 2 つの独 立 した関 数 として実 行 されます。put_

AttributeTextStyleは、現 在 選 択 しているテキスト にスタイルを適 用 し、get_
AttributeTextStyleは、現 在 のテキスト スタイルの設 定 を取 得 します。

460
Chapter: 7 よくある質問 (FAQ)
このセクションには、CitectSCADA機 能 にに関 するよくある質 問 の回 答 を用 意 しています。こ
のFAQは、いくつかのカテゴリに分 かれています。
l ページ
l グラフィックス
l ランタイム
l ト レンド
l コント ロール
l アラーム
l その他

ページ
Q:起 動 時 にはどのようにページを開 くのですか?
A:CitectSCADAは、起 動 すると「スタート アップ」と呼 ばれるページを検 索 します。CitectSCADA
がこのページを見 つけると、自 動 的 に開 きます。デフォルト の起 動 ページ名 は、カスタム モード
で実 行 する コンピュータ セット アップ ウィザード で変 更 できます。詳 細 は「全 般 オプション設
定 」CitectSCADA ユーザガイド のを参 照 してください。
Q:[次 のページ] および [前 のページ] ボタンを新 しいグラフィックス ページで動 作 できるようにする
にはどうしたらいいですか?
A:プロパティ (グラフィックス ビルダー内 の [ファイル] メニュー) を使 って次 および前 のページを定 義
します。
Q:「!」で始 まるページはどのように表 示 したらいいですか?
A:グラフィックス ビルダーの [ツール] メニューの [オプション] で、[システム ページの一 覧 表 示 ]にチ
ェックをつけます。
Q:最 初 の文 字 が「!」であるページ名 にはどのような意 味 があるのですか?
A:「!」とは、システム ページであることを示 します。「!」で始 まるページは、デフォルト のメニュー
ページまたは [ページ選 択 ] コンボ ボックスには表 示 されません。
Q:8 個 以 上 の変 数 タグをスーパージニーに関 連 付 けることはできますか?AssPopup()関 数 を使 っ
ていますが、8個 の変 数 タグしか使 えません。

461
Chapter: 7 よくある質問 (FAQ)

A:AssVarTags 関 数 を使 って最 大 256 個 の変 数 タグを関 連 付 けることができます。また、配

列 を使 用 することも可 能 です。
Q:ジニーを作 成 し、それに権 限 を追 加 したいと思 います。バージョン 3 および 4 では、CTRL
キーを押 しながらダブルクリックしましたが、このバージョンではうまくいきません。
A:これは、バージョン 5 でのプロパティベース オブジェクト が追 加 されたためです。権 限 フィールド
を追 加 するには、ジニーの権 限 フィールド に%privilege% を追 加 してジニー フォームにフィールド
を追 加 します。

グラフィックス
Q:バージョン4のグラフィック オブジェクト では、文 字 列 のオン/オフマルチステート を色 分 けして表
示 することができました。新 しいオブジェクト ではどのようにしたらいいですか?
A:テキスト オブジェクト の [塗 り込 み] タブのオン/オフタイプを使 って、同 じ効 果 を作 成 できます。
デジタル タグを追 加 し、希 望 する色 を指 定 します。
Q:バー グラフやシンボル上 になぜ点 線 が表 示 されるのですか?
A:点 線 は、このオブジェクト 表 示 で通 信 エラーが発 生 していることを示 します。データに関 連 付
けられているI/Oデバイスがオフラインの場 合 、データ上 に点 線 が表 示 されます。

ランタイム
Q:スタート アップ時 にCicode関 数 を実 行 するにはどうしたらいいですか ?
A:コンピュータ セット アップ ウィザード をカスタムモード で実 行 し、Cicode関 数 を指 定 します。[ス
タート アップ関 数 のセット アップ] ページを使 用 します。詳 細 については、『CitectSCADA ユーザ
ガイド 』「スタート アップ機 能 の設 定 」を参 照 してください。
Q:スタート アップ時 にレポート を実 行 するにはどうしたらいいですか ?
A:CitectSCADAは、起 動 すると「スタート アップ」と呼 ばれるレポート を検 索 しま
す。CitectSCADAが、このレポート を見 つけると、それが自 動 的 に起 動 されます。コンピュータ
セット アップ ウィザード をカスタムモード で実 行 し、デフォルト のスタート アップ レポート の名 前 を変
更 できます。[レポート のセット アップ] ページのレポート の [スタート アップ] フィールド を使 用 しま
す。詳 細 については、CitectSCADA ユーザーガイド 「CitectSCADAレポート の設 定 」の「」を参
照 してください。
Q:オペレータによる再 起 動 を無 効 にするにはどうしたらいいですか ?
A:サード パーティのユーティリティを使 用 してCtrl+Alt+Delコマンド を無 効 にできます。Citect 知
識 ベース を参 照 するか、または本 製 品 の技 術 サポート に問 い合 わせて、最 新 の推 奨 ソフト ウ
ェアを入 手 してください。
Q:[スタート アップ] メッセージボックスの [キャンセル] ボタンを削 除 するにはどうしたらいいですか ?

462
 Chapter: 7 よくある質問 (FAQ)

A:コンピュータ セット アップ ウィザード をカスタムモード で実 行 し、使 用 します。[セキュリティ設 定 (

その他 ) ] ページの [スタート アップ] オプションの [起 動 時 に[キャンセル]ボタンを表 示 ] ボタンを解
除 します。詳 細 については、『CitectSCADAユーザ ガイド 』「」「その他 のセキュリティの設 定 」を
参 照 してください。
Q:[コント ロール] メニューから [シャット ダウン] コマンド を削 除 するにはどうしたらいいですか ?
A:コンピュータ セット アップ ウィザード をカスタムモード で実 行 し、使 用 します。[コント ロール メニ
ュー] ページにある [セキュリティ設 定 ] の オプションで、[メニューでシャット ダウンの表 示 ] の選 択
を解 除 します。詳 細 については、『CitectSCADAユーザ ガイド 』「」の「コント ロール メニューのセ
キュリティの設 定 」を参 照 してください。
Q:[コント ロール メニュー] から [プロジェクト エディタ] および [グラフィックス ビルダー] を削 除 する
にはどうしたらいいですか ?
A:コンピュータ セット アップ ウィザード をカスタムモード で実 行 し、使 用 します。[コント ロール メニ
ュー] ページにある [セキュリティ設 定 ] のメニュー オプションで、[メニューでプロジェクト エディタおよ
びグラフィックスビルダーの表 示 ] の選 択 を解 除 します。詳 細 については、『CitectSCADAユーザ
ガイド 』「」の「コント ロール メニューのセキュリティの設 定 」を参 照 してください。

ト レンド
Q:dBase データベースにト レンド データを保 存 するにはどうしたらいいですか?
A:画 面 にト レンド を表 示 し、[ファイルに名 前 をつけて保 存 ] ツールを選 択 します。[名 前 をつけ
て保 存 ] ダイアログボックスが表 示 されるので、ファイル名 を入 力 し、TrnExportDBF 関 数 を呼
び出 してデータを保 存 します (より複 雑 な手 順 では、この関 数 を直 接 呼 び出 します)。
Q:ト レンド データを Excel に取 り込 むにはどうしたらいいですか?
A:次 の 3 種 類 の方 法 でデータを Excel に取 り込 むことができます。
l 画 面 にト レンド を表 示 し、[クリップボード ] ツールを選 択 してデータをコピーします。Excel の
貼 り付 けコマンド を使 用 して、データを Excel に貼 り付 けます。
l 画 面 にト レンド を表 示 し、[ファイルに名 前 をつけて保 存 ] ツールを選 択 します。データを
CSV 形 式 で保 存 し、Excel で CSV ファイルを開 きます。
l 画 面 にト レンド を表 示 し、[ファイルに名 前 をつけて保 存 ] ツールを選 択 します。データを
DBF 形 式 で保 存 し、Excel で DBF ファイルを開 きます。
(その他 の手 順 については、TrnExportCSV または TrnExportDBF 関 数 を呼 び出 します)。
Q:ト レンド データを MS Access に取 り込 むにはどうしたらいいですか?
A:次 の 3 種 類 の方 法 でデータを Access に取 り込 むことができます。
l 画 面 にト レンド を表 示 し、[クリップボード ] ツールを選 択 してデータをコピーします。Access
の貼 り付 けコマンド を使 用 して、データを Access に貼 り付 けます。

463
Chapter: 7 よくある質問 (FAQ)

l 画 面 にト レンド を表 示 し、[ファイルに名 前 をつけて保 存 ] ツールを選 択 します。データを

CSV 形 式 で保 存 し、Access で CSV ファイルを開 きます。
l 画 面 にト レンド を表 示 し、[ファイルに名 前 をつけて保 存 ] ツールを選 択 します。データを
DBF 形 式 で保 存 し、Access で DBF ファイルを開 きます。
(その他 の手 順 については、TrnExportCSV または TrnExportDBF 関 数 を呼 び出 します)。
Q:ト レンド データを更 新 するにはどうしたらいいですか?
A:TrnSetTable 関 数 を使 って、ト レンド システムにデータを書 き込 みます。
Q:ト レンド データをアーカイブするにはどうしたらいいですか?
A:Examples データベースで、ト レンド アーカイブの Cicode 関 数 を使 用 します。[関 数 検 索 ] コ
マンド を使 ってTrendArchive() 関 数 を検 索 します。
Q:アーカイブされたト レンド データをシステムに復 元 するにはどうしたらいいですか?
A:「Examples」データベースで、ト レンド アーカイブの Cicode 関 数 を使 用 します。[関 数 検 索 ]
コマンド を使 ってTrendArchive() 関 数 を検 索 します。
Q:ト レンド データをレポート に取 り込 むにはどうしたらいいですか?
A:TrnGetTable 関 数 を使 用 します。

コント ロール
Q:キーボード からモーターを起 動 するにはどうしたらいいですか?
A:デジタル変 数 の値 を1に設 定 するように [ページ キーボード ] コマンド を定 義 します。次 に例 を
示 します。
l キー シーケンス：ENTERまたはF5
l コマンド : Conv_Motor = 1
Q:ボタンからモーターを起 動 するにはどうしたらいいですか?
A:デジタル変 数 の値 を1に設 定 するように [ボタン] コマンド を定 義 します (例 ：Conv_Motor =
1)。
Q:キーボード 入 力 からセット ポイント を調 整 するにはどうしたらいいですか?
A:セット ポイント を新 しい値 に設 定 するように [ページ キーボード ] コマンド を定 義 します。次 に
例 を示 します。
l キー シーケンス：#### ENTER
l コマンド :SP1 = Arg1
Q:フィールド 幅 よりも大 きいコマンド を入 力 するにはどうしたらいいですか?
A:インクルード ファイルを使 用 するか、Cicode関 数 を書 き、その関 数 を呼 び出 します。詳 細
は、「インクルード (テキスト ) ファイルの使 用 および関 数 の書 き込 み」を参 照 してください。

464
 Chapter: 7 よくある質問 (FAQ)

アラーム
Q:オペレーターがキーボード を使 ってシステムの任 意 のページからアラーム ページへ行 くにはどう
したらいいですか?
A:グローバルキーボード コマンド (例 えば、F3 キー) を定 義 して、PageAlarm 関 数 でページを
表 示 するか、あるいは、アラーム ページ ボタンを持 つページテンプレート を使 用 します。Global
キーボード コマンド は、システム キーボード コマンド で定 義 できます。
Q:アラームが切 れた場 合 に関 数 を呼 び出 すにはどうしたらいいですか?
A: アラームをアラーム カテゴリーとして定 義 し、[アラーム アクション] フィールド で関 数 を呼 び出
します。
Q:アラームをdBASEファイルに送 るにはどうしたらいいですか?
A: [アラーム カテゴリ] フォームの [ログ デバイス] フィールド で、dBASEファイルを定 義 します。
Q:アラームを表 示 するにはどうしたらいいですか?
A:PageAlarm 関 数 を使 って標 準 アラーム ページを表 示 します。または、コント ロールを向 上 す
るために独 自 のアラーム ページを作 成 し、AlarmDsp関 数 を使 用 することもできます。
Q:アラーム サマリーはどのように表 示 するのですか?
A: PageSummary function 関 数 を使 用 して、標 準 アラーム サマリー ページを表 示 します。ま
たは、コント ロールを向 上 するために独 自 のアラーム サマリー ページを作 成 し、AlarmDsp 関
数 を使 用 することもできます。
Q:アラームをレポート に取 り込 むにはどうしたらいいですか?
A: 次 のいずれかを行 います。
l アラーム ログ (.DBF) ファイルを読 み込 みます (アラーム カテゴリーにログされています)。
l AlarmFirstCatRec などのアラーム関 数 を使 用 します。(これらの関 数 は、アラーム サーバー
とレポート サーバーが同 じコンピュータ上 にある場 合 のみ使 用 できます)。
Q:I/O デバイスからアラーム グループを無 効 にするにはどうしたらいいですか?
A: アラームを無 効 にしたいときに I/O デバイスがビット を設 定 するようにプログラムします。イベン
ト を使 ってこのビット を監 視 し (ト リガは Bit = 1)、AlarmDisable 関 数 をアクションとして呼 び出
します (ビット が設 定 されている場 合 )。
Q:アラームを表 示 するにはどうしたらいいですか?
A: プロジェクト を構 成 する場 合 、アラーム テンプレート を基 に (グラフィック ビルダーで) デフォルト
のアラーム ページを作 成 します。このページに「Alarm」という名 前 をつけて保 存 します。アラー
ムは、自 動 的 にこのページに表 示 されます。
Q:アラーム サマリーを表 示 するにはどうしたらいいですか?

465
Chapter: 7 よくある質問 (FAQ)

A: プロジェクト を構 成 する場 合 、アラーム テンプレート を基 に (グラフィック ビルダーで) デフォルト

のアラーム サマリー ページを作 成 します。このページに「Summary」という名 前 をつけて保 存 し
ます。すべてのアラームは、自 動 的 にこのページに表 示 されます。
Q:アラームはどのように確 認 するのですか?
A: 標 準 アラーム ページを表 示 し、アラーム上 でマウスを左 クリックするか、AlarmAckRec関 数
を使 用 します。
Q:アラームの冗 長 性 はどのように設 定 するのですか?
A:コンピュータ セット アップ ウィザード (カスタム モード で実 行 ) を使 用 して第 2 のアラーム サー
バーを設 定 します。プロジェクト を再 構 成 する必 要 はありません。
Q:ランタイム時 に、アラームにコメント を添 付 するにはどうしたらいいですか?
A:AlarmComment関 数 を呼 び出 す [ページ キーボード ] コマンド を定 義 します。
Q:アラームが発 生 したときにベルを鳴 らすようにするにはどうしたらいいですか?
A:アラーム カテゴリーのアラームを定 義 し、[アラーム アクション] フィールド のBeep関 数 を呼 び出
します。
Q:最 後 のアラームをすべてのページに表 示 するにはどうしたらいいですか?
A: 各 ページ (またはテンプレート ) の連 続 アニメーションを定 義 します。これは、アラーム テンプ
レート の標 準 機 能 です。
Q:アラームが有 効 であることをオペレーターに知 らせるにはどうしたらいいですか?
A: 標 準 テンプレート を使 用 している場 合 は、時 計 がアニメーションになります。または、コント
ロールを向 上 するために AlarmActive関 数 を呼 び出 します。
Q:ランタイム時 にアナログのアラーム リミット を変 更 するにはどうしたらいいですか?
A:AlarmSetThreshold 関 数 を呼 び出 す [ページ キーボード ] コマンド を定 義 します。

その他
Q:ページに #COM が表 示 されるのはなぜですか?
A:#COM は、アニメーションの通 信 エラーが発 生 したことを示 すものです。データに関 連 付 けら
れている I/O デバイスがオフラインの場 合 に #COM が表 示 されます。
Q:PLCで通 信 エラー (ハード ウェア アラーム、#COMS、シンボルがありません、ページにト レンド
データがありませんなど) が発 生 します。どうしたらいいですか?
A:CitectSCADA カーネルウィンド ウを使 用 してください。詳 細 は CitectSCADAユーザガイド の「
CitectSCADA カーネルの使 用 」を参 照 。)

466
 Chapter: 7 よくある質問 (FAQ)

1. プロジェクト が起 動 したら、クライアント プロセスでカーネル ウィンド ウを呼 び出 します。

2. カーネル メイン ウィンド ウで page table CSAtoPSI.Subs と入 力 し、クライアント タグ サブス
クリプションのリスト を表 示 します。
3. 画 面 で #COM が生 じているタグを検 索 し、品 質 コラムを見 て、関 与 しているエラーを確 認
します。
Q:CitectSCADAを起 動 すると、「Citect の物 理 メモリーが不 足 しています」というエラーが表 示 さ
れます。どうしたらいいですか?
A:起 動 時 、CitectSCADAはシステムを実 行 する際 に利 用 可 能 な十 分 な物 理 メモリー (仮 想
メモリーではなく、実 際 のメモリー) があるかどうかをチェックします。CitectSCADAが大 量 の仮 想
メモリーを使 用 し始 めると、お使 いのシステムのパフォーマンスが大 幅 に低 下 します。状 況 によっ
ては、CitectSCADA は利 用 可 能 な物 理 メモリーの容 量 を正 確 に検 出 することができず、メモ
リー不 足 である場 合 にこのエラー メッセージが表 示 されます。このエラー メッセージ「物 理 メモ
リーが低 い」を参 照 してください。
Q:VGA のメニューが XGA の解 像 度 になっているのはなぜですか?
A:デフォルト メニューは、XGA サイズのページですべてのページにボタンをつけるシンプルなメニ
ューです。より複 雑 なメニューを希 望 する場 合 は、メニュー テンプレート を使 用 して独 自 のペー
ジの構 成 を行 います。
Q:スペアのド ングルを持 っていますが、タイプ、点 数 カウント 、サポート するユーザー数 がわかりま
せん。
A:CitectSCADAを実 行 する場 合 は、カーネルを起 動 し、PAGE GENERAL と入 力 して画 面
の一 番 下 を表 示 します。上 記 のすべての項 目 についての情 報 があります。
Q:まったく同 じプロジェクト で、マシンによって実 行 きたりできなかったりするイベント を構 成 してし
ましました。どこがいけないのでしょうか?
A:CitectSCADAのコンピュータは、有 効 に設 定 されているイベント のみを実 行 します。コンピ
ュータ セット アップ ウィザード を使 用 して、各 コンピュータのイベント を有 効 または無 効 にします。

Q:アキュミュレータをリセット するにはどうしたらいいですか?タグに直 接 書 き込 もうとしましたが、そ

のままカウント を継 続 していました。
A:AccControl 関 数 を使 用 してください。
Q:プロジェクト からたくさんの変 数 タグを削 除 しましたが、レコード 数 が変 わりません。削 除 したの
にまだあるようです。
A: その通 りです。プロジェクト エディタで [ファイル] メニューからパックを選 択 して、データベースを
パック する必 要 があります。これによって、削 除 のマークがついたすべてのレコード が削 除 され、
残 りのレコード は再 度 インデックスされます。サード パーティのデータベース エディタ (MS-Excel な
ど)を使 って [変 数 ] データベース ファイルを削 除 または編 集 している場 合 は、定 期 的 にパックす
る必 要 があります。

467
Chapter: 7 よくある質問 (FAQ)

Q:ファイル サーバーを設 定 したいのですが、サーバーが停 止 した場 合 に可 能 な限 りクライアント

接 続 を堅 牢 にしておきたいと思 います。どのような方 法 がありますか?
A:コンピュータ セット アップ ウィザード (カスタムモード で実 行 ) を使 用 します。[全 般 オプションの設
定 ] ダイアログ内 の [バックアップの保 存 先 ] フィールド に、スタンバイの位 置 を入 力 します。詳 細
は「全 般 オプション設 定 」CitectSCADA ユーザガイド のを参 照 してください。
Q:I/O デバイスへの通 信 を迅 速 に設 定 するにはどうしたらいいですか?
A:エクスプレス通 信 ウィザード を使 って I/O サーバー、メーカー、I/O デバイス、さらに通 信 方 法 を
選 択 します。これにより、必 要 な基 本 オプションを迅 速 に設 定 できますが、詳 細 機 能 は設 定 さ
れません。詳 細 は CitectSCADAユーザガイド の「エクスプレス通 信 ウィザード の使 用 」を参 照 し
てください。

468
 用語集

用語集
(
(オブジェクト の) グループ
複 数 のオブジェクト をグループ化 できます。グループごとに一 意 のプロパティ セット があり、これで全 体 のグルー
プのランタイム動 作 が決 まります。

1
10base2
細 い同 軸 ケーブルを使 用 したイーサネット の接 続 方 法 。通 常 BNCコネクタを使 用 します。

10base5
太 い同 軸 ケーブルを使 用 したイーサネット の接 続 方 法 。

10baseT
非 シールド 型 のツイスト ペア ケーブルを使 用 したイーサネット の接 続 方 法 。通 常 RJ45コネクタを使 用 しま
す。

A
Accredited - Level 1
CiTDriversQA96 Driver Quality and Accreditation System に基 づいて開 発 されたド ライバ。このシステム
は、ド ライバができる限 り最 高 の基 準 に基 づいて設 計 、コード 化 、テスト されることを目 的 としたものです。

Accredited - Level 2
CiTDriversQA92 Driver Quality and Accreditation System を使 用 して開 発 されたド ライバ。

B
BCD変 数 (I/O デバイス)
BCD (2進 化 10進 数 ) は2バイト (16ビット ) データ タイプで、値 は0～ 9,999です。2バイト は4ビット の4つのロット
に分 割 され、4ビット の各 ロット は10進 数 を表 します。たとえば、2進 数 の0010は10進 数 の2を表 します。この
ように、BCD 0010 0010 0010 0010は2,222を表 します。

C
Cicode
工 場 監 視 ・制 御 アプリケーションのために設 計 されたプログラミング言 語 。Pascalなどと同 様 の言 語 です。

469
用語集

Cicodeブロック関 数
Cicode関 数 は、返 す前 に非 同 期 イベント をブロックまたは待 機 する関 数 です。

CiNet
CiNetは現 在 サポート されていません。CiNetは (リモート 監 視 アプリケーション用 に) 低 速 の広 域 通 信 網 とし
て設 計 されました。広 域 分 散 型 アプリケーション 広 域 分 散 型 アプリケーションを使 用 している場 合 、LAN
を使 用 した表 示 クライアント の接 続 は、費 用 がかかります。この場 合 、表 示 クライアント を接 続 するに
は、Microsoftのリモート アクセス サーバー (RAS) またはShiva LanRoverなど、Microsoft認 証 のソリューショ
ンを使 用 してください。

citect.ini ファイル
テキスト ファイルには 各 コンピュータ (サーバーおよび表 示 クライアント ) の 設 定 およびランタイム環 境 での動
作 方 法 に関 する情 報 が保 存 されています。Citect.INIファイルには、各 コンピュータに固 有 のパラメータが保
存 されているので、プロジェクト の一 部 として設 定 することはできません。

CiUSAFE
CiUSAFE は、同 意 制 限 内 でソフト ウェアの使 用 を許 可 するハード ウェアキーを管 理 するために使 用 されるア
プリケーションです。

D
DB-15
ケーシングがそれとなくDの形 をしているので、しばしば「D」タイプ コネクタと呼 ばれています。15ピンが、8ピン
および7ピンの2列 に配 列 されています。DB-9またはDB-25のように一 般 的 ではありませんが、一 部 のコンピ
ュータおよび通 信 装 置 に見 られます。オス タイプ ( ピン型 ) とメス タイプ (ソケット 型 ) の両 方 があります。

DB-25
ケーシングがそれとなくDの形 をしているので、しばしば「D」タイプ コネクタと呼 ばれています。25ピンが、13ピ
ンおよび12ピンの2列 に配 列 されています。この種 の接 続 は、RS-232-Dの標 準 タイプの１つであり、多 数 のコ
ンピュータ、モデム、その他 の通 信 機 器 で見 られます。オス タイプ ( ピン型 ) とメス タイプ (ソケット 型 ) の両 方
があります。

DB-9
ケーシングがそれとなくDの形 をしているので、しばしば「D」タイプ コネクタと呼 ばれています。9ピンが、5ピン
および4ピンの2列 に配 列 されています。この種 の接 続 は一 般 的 で、しばしばコンピュータのシリアル (com)
ポート として使 用 されています。モデム、その他 の通 信 機 器 で多 く使 われています。オス タイプ ( ピン型 ) とメ
ス タイプ (ソケット 型 ) の両 方 があります。

debug.log
debug.log ファイルは、予 期 しないシステムのシャット ダウンあるいは種 々 の内 部 問 題 に関 する情 報 を保 存
します。予 期 しないクラッシュが発 生 した場 合 、その時 点 で使 用 されていた各 DLL のバージョンとパスを識
別 します。

470
 用語集

Digiboard) をインスト ールしてください。

Digiboard Corporationにより製 造 された高 速 シリアル ボード 。

driver logs
特 定 のド ライバ操 作 に関 連 するド ライバ ログで、各 ド ライバに応 じて名 前 が付 けられます。たとえば、OPC
ド ライバは「OPC.dat」に記 録 されます。

I
I/Oサーバー
I/Oデバイスおよび コント ロール クライアント . I/Oサーバーでは (ローカル表 示 は除 いて) データ処 理 は行 われ
ません。データは収 集 され、表 示 用 に表 示 クライアント に渡 されます。または、さらに処 理 を行 うために他 の
サーバーに渡 されます。コンピュータからI/Oデバイスに送 られるすべてのデータが コンピュータはI/Oサーバーを
通 じてチャネル化 されます。データ ト ラフィックが多 い場 合 は、複 数 のI/Oサーバーを使 用 して負 荷 を分 散 さ
せられます。

I/Oデバイス
工 場 の生 産 現 場 の制 御 機 器 や監 視 用 機 器 (センサー、コント ローラなど) と通 信 する機 器 。最 も一 般 的
なI/OデバイスはPLC (プログラマブル ロジック コント ローラ) です。しかし、広 範 囲 のI/Oデバイスがサポート され
ています。例 えば、ループ コント ローラ、バー コード リーダー、科 学 分 析 、遠 隔 端 末 装 置 (RTU)、分 散 制
御 システム (DCS) です。標 準 通 信 チャンネルまたはデータ ハイウェイのあるどのI/Oデバイスとでも通 信 できま
す。

I/Oデバイス アド レス
システム内 の (論 理 的 な) I/Oサーバーの場 所 。I/Oデバイスが (冗 長 性 を提 供 する) 他 のサーバーで定 義 さ
れていない限 り、システム内 で、各 I/Oデバイスに一 意 の番 号 を付 ける必 要 があります。冗 長 性 を使 用 す
る場 合 、I/OデバイスのI/Oデバイス名 、I/Oデバイス番 号 、アド レスは、各 I/Oサーバーで同 じである必 要 があ
ります。

I/Oデバイス変 数
情 報 の単 位 。. 変 数 はI/Oデバイスのメモリ レジスタに保 存 されます。変 数 の読 み取 り、書 き込 みによ
り、I/Oデバイスと情 報 を交 換 します。レジスタ アド レスによりI/O デバイス変 数 を参 照 します。I/Oデバイス
は、数 種 類 の変 数 をサポート しますが、最 も一 般 的 なものがデジタル変 数 と整 数 変 数 です。

imestamp (T)
タグ拡 張 子 の要 素 が最 後 に更 新 されたときのタイムスタンプ。

IPアド レス
インターネット プロト コル (IP) で使 用 される一 意 の論 理 的 なアド レス。ネット ワークおよびホスト IDを含 みま
す。ド ット 付 10進 法 の形 式 で、次 のように記 述 します。w.x.y.z.

471
用語集

L
long型 BCD変 数 (I/Oデバイス)
0～ 99,999,999 の値 の4バイト (32ビット ) のデータ型 。4バイト は4ビット の8つのロット に分 割 され、4ビット の各
ロット は10進 数 を表 します。例 えば、2進 数 の0011は10進 数 の3を表 します。このように、BCD 0011 0011
0011 0011 0011 0011 0011 0011 は33,333,333を表 します。

long型 変 数 (I/Oデバイス)
通 常 、2,147,483,648～ 2,147,483,647 の値 をとる4バイト (32ビット )のデータ型 。

N
NULL値
変 数 に有 効 なデータがないことを示 します。NULLであるバリアント はVarTypeの1を返 します。NULLは空 と
同 じです。これはバリアント がまだ初 期 化 されていないことを示 します。0の長 さの文 字 列 (「」) とは同 じでは
ありません。これもNULL文 字 列 と呼 ばれる場 合 があります。NULLは、ゼロまたは空 白 に等 しいものです。
NULLの値 は、NULLを含 む他 のいかなる他 の値 (NULLの他 の値 を含 む) より大 きくも、小 さくも、等 しいと
も見 なされません。NULL値 を使 用 したブール値 比 較 では必 ずfalseが返 されます。

P
PLC インターフェース ボード
PLCインターフェイス ボード を サーバーにインスト ールできる場 合 があります。通 常 、PLCメーカーが専 用 のイ
ンターフェイス ボード を供 給 しています。これを、PLCまたはPLCネット ワークに接 続 できます。PLCと同 一 ブラ
ンド のインターフェイス ボード のみ使 用 できます。

PSTN
パブリック切 り替 え電 話 ネット ワークは、世 界 中 のすべてのパブリック切 り替 え電 話 ネット ワークのネット ワークで
す。現 在 、おもにデジタルであり、モバイル電 話 と固 定 電 話 が含 まれます。

R
RJ11
一 般 的 にデータ通 信 で使 用 されるIDCプラグのタイプ。電 話 線 および携 帯 端 末 用 コネクタで使 用 される
データ プラグのスタイルとして認 識 できます。RJ11は6極 ４芯 のプラグで、ピンが6つありますが4つのみ使 用 で
きます。

RJ12
一 般 的 にデータ通 信 で使 用 されるIDCプラグのタイプ。電 話 線 および携 帯 端 末 用 コネクタで使 用 される
データ プラグのスタイルとして認 識 できます。RJ11は6極 6芯 のプラグで、ピンが6つあります。

RJ45
一 般 的 にデータ通 信 で使 用 されるIDCプラグのタイプ。電 話 線 および携 帯 端 末 用 コネクタで使 用 される
データ プラグのスタイルとして認 識 できます。RJ45は10baseTとともに使 用 されることがよくあり、6極 8芯 のプラ

472
 用語集

グでピンが8つあります。

RS-232
シリアル通 信 の業 界 標 準 。デバイス間 のシリアル データ転 送 の制 御 に使 われる通 信 線 と信 号 特 性 を指
定 する規 格 。

RS-422
シリアル通 信 の業 界 標 準 。デバイス間 のシリアル データ転 送 の制 御 に使 われる通 信 線 と信 号 特 性 を指
定 する規 格 。RS-422では平 衡 電 圧 インターフェイス回 路 を使 用 します。

RS-485
シリアル通 信 の業 界 標 準 。デバイス間 のシリアル データ転 送 の制 御 に使 われる通 信 線 と信 号 特 性 を指
定 する規 格 。RS-485では、マルチポイント 接 続 で平 衡 電 圧 インターフェイス回 路 を使 用 します。

S
syslog.dat
syslog.dat は、プライマリ ログ ファイルです。低 レベルのド ライバ ト ラフィック、およびカーネル メッセージから
ユーザー定 義 メッセージまで、便 利 な情 報 が記 載 されています。ト レース オプション( 一 部 の CTAPI ト レー
スを除 く) がこのファイルに送 信 されます。

T
tracelog.dat
tracelog.dat ファイルには、主 にデータ サブスクリプションや更 新 に関 連 する管 理 されたコード ロギングが含 ま
れています。ネイティブ ド ライバへのフィールド ト レースや要 求 は、syslog.dat、または特 定 のド ライバ ログ フ
ァイルに送 信 されるので、注 意 してください。

U
UAC
ユーザー アクセス コント ロール Windows Vistaに導 入 されたセキュリティ技 術 であり、標 準 のユーザー権 限
で簡 単 に実 行 できます。.

ア
アキュムレータ
モーターの稼 働 時 間 、電 力 消 費 、ダウンタイムなど、漸 増 的 なランタイム データの追 跡 を可 能 にする装
置。

アクティブなアラーム
アクティブなアラームとは、次 の状 態 の内 のどれか1つの状 態 にあるアラームです。オンでかつ未 承 認 。オンで
かつ承 認 。オフでかつ未 承 認 。

473
用語集

アソシエーション
アソシエーションは、スーパー ジニー代 用 を定 義 する際 に使 用 した名 前 または番 号 で、ランタイムで動 的 に
生 成 される値 (1 つまたは複 数 ) です。

アナログ アラーム
アナログ変 数 が指 定 の値 に到 達 したときにト リガされます。4つのタイプのアナログ アラームがサポート されて
います。高 と高 高 のアラーム、低 と低 低 のアラーム、偏 差 アラーム、変 化 率 アラームの4種 類 のアラームがサ
ポート されています。

アニメーション基 準 点 と呼 びます。
グラフィックス ページにおいてオブジェクト が表 示 される位 置 。ページにオブジェクト を追 加 した際 、により自
動 的 に番 号 (AN) がアニメーション基 準 点 に割 り当 てられます (つまり、オブジェクト の位 置 )。

アニメーション番 号 ファイル (.ANT)

ASCIIテキスト ファイルには、アニメーション基 準 点 (AN) のリスト および各 ポイント の座 標 位 置 (ピクセル単
位 ) が含 まれています。

アラーム カテゴリー
各 アラームをカテゴリに割 り当 て、その後 各 カテゴリを1つのグループとして処 理 できます。例 えば、カテゴごとに
表 示 方 法 、カテゴリに該 当 するアラームが発 生 した場 合 の処 置 、およびアラームに関 するデータの記 録 方
法 を指 定 できます。また、カテゴリに優 先 度 を指 定 することもできます。優 先 度 は、アラームの表 示 順 序 や
確 認 のフィルタなどに使 用 できます。

アラーム サーバー
すべてのアラームを監 視 し、アラームがアクティブになる条 件 が満 たされると適 切 な制 御 用 クライアント に表
示 します。

アラーム サマリー ページ

次 のフォーマット でアラーム サマリー情 報 表 示 されます。アラーム名 、オンの時 刻 、オフの時 刻 、デルタ時
刻 、コメント

アラーム表 示 ページ
アラーム表 示 ページには、次 のフォーマット でアラーム情 報 が表 示 されます。アラーム時 刻 、タグ名 、アラーム
名 、アラームの説 明

イ
イーサネット
広 く使 用 されているCSMA/CDバス アクセス方 式 (IEEE 802.3) に基 づくローカル エリア ネット ワークの種 類 。

イベント ト レンド /SPC

イベント ト レンド /SPC を作 成 するには、(工 場 内 で) 特 定 のイベント がト リガされた時 に、サンプルをとりま
す。このサンプルはウィンド ウに表 示 されます。このイベント は、次 のサンプルが採 取 されるまでにリセット し、
再 度 ト リガする必 要 があります。イベント は、イベント 番 号 で識 別 されます。.

474
 用語集

インクルード ファイル (.Cll)

コマンド または式 フィールド に入 力 できる最 大 文 字 数 があります (通 常 は128文 字 )。プロパティ フィールド に
多 数 のコマンド (または式 ) を加 える必 要 がある場 合 は、コマンド および式 を含 む別 個 のインクルード ファイ
ルを定 義 できます。インクルード ファイルは、個 別 のASCIIテキスト ファイルで、長 すぎて、または複 雑 すぎ
て入 力 できないコマンド または式 の1列 だけが含 まれています。. インクルード ファイルの名 前 を入 力 すると、
呼 び出 されたときに、インクルード ファイル全 体 がアクティブになります。

インターネット 表 示 クライアント
遠 隔 地 からインターネット 経 由 でプロジェクト を実 行 できます。基 本 的 にこれは、「ランタイムのみの」バージョ
ンです。普 通 の表 示 クライアント から実 行 しているかのように、そのコンピュータからプロジェクト を実 行 できま
す。

ウ
ウィザード
A 複 雑 な手 順 を簡 易 化 する機 能 。

エ
エリア
大 規 模 なアプリケーションを、一 連 の個 別 的 なセクションまたは領 域 として視 覚 化 できます。これらのエリア
は、地 理 的 に (プラント の一 部 が離 れた場 所 にある場 合 )、または論 理 的 に (分 離 したプロセスまたは個 々
のタスク) 定 義 できます。

オ
オート メーション コンポーネント (ActiveX オブジェクト )
ActiveX オブジェクト は通 常 、ビジュアル コンポーネント (画 面 上 に表 示 されています) およびオート メーション
コンポーネント で構 成 されています。オート メーション コンポーネント により、コンテナ オブジェクト とActiveX オ
ブジェクト 間 の対 話 が可 能 になります。

オープン データベース コネクティビティ (ODBC)

構 造 化 問 い合 わせ言 語 (SQL) を使 用 して、アプリケーションのデータベース管 理 システム内 のデータへのア
クセスを可 能 にします。

オブジェクト
グラフィックス ページの基 本 構 成 要 素 。大 部 分 のオブジェクト にはプロパティがあり、ユーザー定 義 可 能 なラ
ンタイム条 件 の下 で動 的 にオブジェクト の変 更 ができ、工 場 内 の状 態 を動 画 表 示 できます。

オブジェクト ID (OID)
コンパイル時 に自 動 生 成 される、タグ ベースのド ライバが使 用 するタグを一 意 に識 別 する、プロジェクト 内 に
あるすべてのタグに関 連 したオブジェクト ID 実 際 のレジスタのアド レスの替 わりに使 用 されます (ほとんどのド ラ
イバがI/Oデバイスからの読 み込 み、書 き込 みに使 用 します)。

475
用語集

オブジェクト 変 数 (Cicode)
ローカル、モジュール、またはグローバル スコープでのみ宣 言 できるActiveXコント ロール。

カ
カーネル
カーネルを使 用 すると、システムのランタイム分 析 の低 レベルの診 断 動 作 やデバッグの実 行 が可 能 になりま
す。診 断 ウィンド ウは、低 レベル データ構 成 、ランタイム データベース、統 計 、デバッグの追 跡 、ネット ワーク
のト ラフィック、I/Oデバイスのト ラフィックなどを表 示 します。

カスタム アラーム フィルタ

カスタム アラーム フィルタは、有 効 なアラームをフィルタし表 示 する方 法 を提 供 します。最 大 8個 のカスタム フ
ィルタ設 定 を設 定 アラームに割 り当 てできます。カスタム フィルタは、ユーザー定 義 のクエリ関 数 と連 携 させる
ことで、オペレータが関 心 のあるアクティブ アラームを特 定 および表 示 できるようにします。

キ
キーボード コマンド
オペレータがキーボード から入 力 するキー シーケンスと、キー シーケンスが入 力 されたときに実 行 される命 令
(または一 連 の命 令 ) で構 成 されます。キーボード コマンド は、オブジェクト またはページに割 り当 てることがで
きますし、またはプロジェクト 規 模 にすることができます。

キャッシュ (I/Oデバイス データ キャッシュ)

キャッシュが有 効 な場 合 、I/Oデバイスから読 み込 まれたすべてのデータは一 時 的 にI/Oサーバーのメモリ内 に
保 存 されます。別 の要 求 がキャッシュ時 間 内 に (同 じまたは別 の制 御 クライアント から) 同 じデータに対 して
行 われる場 合 、I/O サーバーは、I/O デバイスを再 度 読 み込 まずにメモリ内 の値 を返 します。

ク
クライアント
サーバーと呼 ばれる他 のコンピュータが提 供 する共 有 ネット ワーク リソースにアクセスするコンピュータ。のクラ
イアント - サーバー アーキテクチャは、タスク処 理 を分 散 しパフォーマンスを最 適 化 するよう設 計 されていま
す。

クラスタ
アラーム サーバー、ト レンド サーバー、レポート サーバー、およびI/Oサーバーの個 々 のグループ。通 常 、ロー
カルの コント ロール クライアント . いくつもの個 別 セクションまたはシステムで構 成 される工 場 では、複 数 のクラ
スタを使 用 できます。セクションごとに1つのクラスタになります。

グ
グラフィックス ページ
ワークステーションに表 示 された描 画 (イメージ) であり、これによってオペレータは工 場 を制 御 し、工 場 内 の
状 態 は視 覚 的 に表 示 されます。

476
 用語集

グラフィックス境 界 ボックス
グラフィックス オブジェクト の外 部 境 界 領 域 を定 義 する、薄 い (グレーの) 点 線 の四 角 形 の外 枠 。グラフィック
ス オブジェクト が選 択 され、サイズ変 更 されている場 合 にのみ、表 示 され有 効 になります。各 コーナーにサイ
ジング ハンド ルがあり、(表 示 できるくらい十 分 な大 きさの場 合 は) 各 側 の中 央 に1つのサイジング ハンド ルが
あります。

グローバル クライアント
(クラスタを使 用 して) 複 数 のシステムまたはセクションの情 報 の監 視 に使 用 する制 御 クライアント 。

グローバルCicode変 数
システム内 のすべてのCicodeファイルで共 有 できます (インクルード プロジェクト と同 様 )。

コ
コールバック関 数
他 の関 数 に引 数 として渡 される関 数 。コールバック関 数 はユーザー定 義 の関 数 です。

コマンド
コマンド は、特 定 のタスク、または一 連 のタスクをランタイム システムで実 行 します。コマンド はCicodeで作 成
し、関 数 またはステート メント のみで構 成 されます。

コント ロール クライアント

ランタイム システムおよびオペレータ間 のインターフェイス。ネット ワークで使 用 している場 合 は、ネット ワークの
すべてのコンピュータが制 御 クライアント です。

コント ロール抑 制 モード

タグ拡 張 子 のフィールド VQT タグ要 素 への書 き込 みを禁 止

コンピュータ
実 行 中 のコンピュータ コンピュータに対 する一 般 的 な業 界 用 語 では、ノード 、マシン、ワークステーションを意
味 する場 合 もあります。

サ
サーバー
1つのI/Oデバイス (または複 数 のI/Oデバイス) 接 続 されたコンピュータ。実 行 中 、サーバーはI/Oデバイスと
データを交 換 し、必 要 に応 じて他 の制 御 クライアント に情 報 を送 信 します。ローカル エリア ネット ワーク
(LAN) コンピュータ。タスク処 理 を実 行 し、または他 のクライアント コンピュータがリソースを使 用 できるように
します。クライアント /サーバー アーキテクチャでは、タスク処 理 を分 散 しパフォーマンスを最 適 化 します。

サブステータス値
品 質 タグの基 本 的 な詳 細 。

477
用語集

ジ
ジニー
同 じ種 類 のデバイスが数 多 くある場 合 (遠 心 ポンプが 100 台 ある場 合 など) 、これらのデバイスの表 示 グラフ
ィックスはほぼ同 じように動 作 します。このような場 合 、ジニーを使 用 すると共 通 の動 作 を1度 設 定 するだけ
で十 分 です。その後 、作 成 したグラフィックスをジニーとして保 存 し、各 デバイスに貼 り付 けます。

シ
シリアル通 信
コンピュータの通 信 ポート 、またはコンピュータ内 部 にインスト ールされた高 速 シリアル ボード を使 用 します。

シンボル
後 の検 索 および使 用 のため、ライブラリに保 存 されているオブジェクト (またはオブジェクト のグループ)。ライブ
ラリに共 通 オブジェクト を保 存 することにより、プロジェクト の保 存 に必 要 なディスク スペース、およびランタイム
システムに必 要 なメモリ量 を削 減 します。

ス
スーパージニー
動 的 なページ (通 常 はポップアップ) であり、ランタイムでページが表 示 されるときにこのページに情 報 を渡 しま
す。ポップアップ型 コント ローラにスーパー ジニーを使 って、プロセスまたは施 設 のフロア設 備 の１つを制 御 で
きます。

スケーラブル アーキテクチャ
既 存 のハード ウェアまたはソフト ウェアを変 更 せずに、サイズを変 更 できるシステム アーキテクチャ。処 理 負
荷 の分 散 に加 え、コンピュータが追 加 されるとタスクを再 配 分 することができます。

スケジュール期 間
データ読 み込 みのためにI/OサーバーがスケジュールI/Oデバイスにコンタクト をとる頻 度 を決 定 します。.

スタンバイ アラーム サーバー

プライマリ アラーム サーバーが利 用 できない場 合 、アラームを処 理 するサーバー。

スタンバイ ト レンド サーバー

プライマリ ト レンド サーバーが利 用 できない場 合 、ト レンド を処 理 するサーバー。

スタンバイ レポート サーバー

プライマリ レポート サーバーが利 用 できない場 合 、レポート を処 理 するサーバー。

スライダ コント ロール

オペレータは、グラフィックス ページのオブジェクト (またはオブジェクト のグループ) をド ラッグすることで、アナログ
変 数 の値 を変 更 できます。また、スライダは、変 数 タグの値 を反 映 して自 動 的 に移 動 します。

478
 用語集

スレッド
マルチタスク オペレーション システムにおいて、タスクの同 時 実 行 を管 理 するために使 用 されます。これによっ
て優 先 順 位 の決 定 、CPUアクセスのスケジュール作 成 ができます。

ソ
ソフト PLC
ソフト ウェアにより作 成 された純 粋 なソフト (仮 想 ) PLCで、コンピュータ メモリ内 にのみ存 在 します。通 常 、
通 信 (読 み込 みと書 き込 み) 操 作 をソフト PLCで行 うためのソフト ウェア インターフェイスを提 供 します。「仮
想 フィールド ユニット 」または「仮 想 I/Oデバイス」とも呼 ばれます。

ソフト ウェア保 護
ライセンスの侵 害 から保 護 するため、コンピュータのプリンタ ポート に差 し込 むハード ウェア キーを使 用 しま
す。ハード ウェア キーにはユーザー ライセンスの詳 細 が含 まれています。実 行 するとき、プロジェクト のポイン
ト カウント が、ハード ウェア キーで指 定 されているポイント 制 限 と照 合 されます。

タ
タイムアウト
タスクを完 了 すべき期 間 。タスクが完 了 するまでにタイムアウト 期 間 に到 達 すると、タスクは終 了 します。

タイムスタンプ付 きアナログ アラーム

タイムスタンプ付 きアナログ アラームは、アナログ アラームと同 様 に動 作 しますが、ミリ秒 単 位 の正 確 さでフ
ィールド デバイス (RTUまたはPLC) が記 録 した時 間 がタイムスタンプ付 加 される点 では異 なります。タイムス
タンプ付 きアラームの設 定 は、アナログ アラームの設 定 とまったく同 一 です。

タイムスタンプ付 きアラーム
デジタル変 数 の状 態 変 化 によりト リガされるアラーム。タイムスタンプ付 きアラームは、I/Oデバイスに関 連 レジ
スタを持 ち、アラームが有 効 に変 化 した正 確 な時 刻 を記 録 しています。アラームの正 確 な発 生 順 序 を知 る
必 要 がある場 合 にタイムスタンプ付 きアラームを使 用 します。

タイムスタンプ付 きデジタル アラーム

タイムスタンプ付 きデジタル アラームは、デジタル アラームと同 じように動 作 しますが、ミリ秒 単 位 の正 確 さで
フィールド デバイス (RTUまたはPLC) により記 録 された時 間 がタイムスタンプ付 加 される点 は異 なります。タ
イムスタンプ付 きデジタル アラームの設 定 は、デジタル アラームの設 定 とまったく同 一 です。

ダ
ダイヤルアウト モデム
要 求 (スケジュールされた、イベント ベース、オペレータの要 求 など) に応 えて、リモート I/Oデバイスを呼 び出 し
ます。また、リモート のI/Oデバイスからの呼 び出 しを返 します。

479
用語集

ダイヤルイン モデム
リモート の I/Oデバイスからの呼 び出 しのみを受 信 し、送 信 元 を識 別 して、他 の呼 び出 しを受 信 できるように
すぐに接 続 を解 除 します。ダイヤルバック モデムを使 用 して呼 び出 しを返 します。

ダイヤルバック モデム
リモート I/Oデバイスからのコールのみに対 し、コール バックを行 います。

タグ拡 張 子
要 素 のコレクションやタグの項 目 のコレクションとしてデータを表 わすタグの追 加 情 報 。

タスク
I/O処 理 、アラーム処 理 、表 示 管 理 、およびCicodeの実 行 などの操 作 を含 みます。Cicodeの個 々 の「イン
スタンス」もまた「タスク」です。

タッチ (ランタイム時 のオブジェクト )

オペレータがクリックすると、オブジェクト はタッチされたとみなされます。

タッチ コマンド
グラフィックス ページのオブジェクト に割 り当 てることができます。タッチ コマンド では、オブジェクト をクリックして
コマンド をランタイム システムに送 信 できます。

ツ
ツール チップ
オペレータがマウスをオブジェクト に移 動 すると、ポップアップ ウィンド ウにヘルプ メッセージが表 示 されます。

デ
ディザ (インポート されたビット マップ)
カラー パレット の異 なる色 のピクセルを組 み合 わせるなど、インポート または貼 り付 けられたビット マップの色 を
近 似 させる方 法 。

ディスクI/Oデバイス
ディスク ファイルはコンピュータのハード ディスクに常 駐 し、リアルI/Oデバイスをエミュレート します。ディスクI/O
デバイスの各 変 数 値 は、コンピュータのハード ディスクに保 存 されます。ディスクI/Oデバイスは、工 場 内 のど
のフィールド 装 置 とも接 続 されません。

データ タイプ (I/Oデバイス)

I/O デバイス変 数 のタイプ。I/Oデバイスは、データ交 換 に使 用 するいくつかのデータタイプをサポート すること
ができます。. I/Oデバイス変 数 が定 義 または システムを参 照 する際 にはいつも、適 切 な データ タイプを指
定 する必 要 があります。

データ ビット
非 同 期 転 送 において1文 字 を表 現 するために使 用 される2進 数 (ビット ) のグループ。

480
 用語集

データ取 得 ボード
データ取 得 ボード は、フィールド 装 置 (センサー、コント ローラなど) と直 接 通 信 します。データ取 得 ボード を
サーバーにインスト ールし、フィールド 装 置 に直 接 アクセスします。

データ端 末 装 置 (DTE)
データ ソースまたはデータ シンク、またはその両 方 の役 割 をもつ装 置 。

データ転 送
1つの場 所 から他 の場 所 への情 報 の転 送 。データ転 送 速 度 は、ビット /秒 (bps) で測 定 します。

データ通 信 装 置 (DCE)
データ転 送 接 続 を確 立 および停 止 する装 置 。通 常 、モデムと呼 ばれます。

テ
テキスト ボックス
テキスト がグラフィックス ページに追 加 された場 合 、テキスト ボックスの中 に表 示 されます。テキスト ボックスに
は、多 数 のハンド ルがあり、これを使 用 してテキスト オブジェクト を操 作 できます。

デジタル アラーム
アナログ変 数 の状 態 変 化 によりト リガされます。プロセスに2つの状 態 のうちの1つだけがある場 合 に使 用 し
ます。(デジタル変 数 の) オン (1) またはオフ (0) 状 態 のいずれかを使 用 して、アラームをト リガします。

デジタル変 数 (I/Oデバイス)
通 常 、I/Oデバイスの離 散 I/Oに関 連 しており、デジタル変 数 は2つの状 態 のうちの1つにしかなりません。オン
(1) または オフ (0)。したがって、デジタル データ タイプに許 される値 は0または1です。離 散 入 力 (制 限 スイッ
チ、光 電 池 、緊 急 停 止 ボタンなど) および離 散 出 力 はデジタル変 数 として保 存 されます。

デュプレックス
同 一 通 信 ライン上 でのデータの送 受 信 機 能 。

テンプレート
グラフィックス ページの作 成 のために使 用 する基 本 描 画 または時 間 節 約 パターン。各 テンプレート には、
ボーダー、共 通 コント ロール ボタンなどのページの基 本 情 報 が含 まれています。すべての共 通 ページタイプ
のテンプレート があります。

ド
ド ット 表 記
インターネット アド レスに使 用 します。ド ット 表 記 は、(オクテット と呼 ばれる) 4つのフィールド で構 成 されます。
それぞれ0～ 255の10進 数 の数 が入 り、ピリオド で区 切 られます。

ド メイン ネーム サーバー (DNS)

URL名 をIPアド レスに変 換 するデータベース サーバー。

481
用語集

ド ライバ
ド ライバは、制 御 や監 視 装 置 との通 信 に使 用 され、ランタイム システムと他 のタイプのデバイスとの直 接 の対
話 が可 能 になります。I/Oデバイスを使 用 した通 信 には通 信 プロト コルを実 装 したデバイス ド ライバが必 要
です。

ト
ト レンド
工 場 変 数 (式 ) または多 数 の変 数 の値 の変 化 を表 すグラフィカルな表 現 。.

ト レンド プロット
ト レンド (または複 数 のト レンド )、タイト ル、コメント 、スケール、時 刻 などで構 成 されます。

ト レンド ライン
工 場 変 数 (式 ) の値 の変 化 を表 すト レンド の実 際 のライン。.

ネ
ネイティブ言 語 (母 国 語 )
一 般 的 にはプロジェクト 開 発 者 の言 語 。アラーム説 明 、ボタン テキスト 、キーボード /アラーム ログ、グラフィッ
ク テキスト 、Cicode文 字 列 などの表 示 項 目 を、母 国 語 で設 定 し、さらにランタイム時 にエンド ユーザーの言
語 (ローカル言 語 ) で表 示 することができます。

ネット ワーク
通 信 リンク経 由 で接 続 されたコンピュータおよび周 辺 機 器 のグループ。データおよびサービス (例 えば、プリン
タ、ファイル サーバー、モデム) をネット ワーク上 のコンピュータで共 有 できます。PCのローカル ネット ワーク
はLANと呼 ばれます。

ネット ワーク コンピュータ

ネット ワーク アダプタ カード およびネット ワーク ソフト ウェアを介 してLANに接 続 された を実 行 中 のコンピュータ
.

ネット ワーク動 的 データ交 換 (Ｎｅｔ

DDE)
共 通 のネット ワーク上 にある接 続 された個 々 のコンピュータのWindowsアプリケーション間 での通 信 を可 能 に
します。

ノ
ノード
グラフィックス オブジェクト の構 造 アンカー ポイント 。通 常 はグラフィック上 に小 さな正 方 形 の箱 が重 なって見
えます。ノード は、グラフィック オブジェクト 内 の開 始 点 、終 了 点 、すべての方 向 変 化 点 に配 置 されます。.

482
 用語集

ハ
ハード ウェア アラーム
ハード ウェアアラームは、エラーがシステムで検 出 されたことを示 します。このタイプのアラームは、一 般 的 に専
用 のハード ウェア アラーム ページで表 示 され、通 信 損 失 の発 生 、Cicode の実 行 不 能 、グラフィックスのペー
ジの正 常 な更 新 不 能 、サーバーの停 止 などを示 します。説 明 とエラーコード は、その問 題 の原 因 を解 明 す
る目 的 で提 供 されます。

バ
バイト 変 数 (I/O デバイス)
バイト は1バイト データ タイプで、値 は0～ 255です。1バイト は8ビット から成 ります。各 ASCII文 字 は1バイト で
表 現 されるのが普 通 です。

パ
パック
レコード のインデックス再 作 成 、および削 除 マークのついたレコード を削 除 するデータベースの圧 縮 。の外 部
でデータベースを編 集 する場 合 、後 でデータベースを圧 縮 してください。

パリティ
通 信 エラーチェック手 順 。エラーなしで転 送 されたビット の各 グループでは、1の数 が同 じになるはずです (偶
数 または奇 数 )。

ヒ
ヒスト グラム
発 生 頻 度 を表 す棒 グラフ。データはほとんどの場 合 、正 規 分 布 などの分 布 に一 致 します。.

フ
ファイル サーバー上 にある)プロジェクト データベースの n の値 に設 定 されています。
ファイル記 憶 専 用 の大 容 量 記 憶 を持 つコンピュータであり、他 のクライアント はネット ワーク経 由 でアクセスし
ます。大 規 模 なネット ワーク上 では、ファイル サーバーは特 別 なネット ワーク オペレーティング システムとして
稼 動 します。比 較 的 小 規 模 なインスト ールでは、ファイル サーバーはピアツーピア ネット ワーク ソフト ウェアに
よって補 完 されるPCオペレーティング システムを実 行 できます。

フィールド VQT
デバイスから得 られた最 新 のタグ フィールド データ。

プ
プライマリ アラーム サーバー
通 常 はアラームを処 理 するサーバー。

483
用語集

プライマリ ト レンド サーバー

通 常 はト レンド を処 理 するサーバー。

プライマリ レポート サーバー

通 常 はレポート を処 理 するサーバー。

フル デュプレックス
同 時 2方 向 (双 方 向 ) の通 信 (４線 式 )。

プロキシ/プロキシ サーバー
インターネット ト ランザクションのキャッシュ。同 一 の要 求 が再 度 出 されたときに、再 使 用 の目 的 でクエリおよ
び取 得 した情 報 を保 存 して、平 均 のト ランザクションを削 減 し、パフォーマンスを向 上 させます。インターネッ
ト 表 示 クライアント (IDC) をプロキシ サーバーに接 続 するとき、そのサーバーがレポート サーバー セッション情
報 にアクセスするために必 要 なTCP/IPアド レスを提 供 します。

プロジェクト
グラフィックス ページ、オブジェクト など監 視 ・制 御 システムの要 素 。これらの要 素 はさまざまなタイプのファイ
ルに保 存 されています。例 えば、グラフィックス ページはグラフィックス ファイルに、設 定 レコード はデータベース
に保 存 されています。コンパイラを使 用 して、プロジェクト をランタイム システムにコンパイルします。

プロト コル
サーバーおよびI/Oデバイス間 の通 信 に使 用 されるメッセージのセット とガイド ラインからなるメッセージ フォーマ
ット 。通 信 プロト コルにより およびI/Oデバイスの通 信 方 法 が決 定 されます。データ交 換 のタイプ、通 信 の開
始 および終 了 のルール、エラー検 出 などです。

プロパティ, オブジェクト
オブジェクト の外 観 (サイズ、位 置 、色 など) とその機 能 (オブジェクト により実 行 されるコマンド または式 、オブ
ジェクト へのアクセスに必 要 な権 限 など) を記 述 します。

ペ
ページ環 境 変 数
関 連 性 を作 成 した場 合 の、特 定 のページに関 連 する読 み込 み専 用 変 数 。変 数 に名 前 を付 け、値 を割 り
当 てます。ランタイム時 にページを開 いた場 合 、により変 数 が作 成 されます。その値 は読 み込 みできます。
ページを閉 じるとき、環 境 変 数 メモリは解 放 されます( 捨 てられます) 。

ポ
ポイント リミット
I/Oデバイスから読 み込 まれる個 々 のデジタル (またはアナログ) 変 数 。物 理 ポイント のみカウント されます (何
度 使 用 しても、カウント は1回 のみです)。ポイント 制 限 は、読 み取 り可 能 なI/Oデバイス アド レスの最 大 数
であり、ライセンスによって指 定 されています。プロジェクト のポイント カウント を実 行 した時 点 は、ハード ウェ
ア キーで指 定 されるポイント 制 限 と照 合 されます。

484
 用語集

ボ
ボー レート
通 信 チャンネルにおける1秒 あたりの信 号 の変 化 の回 数 。ボーレート はデータ通 信 速 度 に直 接 影 響 します
が、この用 語 はデータ転 送 速 度 の説 明 に誤 って使 用 されることがよくあります。データ転 送 速 度 は、ビット /
秒 (bps) です。

ポート
I/Oデバイスに通 信 ゲート ウェイを提 供 します。

ボト ルネック
過 多 な要 求 がPLC通 信 リンク/データ ハイウェイに送 信 された場 合 に、ボト ルネックが発 生 します。これはす
べてのタイプのプロト コルで発 生 する可 能 性 があり、発 生 するかどうかは、他 のネット ワーク ト ラフィックと同 じよ
うに、要 求 の頻 度 、重 複 (無 駄 になる) 要 求 の数 、プロト コルが複 数 の未 解 決 要 求 をサポート しているかど
うかなど、複 数 の要 素 に依 存 します。

マ
マルチデジタル アラーム
3つのデジタル変 数 の値 の組 み合 わせを使 用 して8つの状 態 を定 義 します。各 状 態 について、説 明 (例 え
ば、良 好 、停 止 中 ) を記 述 し、その状 態 でアラームをト リガするかどうかを指 定 します。

ミ
ミリ秒 ト レンド
ト レンド サンプルを1秒 未 満 の周 期 で使 用 できます。

メ
メタデータ
メタデータは、オブジェクト アニメーションポイント に付 与 されるリスト に対 応 する名 前 のリスト です

モ
モジュールCicode変 数
変 数 が宣 言 されているファイルに固 有 です。つまり、当 該 ファイルのあらゆる関 数 が使 用 できますが、他 のフ
ァイルの関 数 は使 用 できません。デフォルト では、Cicode関 数 はモジュールとして定 義 されています。したが
って、プレフィックスは不 要 です (必 要 な場 合 は、ＭＯＤＵＬＥのプレフィックスを付 加 することもできます)。モジ
ュール変 数 はファイルの先 頭 で宣 言 する必 要 があります。

ユ
ユーザー
ランタイム システムへのアクセスを要 求 する人 物 、または人 物 のグループを指 します。

485
用語集

ゆ
ゆがみ度
頻 度 分 布 の非 対 称 性 の度 合 を示 す指 標 です( 通 常 は、正 規 分 布 に関 連 してです) 。分 散 が (たとえば)
左 にゆがんでいる場 合 、すそがそちらの方 向 に拡 大 し、通 常 の分 散 から予 測 したよりも左 側 に多 くのデータ
があります。正 の歪 度 は、分 散 平 均 (および裾 ) が右 に歪 んでいることを示 します。不 の歪 度 は、分 散 平
均 (および裾 ) が左 に歪 んでいることを示 します。

ラ
ランタイム システム
コンピュータ上 の システム。ランタイム システムはマン マシン インターフェイス (MMI) と呼 ばれることもあり、
プロジェクト からコンパイルします。

リ
リモート 端 末
制 御 を行 っているコンピュータから離 れている端 末 。コンピュータおよびリモート 端 末 はモデムおよび電 話 回
線 を使 用 して通 信 します。

リモート 通 信
モデムおよび電 話 線 を使 用 した2台 のコンピュータ間 の対 話 。

リンク
オリジナルのライブラリのプロパティを持 つ、ライブラリ項 目 のコピー。リンクされているので、オリジナルが変 更 さ
れるとコピーも更 新 されます。

レ
レコード 名
通 常 は、データベース レコード のプライマリ プロパティです。その名 前 によってシステム内 で参 照 されます。
データベース レコード 名 は、データベース レコード のタイプごとに一 意 である必 要 があります。異 なるレコード
タイプについて同 一 の名 前 を使 用 できることもあります。しかし、混 乱 を避 けるために、アプリケーションの各
データベース レコード には一 意 の名 前 を使 用 すべきです。データベース レコード の名 前 を指 定 するとき、名
前 の先 頭 は英 字 (A～ Z、a～ z) にし、残 りには英 数 字 (A-Z、a-z、0-9) およびアンダースコア (_) のみを続
けられます。たとえば、「Pressure」、「Motor_10」、および「SV122_Open」はすべて有 効 なレコード 名 です。
各 データベース レコード 名 は最 高 16文 字 にできます。データベース レコード 名 では大 文 字 と小 文 字 は区 別
されません。例 えば、「MOTOR_1」、「Motor_1」、「motor_1」は同 一 のデータベース レコード 名 です。このた
め、どのデータベース レコード についても、必 要 な命 名 規 則 とともに、意 味 のある名 前 を使 用 してください。

レポート
工 場 作 業 場 状 態 のステート メント またはアカウント 。レポート は必 要 に応 じて、周 期 的 に、またはイベント
発 生 時 に要 求 することができます。

486
 用語集

レポート サーバー
レポート 処 理 を制 御 します。いつでもレポート を要 求 できますし、特 定 のイベント 発 生 時 にレポート を要 求
することもできます。

レポート フォーマット ファイル

レポート のレイアウト および内 容 を制 御 します。フォーマット ファイルは、テキスト エディタを使 用 して編 集
し、ASCIIフォーマット またはRTFフォーマット が使 用 できます。

ロ
ローカル エリア ネット ワーク (LAN)
コンピュータを接 続 し、情 報 およびハード ウェア リソースを共 有 できるようにします。リアルタイムLAN接 続
で、データ、メッセージ、コマンド 、ステータス情 報 、およびファイルを簡 単 にコンピュータ間 で転 送 できます。

ローカルCicode変 数
宣 言 された関 数 の中 でのみ、関 数 により認 識 され、その関 数 のみが使 用 できます。ローカル変 数 は使 用
する前 に宣 言 する必 要 があります。関 数 の中 で定 義 されたあらゆる変 数 (つまり、関 数 名 の後 ) は、ローカ
ル変 数 です。したがって、プレフィックスは不 要 です。関 数 が存 在 し、すべてのグローバル変 数 およびモジュー
ル変 数 に優 先 する場 合 、ローカル変 数 は破 棄 されます。

ローカル変 数 ロウカルヘンスウ
ローカル変 数 を使 うと、ランタイム システムの開 始 時 にデータをメモリに格 納 できます。システムが起 動 する
度 に作 成 されるので、シャット ダウンする際 に値 は保 存 されません。

ローカル言 語
エンド ユーザーの言 語 。アラーム説 明 、キーボード /アラーム ログ、グラフィック テキスト 、Cicode文 字 列 など
のランタイム表 示 項 目 は、開 発 者 の言 語 (ネイティブ、すなわち母 国 語 ) で設 定 されている場 合 であって
も、ローカル言 語 で表 示 できます。

ログ ファイル
ログ ファイルとは、問 題 の原 因 を特 定 する際 に解 析 できる、タイムスタンプ付 きシステム データの記 録 です。
利 用 可 能 なログ ファイルには、syslog.dat、tracelog.dat、debug.log、kernel.dat のほかに専 用 のド ライバー
ログがあります。

上
上 書 きモード
無 効 なタグ品 質 の値 を追 加 の値 で手 動 で上 書 する状 態 。

予
予約語
どのデータベース レコード 名 としても、Cicode関 数 名 としても使 用 できない単 語 。

487
用語集

仮
仮想
物 理 的 な識 別 ではなく、動 作 的 な識 別 。例 えば、Windows 95は仮 想 のデスクト ップです。

低
低 アラームおよび低 低 アラーム
各 アラームをト リガする変 数 の値 を指 定 することによって定 義 します。低 アラームは低 低 アラームに先 行 しま
す。低 低 がト リガされるときには低 アラームはもはや存 在 しません。アラームが無 効 になる前 に変 数 が不 感
帯 域 より上 昇 している必 要 があることに注 意 してください。.

値
値 (V)
タグ拡 張 子 の値 。

値 タイムスタンプ (VT)
タグ拡 張 子 の値 が最 後 に変 更 されたときのタイムスタンプ

偏
偏 差 アラーム
変 数 値 がセット ポイント から指 定 された量 から離 れるト リガされます。アラームは、当 該 値 が不 感 帯 域 まで
下 降 (または上 昇 ) するまで、有 効 のままになります。.

停
停 止 ビット
非 同 期 転 送 において文 字 の最 後 を知 らせるためのビット の数 字 。この数 字 は通 常 は1または2です。スト ッ
プ ビット は非 同 期 転 送 で必 要 となります。送 信 される文 字 間 の時 間 間 隔 が不 規 則 なため、サーバーまた
はI/Oデバイスが次 の文 字 がいつ到 達 するか決 定 できないからです。

冗
冗長性
システムの1つのコンポーネント が動 作 不 能 になった場 合 でもシステムの制 御 が維 持 され、データが失 われな
いように、システムのハード ウェアを使 用 する方 法 。

分
分 散 サーバー
いくつかの個 別 セクションまたはシステムで構 成 される工 場 では、クラスタを各 セクションに割 り当 て、1つを使
用 してあうべてのセクションを監 視 することができます。コント ロール クライアント .注 : 分 散 サーバーを使 用 し
て1つのセクションまたはプロセスを分 散 エリアに分 割 しないでください。分 散 サーバー システムのメンテナンス

488
 用語集

費 用 (余 分 なプロジェクト のコンパイルなど) に制 限 されないので、分 散 処 理 を備 えた単 一 クラスタ システム

を使 用 するのが良 い方 法 です。

分散処理
大 量 のデータがある大 規 模 なアプリケーションでは、データ処 理 を分 散 することで、個 々 のコンピュータの負
荷 を低 減 できます。

割
割 り込 み
CPUが現 在 のタスクを中 断 し、指 定 された活 動 をサービスする必 要 があることを示 す外 部 イベント 。

動
動 的 データ交 換 (DDE)
Microsoft Windowsの標 準 のメッセージ プロト コル セット およびガイド ライン。Windowsの同 一 コンピュータ
のWindowsアプリケーション間 で通 信 ができます。

動 的 データ交 換 (DDE) サーバー

サポート されているWindows標 準 の通 信 プロト コル。. コンピュータ上 の I/OサーバーがDDEサーバーと通 信 し
ます。DDEサーバーが高 速 データ転 送 用 に設 計 されておらず、しかもデータ通 信 が重 要 でない場 合 に
は、DDEサーバーが適 切 です。

半
半二重
双 方 向 可 能 であるが、同 時 ではない通 信 。

単
単方向伝送
一 方 向 のみのデータ転 送 。

参
参 照 シーケンスに関 連 するページをリンク付 けできます。
ブラウズ シーケンスによりリンクされた一 連 のグラフィックス ページであり、Page PreviousおよびPage Nextコマ
ンド を使 用 するランタイム システム内 の線 形 ナビゲーション シーケンスです。

古
古 い周 期
タグ要 素 の拡 張 品 質 が「古 い」に設 定 される前 に、最 終 更 新 後 に経 過 する秒 数 の合 計 を表 します。

489
用語集

周
周 期 ト レンド
指 定 の周 期 で継 続 的 に取 られるト レンド のサンプル。ト リガを定 義 して (特 定 の条 件 が工 場 内 に発 生 した
ときに) ト レンド を開 始 または停 止 することもできます。

品
品 質 (Q)
タグ拡 張 子 の値 の品 質 。

品 質 タイムスタンプ (QT)
タグ拡 張 子 の品 質 が最 後 に変 更 されたときのタイムスタンプ

変
変 化 率 アラーム
変 数 値 が指 定 の率 より速 く変 化 するとト リガされます。変 化 率 が指 定 の率 より下 がるまで、アラームは有 効
なままです。不 感 帯 は変 化 率 アラームには適 用 されません。

変 数 タイプ (Cicode)
変 数 (INT (32 ビット )、STRING (256バイト )、OBJECT (32ビット )) のタイプ。

実
実 変 数 (Cicode)
実 数 は (浮 動 小 数 点 ) は4バイト (32ビット ) データ型 で、3.4E38～ 3.4E38 の値 です。実 変 数 を使 用 して、
小 数 点 位 置 を含 む数 字 を保 存 します。

実 変 数 (I/O デバイス)
実 数 は (浮 動 小 数 点 ) は4バイト (32ビット ) データ型 で、3.4E38～ 3.4E38 の値 です。実 変 数 を使 用 して、
小 数 点 位 置 を含 む数 字 を保 存 します。

尖
尖度
頻 度 分 布 のピーク性 の度 合 を示 す指 標 です( 通 常 の正 規 分 布 に関 連 してです) 。尖 度 は< 3比 較 的 高
いピークをもった薄 い分 布 を示 します。尖 度 は>広 く平 坦 な分 布 を示 します。

式
式
値 を返 すステート メント (またはステート メント のグループ)。式 は、1つの変 数 、数 式 、または関 数 などです。

490
 用語集

引
引数
ランタイムで (オペレータ入 力 として) キー順 にキーボード コマンド に渡 される値 (または変 数 )。引 数 はまた、
実 行 時 にCicode関 数 に渡 される値 (または変 数 ) でもあります。

役
役割
ユーザーに割 り当 てられた許 可 (権 限 と領 域 ) の定 義 されたセット です。

持
持 続 キャッシュから値 を読 み込 むことができます。
コンピュータ ハード ディスクに保 存 されたキャッシュ データであり、これによりI/Oサーバーは現 在 値 を取 得 する
ために各 I/Oデバイスに再 ダイヤルすることなく、停 止 または再 起 動 できます。このキャッシュは、すべてのI/O
デバイスのタグ値 で構 成 されています。

接
接 続 機 構 インターフェイス (AUI)
機 器 を通 じた送 受 信 機 との通 信 に使 用 され、通 常 引 き込 みケーブルとしてよく知 られています。

整
整 数 変 数 (Cicode)
通 常 、2,147,483,648～ 2,147,483,647 の値 をとる4バイト (32ビット )のデータ型 。

整 数 変 数 (I/Oデバイス)
通 常 、-32,768～ 2,147,483,647の値 をとる2バイト のデータ型 であり、数 字 (温 度 や圧 力 ) の保 存 に使 用 しま
す。実 数 (浮 動 小 数 点 )、バイト 、2進 コード で表 した10進 数 などの数 字 変 数 をサポート するI/Oデバイスも
あります。

時
時 間 で表 示 されるイベント データ
イベント 番 号 で表 示 されるイベント ト レンド データベースの表 示 の代 わりに、時 系 列 によるイベント ト レンド
を表 示 できます。イベント ト レンド を時 刻 で表 示 する場 合 、ト レンド グラフには開 始 時 間 および終 了 時 間
が含 まれます。オペレータはイベント がト リガされた時 間 およびイベント 間 の経 過 時 間 の両 方 を表 示 できま
す。このデータはその後 、周 期 ト レンド として同 じグラフ上 に表 示 できます。

最
最大要求長未満
単 一 の要 求 でI/Oデバイスから読 み取 ることができるデータ ビット の最 大 数 。例 えば、最 大 要 求 長 が2048の
場 合 、読 み込 みできる整 数 の最 大 数 は次 のようになります。2048/16 = 128.

491
用語集

最 小 アップデート レート
事 前 定 義 された期 間 であり、その後 タグ更 新 値 の通 知 を登 録 クライアント に送 信

有
有 効 な VQT
タグ拡 張 子 に「正 常 」品 質 があった最 後 のフィールド データ。

模
模擬体
グラフィックス ページをまとめてセット にし、製 造 システムを視 覚 的 に表 現 したもの。.

権
権限
プロジェクト 内 のシステム 要 素 に適 用 されるアクセスのレベルを指 します。一 致 する権 限 を持 つ役 割 を割 り
当 てられたユーザーは、これをコント ロールできます。

正
正 規 のタグ参 照
タグ名 、要 素 名 、項 目 名 を使 用 して、タグ データを参 照 。

正 規 分 布 に従 う。
釣 鐘 曲 線 とも呼 ばれますが、正 規 分 布 は最 もよく知 られた広 く適 用 される分 布 です。この分 布 は、対 照
的 であり、広 く一 般 的 に偶 然 の法 則 を表 現 しています。領 域 の68.27% が±1シグマの間 にあり、95.45%
が±2シグマの間 にあり、99.73%が±3シグマにあります。ゆがみ度 および尖 度 の値 は正 規 性 の定 量 的 尺 度
の計 算 に使 用 されます。分 布 の作 成 に少 なくとも20のサンプルが使 用 されるとします。適 切 な経 験 則 で
は、-1.0=ゆがみ度 =1.0 2=尖 度 =4の場 合 、正 規 分 布 のデータとされます。

汎
汎 用 プロト コル
ディスクI/Oデバイスによりサポート される疑 似 プロト コルで、ディスク データを表 現 する便 利 な方 法 を提 供 しま
す。汎 用 プロト コルは実 際 のプロト コルではありません (物 理 的 なI/O デバイスとは通 信 しません)。

知
知 識 ベース
http://www.citect.comで入 手 でき、定 期 的 に更 新 されている 標 準 技 術 情 報 よりさらに高 度 な技 術 情 報
について提 供 しています。

492
 用語集

空
空 の値
変 数 が初 期 化 されていない (値 が割 り当 てられていない) ことを示 します。空 のバリアント は0のVarTypeを
返 します。長 さがゼロの文 字 列 (「」) を含 む変 数 は空 ではなく、0の値 を持 つ数 字 変 数 でもありません。

符
符 号 なし整 数 変 数 (I/Oデバイス)
0～ 65,535の範 囲 の整 数 を表 現 する2バイト (16ビット ) のデータ型 。INI型 が使 用 できるすべてのI/Oデバイス
でサポート されます。つまり、あらゆる整 数 を符 号 なし整 数 として定 義 し、正 数 範 囲 を広 げることができま
す。

置
置換
スーパー ジニー置 換 は、データ タイプ( オプション) とスーパー ジニー作 成 時 のオブジェクト 、またはオブジェクト
プロパティのグループの定 義 に使 用 するアソシエーションで構 成 されています。

表
表 示 専 用 クライアント
ランタイム システムにのみアクセスするマネージャによって設 定 されたコンピュータ。システムの制 御 はできませ
んが、データ監 視 にはフル アクセスできます。

表示期間
ト レンド データをト レンド ページに表 示 する速 度 を定 義 します。

言
言 語 データベース
プロジェクト をコンパイルした際 、2つのフィールド からなる言 語 データベース (dBASE フォーマット ) が作 成
されます。ネイティブおよびローカル。言 語 変 更 識 別 子 でマークされた一 つのテキスト は自 動 的 に [ネイティ
ブ] フィールド に入 ります。言 語 データベースを開 き、翻 訳 後 のテキスト を [ローカル] フィールド に入 力 できま
す。

通
通 信 ポート
シリアル データを送 受 信 するPCポート (COMポート とも呼 ばれる)。

通 信 リンク
コンピュータと周 辺 機 器 を接 続 し、データ転 送 ができるようにします。通 信 リンクは、ネット ワーク、モデム、ま
たは単 にケーブルにできます。.

493
用語集

非
非 正 規 のタグ参 照
タグ名 だけを使 用 してタグ データを参 照 。

高
高 機 能 アラーム
Cicodeの式 がtrueに変 わった結 果 、ト リガされます。高 機 能 アラームは、その他 のタイプのアラームではアラー
ム機 能 を果 たせない場 合 にのみ使 用 されます。高 機 能 アラームを多 く設 定 し過 ぎた場 合 には、システム
パフォーマンスに影 響 が及 ぶ可 能 性 があります。

494
 目次

目次
A
AlmQuery CtAPI 関 数 147
AN,定 義 済 み 29
ANSI 文 字 コード 60
ASCII 文 字 コード 60
C
Cicodeファイル,事 前 定 義 41
citect.ini のコメント 24
CitectSCADA API 97
CSV_Alarms_Ack 関 数 162
CSV_Alarms_AckHardware 関 数 162
CSV_Alarms_AckPage 関 数 162
CSV_Alarms_AckRec 関 数 163
CSV_Alarms_AdvFilter 関 数 163
CSV_Alarms_AdvFilterConfig 関 数 164
CSV_Alarms_AdvFilterQuery 関 数 164
CSV_Alarms_AdvFilterSetDateTime 関 数 166
CSV_Alarms_CheckSound 関 数 166
CSV_Alarms_ClearGroupFilter 関 数 167
CSV_Alarms_Disable 関 数 167
CSV_Alarms_DisableRec 関 数 168
CSV_Alarms_DspGroupFilter 関 数 168
CSV_Alarms_DspGroupList 関 数 168
CSV_Alarms_DspInfo 関 数 169
CSV_Alarms_DspInfoRec 関 数 169
CSV_Alarms_DspLast 関 数 169
CSV_Alarms_Enable 関 数 170
CSV_Alarms_EnableRec 関 数 171
CSV_Alarms_GetAckPrivilege() 関 数 171
CSV_Alarms_GetDisablePrivilege() 関 数 171
CSV_Alarms_GetGroupFilter 関 数 171
CSV_Alarms_GetGroupFilterID 関 数 172
CSV_Alarms_GetUniqueGroupName 関 数 173
CSV_Alarms_GroupAdd 関 数 173
CSV_Alarms_GroupConfig() 関 数 174
CSV_Alarms_GroupEdit 関 数 174
CSV_Alarms_GroupFilter 関 数 175
CSV_Alarms_GroupRemove 関 数 174

495
目次

CSV_Alarms_GroupSelect 関 数 176
CSV_Alarms_GroupsInit() 関 数 177
CSV_Alarms_Help 関 数 177
CSV_Alarms_HelpRec 関 数 177
CSV_Alarms_ListHeading 関 数 178
CSV_Alarms_ListHeadingFont() 関 数 178
CSV_Alarms_PopupMenu 関 数 178
CSV_Alarms_Silence() 関 数 180
CSV_Alarms_Sound() 関 数 179
CSV_Alarms_SoundActive() 関 数 180
CSV_DB_BOF 関 数 180
CSV_DB_Close 関 数 180
CSV_DB_EOF() 関 数 180
CSV_DB_Execute 関 数 181
CSV_DB_GetExecuteError 関 数 182
CSV_DB_GetFieldCount 関 数 183
CSV_DB_GetFieldIndex 関 数 183
CSV_DB_GetFieldName 関 数 183
CSV_DB_GetFieldText 関 数 183
CSV_DB_GetRowCount 関 数 184
CSV_DB_GetRowCurrent 関 数 184
CSV_DB_GetRowFieldText 関 数 185
CSV_DB_MoveFirst 関 数 185
CSV_DB_MoveLast 関 数 185
CSV_DB_MoveNext 関 数 185
CSV_DB_MoveOffset 関 数 186
CSV_DB_MovePrev 関 数 186
CSV_DB_StandbyConnectionActive 関 数 186
CSV_DB_StrToSQL 関 数 186
CSV_Display_Logo 関 数 187
CSV_Display_ServicePack() 関 数 187
CSV_Display_Title() 関 数 187
CSV_Display_Version() 関 数 188
CSV_File_Display 関 数 188
CSV_File_Print 関 数 189
CSV_File_Save 関 数 189
CSV_Form_Centre 関 数 189
CSV_Form_Login() 関 数 190
CSV_Form_NumPad 関 数 190
CSV_Form_Position 関 数 191
CSV_Form_Shutdown() 関 数 191
CSV_Form_UserCreate() 関 数 191
CSV_Form_UserPassword() 関 数 192
CSV_Include citect.ini パラメータ 157

496
 目次

CSV_Include 関 数 157
CSV_ListBox_AddItem 関 数 192
CSV_ListBox_Clear 関 数 193
CSV_ListBox_Create() 関 数 193
CSV_ListBox_Destroy 関 数 193
CSV_ListBox_GetCategory 関 数 194
CSV_ListBox_GetItem 関 数 194
CSV_ListBox_GetItemID 関 数 195
CSV_ListBox_GetSelectedItem 関 数 195
CSV_ListBox_GetSelectedItemCategory 関 数 195
CSV_ListBox_GetSelectedItemID 関 数 196
CSV_ListBox_GetTagComment 関 数 196
CSV_ListBox_GetTagDescFromTag 関 数 196
CSV_ListBox_GetTagName 関 数 196
CSV_ListBox_GetTrendDescFromTag() 関 数 197
CSV_ListBox_Hide 関 数 198
CSV_ListBox_RemoveItem 関 数 197
CSV_ListBox_SelectCategories 関 数 198
CSV_ListBox_SelectTags() 関 数 198
CSV_ListBox_SelectTrends() 関 数 199
CSV_ListBox_SetText 関 数 199
CSV_ListBox_Show (指 定 のカテゴリを持 つ項 目 のみを表 示 するフィルタ リスト )関 数 199
CSV_ListBox_TagFormat 関 数 200
CSV_ListBox_Visible 関 数 200
CSV_Math_RoundDown 関 数 201
CSV_Math_Truncate 関 数 201
CSV_MenuConfig_Close() 関 数 202
CSV_MenuConfig_LoadDflt() 関 数 202
CSV_MenuConfig_UserPages() 関 数 202
CSV_MessageBox 関 数 202
CSV_Misc_CheckNumPadValue 関 数 205
CSV_Misc_IntRange 関 数 205
CSV_Misc_MouseOver 関 数 206
CSV_MM_BackEmpty() 関 数 206
CSV_MM_ConfigInit() 関 数 207
CSV_MM_FwdEmpty() 関 数 207
CSV_MM_GetMonitor() 関 数 207
CSV_MM_GetMonitors() 関 数 207
CSV_MM_GetMouseX関 数 208
CSV_MM_GetMouseY関 数 208
CSV_MM_GetOffset関 数 208
CSV_MM_GetScreenWidth() 関 数 208
CSV_MM_ListLastPages関 数 209
CSV_MM_MonitorFromPoint関 数 209

497
目次

CSV_MM_MonitorFromWindow関 数 209
CSV_MM_MonitorGoto関 数 210
CSV_MM_NextEmpty() 関 数 210
CSV_MM_PageDisplay関 数 210
CSV_MM_PageLast関 数 211
CSV_MM_PageNext() 関 数 211
CSV_MM_PagePrev() 関 数 212
CSV_MM_PagesInit() 関 数 212
CSV_MM_PreviousEmpty() 関 数 212
CSV_MM_StoreLastPage関 数 212
CSV_MM_WinDrag() 関 数 213
CSV_MM_WinDragEnd() 関 数 213
CSV_MM_WinFree() 関 数 213
CSV_MM_WinNewAt関 数 213
CSV_MM_WinPopup関 数 214
CSV_MM_WinTitle関 数 215
CSV_Nav_Alarms() 関 数 215
CSV_Nav_AlarmsDisabled() function 215
CSV_Nav_AlarmsHardware() 関 数 216
CSV_Nav_AlarmsSummary() 関 数 216
CSV_Nav_CloseWindow() 関 数 216
CSV_Nav_DisableMenuItem関 数 216
CSV_Nav_DisplayMenuBar関 数 217
CSV_Nav_DisplayPopupMenu関 数 218
CSV_Nav_File関 数 218
CSV_Nav_GetEngToolsPrivilege() 関 数 219
CSV_Nav_Help() 関 数 219
CSV_Nav_Home() 関 数 219
CSV_Nav_Login() 関 数 219
CSV_Nav_LoginMenu() 関 数 219
CSV_Nav_MenuBar_MenuClick関 数 220
CSV_Nav_Network() 関 数 220
CSV_Nav_NetworkBtnEnabled() 関 数 220
CSV_Nav_PageExists関 数 221
CSV_Nav_PagePrint() 関 数 221
CSV_Nav_Parent() 関 数 221
CSV_Nav_ParentBtnEnabled() 関 数 221
CSV_Nav_Report() 関 数 222
CSV_Nav_ReportBtnEnabled() 関 数 222
CSV_Nav_ReportMenu関 数 222
CSV_Nav_TickMenuItem関 数 224
CSV_Nav_Tools() 関 数 222
CSV_Nav_ToolsBtnEnabled() 関 数 223
CSV_Nav_ToolsMenu() 関 数 223

498
 目次

CSV_Nav_Trend() 関 数 223
CSV_Nav_TrendBtnEnabled() 関 数 223
CSV_Nav_TrendMenu() 関 数 224
CSV_Nav_TrendX() 関 数 224
CSV_Sec_ShowLoginMenu関 数 225
CSV_String_GetField関 数 225
CSV_String_GetLines関 数 226
CSV_String_Replace関 数 226
CSV_Tag_Debug 機 能 227
CSV_Trend_AutoScale関 数 227
CSV_Trend_DspGroupList関 数 228
CSV_Trend_DspGroup関 数 227
CSV_Trend_DspPopupMenu関 数 228
CSV_Trend_DspScaleRange関 数 229
CSV_Trend_DspTrendText関 数 229
CSV_Trend_GetCursorPos関 数 230
CSV_Trend_GetCursorTypeStr関 数 230
CSV_Trend_GetCursorValueStr関 数 230
CSV_Trend_GetDate関 数 235
CSV_Trend_GetGroup関 数 231
CSV_Trend_GetMode関 数 231
CSV_Trend_GetPenFocus関 数 232
CSV_Trend_GetPen関 数 232
CSV_Trend_GetSettings関 数 232
CSV_Trend_GetSpan関 数 234
CSV_Trend_GetTime関 数 234
CSV_Trend_GroupConfig() 関 数 235
CSV_Trend_Page関 数 235
CSV_Trend_Popup関 数 236
CSV_Trend_ScaleDigital関 数 237
CSV_Trend_SelectGroup関 数 237
CSV_Trend_SelectPen関 数 238
CSV_Trend_SetCursor関 数 238
CSV_Trend_SetDateTime関 数 239
CSV_Trend_SetDate関 数 238
CSV_Trend_SetPens関 数 239
CSV_Trend_SetRange関 数 239
CSV_Trend_SetScale関 数 240
CSV_Trend_SetSpan関 数 240
CSV_Trend_SetTimebase関 数 241
CSV_Trend_SetTime関 数 241
CSV_Trend_UpdatePens関 数 241
CSV_Trend_Win関 数 242
CSV_TrendX_AddVariable 関 数 243

499
目次

CSV_TrendX_AgeTrends() 関 数 244
CSV_TrendX_ClearTrend 関 数 244
CSV_TrendX_Close 関 数 244
CSV_TrendX_DeletePen() 関 数 245
CSV_TrendX_Display() 関 数 245
CSV_TrendX_DspPopupMenu 関 数 245
CSV_TrendX_GenericToTagStr 関 数 246
CSV_TrendX_GetComment 関 数 246
CSV_TrendX_GetDuration() 関 数 247
CSV_TrendX_GetSamplePeriod 関 数 247
CSV_TrendX_GetScale 関 数 248
CSV_TrendX_GetTrendName 関 数 248
CSV_TrendX_GetTrigger 関 数 249
CSV_TrendX_GetVal 関 数 249
CSV_TrendX_InitClient() 関 数 249
CSV_TrendX_InitSrvr() 関 数 249
CSV_TrendX_MapTrendTags() 関 数 250
CSV_TrendX_RefreshTrendPage 関 数 250
CSV_TrendX_SetDuration 関 数 250-251
CSV_TrendX_SetPen() 関 数 251
CSV_TrendX_SetSamplePeriod 関 数 251
CSV_TrendX_SetScale 関 数 252
CSV_TrendX_TagSelect 関 数 252
CSV_TrendX_TagSelectFrmCursor() 関 数 253
CSV_TrendX_TagToGeneric 関 数 253
CSV_TrendX_TrendTimeout 関 数 253
CSV_WinUtl_DestroyCursor() 関 数 253
CSV_WinUtl_GetColourRes() 関 数 254
CSV_WinUtl_GetCpuUsage 関 数 254
CSV_WinUtl_GetSystemDir() 関 数 254
CSV_WinUtl_GetTotalCpuUsage() 関 数 254
CSV_WinUtl_GetWindowsDir() 関 数 254
CSV_WinUtl_GetWinMode() 関 数 255
CSV_WinUtl_LoadCursor 関 数 255
CSV_WinUtl_LockWindowUpdate 関 数 255
CSV_WinUtl_NormalCursor 関 数 255
CSV_WinUtl_ShellExec 関 数 256
CSV_WinUtl_UpdateTotalCpuUsage() 関 数 258
CSV_WinUtl_WaitCursor 関 数 258
CtAPIAlarm CtAPI 関 数 153
CtAPITrend CtAPI 関 数 155
CTAPIエラー コード 101
ctCancelIO CtAPI 関 数 106
CtCicode CtAPI 関 数 107

500
 目次

ctClientCreate CtAPI 関 数 109

CtClientDestroy CtAPI 関 数 110
ctClose CtAPI 関 数 111
ctCloseEx CtAPI 関 数 112
ctEngToRaw CtAPI 関 数 113
ctFindClose CtAPI 関 数 114
ctFindFirst CtAPI 関 数 115
ctFindFirstEx CtAPI 関 数 118
ctFindNext CtAPI 関 数 121
ctFindPrev CtAPI 関 数 122
ctFindScroll CtAPI 関 数 123
ctGetOverlappedResult CtAPI 関 数 125
ctGetProperty CtAPI 関 数 126
ctHasOverlappedIoCompleted CtAPI 関 数 129
ctListAdd CtAPI 関 数 129
ctListAddEx CtAPI 関 数 131
ctListDelete CtAPI 関 数 132
ctListEvent CtAPI 関 数 133
ctListFree CtAPI 関 数 134
ctListRead CtAPI 関 数 135
ctOpen CtAPI 関 数 136
CtOpenEx CtAPI 関 数 138
ctRawToEng CtAPI 関 数 140
ctStrToPoint CtAPI 関 数 143
ctTagGetProperty CtAPI 関 数 141
ctTagRead CtAPI 関 数 100, 143
ctTagToPoint CtAPI関 数 145
ctTagWrite CtAPI関 数 145
ctTagWriteEx CtAPI 関 数 146
I
I/O デバイス データ型 の仕 様 28
I/Oポイント カウント 98
P
PropertiesAddMetadata 332
S
SV_Form_UserEdit() 関 数 192
SV_Trend_GetSettings関 数 233
SV_TrendX_GenericToTag 関 数 246
SV_TrendX_GetCursor 関 数 247
T
TrnQuery CtAPI 関 数 150

501
目次

ア
アニメーション基 準 点 (AN) 29
アラーム サマリー フィールド 75
アラーム表 示 フィールド 72
エ
エラー 79
一 般 ド ライバ 85
キ
キーボード キー コード ,事 前 定 義 43
キーボード キー,事 前 定 義 35
グ
グラフィック ビルダー：エラー処 理 260
グラフィックス ビルダー
関 数 カテゴリ 262
グラフィックス ビルダー オート メーション インターフェース関 数
Attribute3dEffectDepth 345
Attribute3dEffects 344
AttributeAN 346
AttributeBaseCoordinates 347
AttributeClass 348
AttributeCornerRadius 348
AttributeEllipseStyle 349
AttributeEndAngle 350
AttributeExtentX 351
AttributeExtentY 352
AttributeFillColour 352
AttributeFillOffColourEx 353
AttributeFillOnColourEx 354
AttributeGradientMode 355
AttributeGradientOffColour 356
AttributeGradientOnColour 356
AttributeHiLightColour 357
AttributeHiLightOffColourEx 358
AttributeHiLightOnColourEx 359
AttributeLineColour 360
AttributeLineOffColourEx 361
AttributeLineOnColourEx 362
AttributeLineStyle 363
AttributeLineWidth 364
AttributeLoLightColour 365
AttributeLoLightOffColourEx 366
AttributeLoLightOnColourEx 367
AttributeNodeCoordinatesFirst 368

502
 目次

AttributeNodeCoordinatesNext 368
AttributePolygonOpen 369
AttributeRectangleStyle 370
AttributeSetFill 371
AttributeShadowColour 372
AttributeShadowOffColourEx 373
AttributeShadowOnColourEx 374
AttributeStartAngle 375
AttributeText 453
AttributeTextColour 454
AttributeTextFont 456
AttributeTextFontSize 457
AttributeTextJustification 458
AttributeTextOffColourEx 455
AttributeTextOnColourEx 456
AttributeTextStyle 459
AttributeTransformationMatrixGet 376
AttributeTransformationMatrixPut 377
AttributeX 378
AttributeY 379
BrokenLink 270
BrokenLinkCancelEnabled 337
ClipboardCopy 338
ClipboardCut 338
ClipboardPaste 339
ConvertToBitmap 339
DrawButton 379
DrawCicodeObject 380
DrawEllipse 381
DrawLine 382
DrawNumber 383
DrawPipeEnd 383
DrawPipeSection 384
DrawPipeStart 385
DrawPolygonEnd 386
DrawPolygonLine 386
DrawPolygonStart 387
DrawRectangle 388
DrawSymbolSet 389
DrawText 389
DrawTrend 390
LibraryObjectFirstProperty 321
LibraryObjectFirstPropertyEx 322
LibraryObjectHotspotGet 323

503
目次

LibraryObjectHotspotPut 324
LibraryObjectName 324
LibraryObjectNextProperty 325
LibraryObjectNextPropertyEx 326
LibraryObjectPlace 327
LibraryObjectPlaceEx 328
LibraryObjectPutProperty 329
LibraryShowPasteDialog 330
LibSelectionHooksEnabled 330
OptionDisplayPropertiesOnNew 391
OptionSnapToGrid 392
OptionSnapToGuidelines 393
PageActiveWindowHandle 396
PageAppearanceGet 422-423
PageAppearanceGetEx 424
PageArea 426
PageAssociationDefault 427
PageAssociationDescription 427
PageAssociationName 428
PageAssociationValueOnError 428
PageClose 397
PageClusterInherit 428
PageClusterName 429
PageConvertWindowCoordinates 397
PageDelete 398
PageDeleteAssociation 430
PageDeleteEx 398
PageDeleteObject 399
PageDeleteTemplate 400
PageDescription 431
PageEnvironmentAdd 432
PageEnvironmentFirst 432
PageEnvironmentNext 433
PageEnvironmentremove 434
PageGroupSelectedObjects 401
PageImport 401
PageLogDevice 434
PageName 435
PageNew 402
PageNewEx 403
PageNewLibrary 404
PageNewTemplate 405
PageNext 437
PageOpen 406

504
 目次

PageOpenEx 407
PageOpenTemplate 408
PagePrevious 437
PagePrint 409
PageSave 409
PageSaveAs 410
PageSaveAsEx 410
PageScanTime 438
PageSelect 411
PageSelectAssociationByName 439
PageSelectFirst 412
PageSelectFirstAssociation 439
PageSelectFirstObject 412
PageSelectFirstObjectEx 413
PageSelectFirstObjectInGenie 413
PageSelectFirstObjectInGroup 414
PageSelectNext 414
PageSelectNextAssociation 440
PageSelectNextObject 415
PageSelectNextObjectEx 416
PageSelectNextObjectInGenie 416
PageSelectNextObjectInGroup 417
PageSelectObject 417
PageSelectObjectAdd 418
PageTemplateSelectFirstObject 418
PageTemplateSelectNextObject 419
PageThumbnailToClipboard 419
PageTitle 440
PageUngroupSelectedObject 420
PageUpdated 420
PasteGenie 270
PasteSymbol 271
PositionAt 264
PositionBringForwards 265
PositionBringToFront 265
PositionMirrorHorizontal 266
PositionMirrorVertical 266
PositionRotate 267
PositionSendBackwards 268
PositionSendToBack 268
ProjectButtonGet 279
ProjectButtonPut 280
ProjectChange 271
ProjectCompile 442

505
目次

ProjectFirst 443
ProjectFirstInclude 444
ProjectLibraries 447
ProjectNext 445
ProjectNextInclude 446
ProjectPackDatabase 446
ProjectSelected 448
ProjectUpdatePages 449
ProjectUpgrade 450
ProjectUpgradeAll 451
PropertiesAccessDisableGet 276
PropertiesAccessDisablePut 277
PropertiesAccessGeneralGet 277
PropertiesAccessGeneralPut 278
PropertiesCicodeObjectGet 281
PropertiesCicodeObjectPut 282
PropertiesDeleteMetadata 333
PropertiesDisplayValueGet 282
PropertiesDisplayValuePut 284
PropertiesDisplayValueTextGet 285
PropertiesDisplayValueTextPut 286
PropertiesFillColourColourGet 286, 290
PropertiesFillColourColourGetEx 287
PropertiesFillColourColourPut 288, 292
PropertiesFillColourColourPutEx 289
PropertiesFillLevelGet 293
PropertiesFillLevelGetEx 294
PropertiesFillLevelPut 296
PropertiesFillLevelPutEx 297
PropertiesInputKeyboardGet 298
PropertiesInputKeyboardPut 299
PropertiesInputTouchGet 300
PropertiesInputTouchPut 301
PropertiesMetadataName 333
PropertiesMetadataValue 334
PropertiesSelectFirstMetadata 335
PropertiesSelectMetadataByName 335
PropertiesSelectNextMetadata 336
PropertiesShowDialog 301
PropertiesSymbolSetGet 302
PropertiesSymbolSetPut 303
PropertiesSymbolSetSymbolGet 304
PropertiesSymbolSetSymbolPut 305
PropertiesTransCentreOffsetExpressGet 307

506
 目次

PropertiesTransCentreOffsetExpressPut 307
PropertiesTransformationGet 308
PropertiesTransformationPut 310
PropertiesTrendGet 312
PropertiesTrendGetEx 313
PropertiesTrendPut 316
PropertiesTrendPutEx 317
PropertｙVisibility 320
Quit 339
SelectionEventEnabled 339
SwapObject 272
UnLockObject 340
Visible 272
イベント 関 数 270
オート メーション イベント 262
オブジェクト の描 画 およびプロパティ関 数 341
オプション関 数 391
その他 の関 数 337
プロジェクト 関 数 441
ライブラリ関 数 320
動 的 なプロパティ関 数 273
動 的 プロパティ関 数 452
整 列 と位 置 の関 数 263
特 定 の関 数 272
選択 271
グラフィックス ビルダー オート メーション インターフェース関 数 ：ページプロパティ関 数 421
グラフィックス ビルダー オート メーション インターフェース関 数 ：ページ関 数 394
グラフィックス ビルダー：オート メーション 259
グラフィックスの仕 様 26
コ
コマンド
事前定義 34
コマンド フィールド 77
シ
システム コマンド (定 義 済 み) 34
タ
タグ関 数 100
デ
データ
CtAPI を使 用 した読 み取 り 99
デバイス
事前定義 40
デバッグのト レース 103

507
目次

テ
テンプレート
事前定義 30
ド
ド ライバ
一 般 エラー 85
ド ライバ エラー, 標 準 92
ネ
ネット ワーク
パラメータの使 用 15
パ
パラメータ 13
ネット ワーク上 15
パラメータ ダイアログ ボックス 15
パラメータの設 定 13
ビ
ビット シフト 101
フ
ファイル
Cicode,事 前 定 義 41
フィールド
アラーム サマリー 75
アラーム表 示 72
コマンド 77
フォント
事前定義 38
プ
プロジェクト
仕様 26
プロト コル一 般 エラー 79
ラ
ラベル
事前定義 53
リ
リスト 関 数 100
一
一 般 エラー 79
一 般 ド ライバ エラー 85
事
事前定義 38
キーボード キー 35

508
 目次

キーボード キー コード 43
コマンド 34
デバイス 40
ラベル 53
文 字 セット 36
色 コード および名 前 42
事 前 定 義 のテンプレート 30
仕
仕様
I/O デバイス データ型 28
グラフィックス 26
プロジェクト 26
同
同 期 操 作 , API 98
定
定 義 済 みAN 29
文
文 字 コード 60
文 字 セット
事前定義 36
時
時点定義
Cicodeファイル 41
標
標 準 ド ライバ エラー 92
色
色 コード ,事 前 定 義 42
色 の名 前 ,事 前 定 義 42
配
配 列 サポート 101

509
目次

510