ole モジュール

    var {ActiveX} = require("ole");
    var excel = new ActiveX("Excel.Application");
    excel.Visible = true;

    var ActiveX = require("ole").ActiveX;
    var excel = new ActiveX("Excel.Application");
    excel.Visible = true;

  var {ActiveX} = require("ole");
  var {AxEnum} = require("ole");
  var {AxEventSink} = require("ole");
  var {AxVar} = require("ole");
  または
  var {ActiveX, AxEnum, AxEventSink, AxVar} = require("ole");

ActiveX クラス ...

className プロパティ ActiveX...

activex.className : String [ReadOnly]

常に"ActiveX"を返します。

var {ActiveX} = require("ole");

var obj = new ActiveX("Excel.Application");
alert( obj.className );  //"ActiveX"

members プロパティ ActiveX...

activex.members : Object

関数の情報文字列
  activex.members[func] => "[id(funcId)] function( argInf, ... ) : retType"
    funcId == activex.id(func)
    argInf = [属性] 引数タイプ 引数名
             [in]  argType argname     //入力引数
             [out] argType argname     //出力引数
             [in,out] argType argname  //入出力引数

プロパティの情報文字列
  activex.members[prop] => "[id(propId)] get( argInf, ... ) : retType"
                           "[id(propId)] set( argInf, ..., [in] refType rhs )"
    propId == activex.id(prop)
    argInf = [属性] 引数タイプ 引数名

引数・返値タイプ
  基本型
    char   : Integer
    short  : Integer
    USHORT : Integer
    long   : Integer/Number
    ULONG  : Integer/Number
    float  : Number
    double : Number
    DATE   : Date
    BSTR   : String
    VARIANT_BOOL : Boolean
  ActiveXオブジェクト
    IDispatch* : ActiveX
    Typename*  : ActiveX  (TypenameはIDLファイルを参照)
  VB/COMの汎用型
    VARIANT : AxVar
  配列型
    SAFEARRAY(type) : type[]
  列挙型
    Enumname : Integer/Number  (EnumnameはIDLファイルを参照)
  

var {ActiveX} = require("ole");

var excel = new ActiveX('Excel.Application');

for (var m in excel.members) {
  print(m + " => " + excel.members[m]);
}
/*
Application => [id(148)] get() : Application*
Creator => [id(149)] get() : XlCreator
Parent => [id(150)] get() : Application*
ActiveCell => [id(305)] get() : Range*
ActiveChart => [id(183)] get() : Chart*
ActivePrinter => [id(306)] get() : BSTR
[id(306)] set( [in] BSTR rhs )
  ・
  ・
CentimetersToPoints => [id(1086)] function( [in] double Centimeters ) : double
CheckSpelling => [id(505)] function( [in] BSTR Word, [in,optional] CustomDictionary, [in,optional] IgnoreUppercase ) : VARIANT_BOOL
  ・
  ・
*/

Property プロパティ ActiveX...

activex.Property

var {ActiveX} = require("ole");

// ExcelオブジェクトのVisibleプロパティ
var excel = new ActiveX('Excel.Application');
print(excel.Visible); // 最初は非表示のfalse
excel.Visible = true;   // Excelを表示

$Property(...).$, Property(...).$ プロパティ ActiveX...

activex.$Property([arg, arg2, ...]).$
activex.Property(arg[, arg2, ...]).$

var {ActiveX} = require("ole");

// ExcelのActiveSheetセルに値をセット
var excel = new ActiveX('Excel.Application');
excel.Visible = true;   // Excelを表示
excel.Workbooks.Add();
var activesheet = excel.ActiveSheet;
var cells = activesheet.Cells;
cells(2,3).Value = "Hello"; // cells(2,3).$.Value = "Hello";
cells(3,3).Value = cells(2,3).Value + " JavaScript!"; // cells(3,3).$.Value = cells(2,3).$.Value + " JavaScript!";

ActiveX コンストラクター ActiveX...

new ActiveX( id ) : ActiveX
new ActiveX( dlname, clsid ) : ActiveX

new AciveXObject( id ) : ActiveX
new AciveXObject( dlname, clsid ) : ActiveX

プログラムID または クラスIDを指定します。

AciveXオブジェクトのサーバーとなるdllプログラム名を指定します。

クラスIDを指定します。

var {ActiveX} = require("ole");

var excel = new ActiveX('Excel.Application');
// var obj = new ActiveXObject('Excel.Application');

close 関数 ActiveX...

activex.close()

exec, at 関数 ActiveX...

activex.exec( name[,args...])
activex.at( name[,args...])

var {ActiveX} = require("ole");

var excel = new ActiveX('Excel.Application'); // var obj = new ActiveXObject('Excel.Application');
excel.set('Visible',true);    // プロパティ値設定

var workbooks = excel.get('Workbooks'); // プロパティ値取得

workbooks.exec('Open','D:\\Work\\Book1.xls'); // メソッド関数実行

get, geta 関数 ActiveX...

activex.get( name[,args...])
activex.geta( name[,args...])

get_Property 関数 ActiveX...

activex.get_Property([args, ...])

var {ActiveX} = require("ole");

// ExcelオブジェクトのVisibleプロパティ
var excel = new ActiveX('Excel.Application');
print(excel.get_Visible()); // 最初は非表示のfalse
excel.set_Visible(true);   // Excelを表示

id 関数 ActiveX...

activex.id( name ) : Integer

set, seta 関数 ActiveX...

activex.set( name[,args...], value)
activex.seta( name[,args...], value)

set_Property 関数 ActiveX...

activex.set_Property([args...], value)

toString 関数 ActiveX...

activex.toString() : String

cancelWaitEvents クラス関数 ActiveX...

ActiveX.cancelWaitEvents()

var {ActiveX} = require("ole");

var excel = new ActiveX("Excel.Application");
excel.Visible = true;

var cnt = 0;
var eventSink = ActiveX.newEventSink(excel); // =ActiveX.newEventSink(excel,"AppEvents");
eventSink.setHandler("NewWorkbook",
 function(wb) { // Workbookが新規に作成すると呼ばれる
   // wb : Workbook
   alert( "new Workbook" );
   cnt++;
   if (cnt==3) ActiveX.cancelWaitEvents(); // 3個新しいWorkbookが作成されたら、イベント待ちを中止
 }
);

ActiveX.waitEvents(); // イベント待ち
                //すべてのAxEventSinkオブジェクトがunAdvise()するか、
                // ActiveX.cancelWaitEvents()が実行されたら、このイベント待ちを終了する

getObject クラス関数 ActiveX...

ActiveX.getObject( pathname ) : ActiveX
ActiveX.getObject( id ) : ActiveX

var {ActiveX} = require("ole");

var book = ActiveX.getObject("D:/Work/Book2.xls"); //Book2.xlsがロードされていなければロードされる
var excel = book.Application;

excel.Windows(book.name).Visible = true;
excel.Visible = true;
var cell = excel.Range('B3');
print( cell.Value );

is クラス関数 ActiveX...

ActiveX.is( obj )

loadConsts クラス関数 ActiveX...

consts = ActiveX.loadConsts( activexobj[, enum_name] ) : Object

  consts = {};
  for (var enm in activexobjのタイプライブラリーに含まれる列挙名) {
    consts[enm] = ActiveX.loadConsts(activexobj,enm);
  }
  // 定数の取得方法 : consts.列挙名.定数名

var {ActiveX} = require("ole");

var excel = new ActiveX("Excel.Application");
var consts = ActiveX.loadConsts(excel);
alert( consts.xlDialogOpen ); // 1

var consts_RowCol = ActiveX.loadConsts(excel,"XlRowCol");
alert( consts_RowCol.xlColumns ); // 2

var consts = ActiveX.loadConsts(excel,"*");
alert( consts.XlRowCol.xlColumns ); // 2

newEventSink クラス関数 ActiveX...

ActiveX.newEventSink( activexobj, [event_interfacename] ) : AxEventSink

var {ActiveX} = require("ole");

var excel = new ActiveX("Excel.Application");
excel.Visible = true;

var cnt = 0;
var eventSink = ActiveX.newEventSink(excel); // =ActiveX.newEventSink(excel,"AppEvents");
eventSink.setHandler("NewWorkbook",
 function(wb) { // Workbookが新規に作成すると呼ばれる
   // wb : Workbook
   alert( "new Workbook" );
   cnt++;
   if (cnt==3) eventSink.unAdvise(); // 3個新しいWorkbookが作成されたら、eventSinkでのイベント待ちをoffにする
 }
);

ActiveX.waitEvents(); // イベント待ち
                //すべてのAxEventSinkオブジェクトがunAdvise()するか、
                // ActiveX.cancelWaitEvents()が実行されたら、このイベント待ちを終了する

showHelp クラス関数 ActiveX...

ActiveX.showHelp( activexobj )

var {ActiveX} = require("ole");

var excel = new ActiveX("Excel.Application");
ActiveX.showHelp(excel);

waitEvents クラス関数 ActiveX...

ActiveX.waitEvents( [wait_time] ) : Boolean

var {ActiveX} = require("ole");

var excel = new ActiveX("Excel.Application");
excel.Visible = true;

var cnt = 0;
var eventSink = ActiveX.newEventSink(excel); // =ActiveX.newEventSink(excel,"AppEvents");
eventSink.setHandler("NewWorkbook",
 function(wb) { // Workbookが新規に作成すると呼ばれる
   // wb : Workbook
   alert( "new Workbook" );
   cnt++;
   if (cnt==3) eventSink.unAdvise(); // 3個新しいWorkbookが作成されたら、eventSinkでのイベント待ちをoffにする
 }
);

ActiveX.waitEvents(60*1000); // 一分間イベント待ち
                //すべてのAxEventSinkオブジェクトがunAdvise()するか、
                // ActiveX.cancelWaitEvents()が実行されたら、このイベント待ちを終了する

AxEnum クラス ...

Dim fs, f, subf, f1

Set fs = WScript.CreateObject("Scripting.FileSystemObject")
Set f = fs.GetFolder(".")

'すべてのサブフォルダを表示
For Each subf In f.SubFolders
    WScript.Echo("[" & subf.Name & "]")
Next

'すべてのファイルを表示
For Each f1 In f.Files
    WScript.Echo(f1.Name)
Next
  

var fs = new ActiveX("Scripting.FileSystemObject");
var f = fs.GetFolder(".");

//すべてのサブフォルダを表示
var subfc = new AxEnum(f.SubFolders);
for(; !subfc.atEnd(); subfc.moveNext())
    alert("[" + subfc.item().Name + "]");

//すべてのファイルを表示
var fc = new AxEnum(f.Files);
for(; !fc.atEnd(); fc.moveNext())
    alert(fc.item().Name);
  

AxEnum コンストラクター AxEnum...

new AxEnum( activex ) : AxEnum

コレクションを持つAciveXオブジェクトを指定指定します。

atEnd 関数 AxEnum...

axenum.atEnd() : Boolean

item 関数 AxEnum...

axenum.item() : Any

moveFirst 関数 AxEnum...

axenum.moveFirst() : void

moveNext 関数 AxEnum...

axenum.moveNext() : void

AxEventSink クラス ...

className プロパティ AxEventSink...

eventsink.className : String [ReadOnly]

常に"AxEventSink"を返します。

var {ActiveX} = require("ole");

var excel = new ActiveX("Excel.Application");
var eventSink = ActiveX.newEventSink(excel);
alert( eventSink.className );  //"AxEventSink"
  

members プロパティ AxEventSink...

eventSink.members : Object

var {ActiveX} = require("ole");

var excel = new ActiveX('Excel.Application');
var eventSink = ActiveX.newEventSink(excel);

for (var m in eventSink.members) {
 print(m + " => " + eventSink.members[m]);
}
/*
NewWorkbook => [id(1565)] function( [in] Workbook* Wb ) : void
SheetSelectionChange => [id(1558)] function( [in] IDispatch* Sh, [in] Range* Target ) : void
SheetBeforeDoubleClick => [id(1559)] function( [in] IDispatch* Sh, [in] Range* Target, [in,out] VARIANT_BOOL* Cancel ) : void
SheetBeforeRightClick => [id(1560)] function( [in] IDispatch* Sh, [in] Range* Target, [in,out] VARIANT_BOOL* Cancel ) : void
  ・
  ・
*/

setHandler 関数 AxEventSink...

eventSink.setHandler( eventname, handler ) : Boolean 登録
eventSink.setHandler( default_handler ) : Boolean 登録
eventSink.setHandler( eventname ) : Boolean 削除

var {ActiveX} = require("ole");

var excel = new ActiveX('Excel.Application');
excel.Visible = true;

var eventSink = ActiveX.newEventSink(excel);

alert( eventSink.members["NewWorkbook"] ); // [id(1565)] function( [in] Workbook* Wb ) : void
alert( eventSink.members["SheetBeforeDoubleClick"] ); // [id(1559)] function( [in] IDispatch* Sh, [in] Range* Target, [in,out] VARIANT_BOOL* Cancel ) : void

eventSink.setHandler("NewWorkbook",
 function(wb) { // Workbookが新規に作成すると呼ばれる
   // wb : Workbook
   alert( "new Workbook" );
   cnt++;
   if (cnt==3) ActiveX.cancelWaitEvents(); // 3個新しいWorkbookが作成されたら、イベント待ちをcancelする
 }
);

eventSink.setHandler(
 function(eventname) { // デファルトイベントハンドラー
   // eventname : String
   if (eventname.toLowerCase()=="sheetbeforedoubleclick") {
     // 
     // sheet = arguments[1] : ActiveX Sheetオブジェクト
     // range = arguments[2] : Range クリックセル位置
     // cancel= arguments[3] : AxVar Bool参照型
     var cancel = arguments[3]
     cancel.set(true); // Excelにダブルクリックの処理をさせないために cancelにtrueをセット
   }
 }
);

ActiveX.waitEvents(60*1000); // 一分間イベント待ち
                //すべてのAxEventSinkオブジェクトがunAdvise()するか、
                // ActiveX.cancelWaitEvents()が実行されたら、このイベント待ちを終了する

eventSink.setHandler("NewWorkbook"); // イベントNewWorkbookのイベントハンドラーを削除
eventSink.setHandler(""); // デフォルトイベントハンドラーを削除

unAdvise 関数 AxEventSink...

eventSink.unAdvise()

var {ActiveX} = require("ole");

var excel = new ActiveX("Excel.Application");
excel.Visible = true;

var cnt = 0;
var eventSink = ActiveX.newEventSink(excel); // =ActiveX.newEventSink(excel,"AppEvents");
eventSink.setHandler("NewWorkbook",
 function(wb) { // Workbookが新規に作成すると呼ばれる
   // wb : Workbook
   alert( "new Workbook" );
   cnt++;
   if (cnt==3) eventSink.unAdvise(); // 3個新しいWorkbookが作成されたら、eventSinkでのイベント待ちをoffにする
 }
);

ActiveX.waitEvents(); // イベント待ち
                //すべてのAxEventSinkオブジェクトがunAdvise()するか、
                // ActiveX.cancelWaitEvents()が実行されたら、このイベント待ちを終了する

AxVar クラス ...

className プロパティ AxVar...

axvar.className : String [ReadOnly]

常に"AxVar"を返します。

var {AxVar} = require("ole");

var axvar = new AxVar();
alert( axvar.className );  //"AxVar"
  

vtype プロパティ AxVar...

axvar.vtype : Array [ReadOnly]
axvar.vt : Integer [ReadOnly]

var {AxVar} = require("ole");

var v1 = AxVar();
print( v1.vtype.toSource()); //["empty"]
print( v1.vt.toString(16));  // 0
print( v1.vt==AxVar.VT_EMPTY);  // true

var v2 = AxVar("int",[]);
print( v2.vtype.toSource()); //["long"]
print( v2.vt.toString(16));  // 3
print( v2.vt==AxVar.VT_I4);  // true

var v3 = AxVar(23.5);
print( v3.vtype.toSource()); //["double"]
print( v3.vt.toString(16));  // 5
print( v3.vt==AxVar.VT_R8);  // true

var v4 = AxVar("double",[100]);
print( v4.vtype.toSource()); //["double", [[0, 100]]]
print( v4.vt.toString(16));  // 2005
print( v4.vt==(AxVar.VT_R8|AxVar.VT_ARRAY));  // true
   

AxVar コンストラクター・関数 AxVar...

値の格納

axvar = new AxVar() : AxVar
axvar = new AxVar( value ) : AxVar

参照引数の作成

axvar = new AxVar( type, [] ) : AxVar
axvar = AxVar( type, [] ) : AxVar
axvar = new AxVar( type, [], value ) : AxVar
axvar = AxVar( type, [], value ) : AxVar

配列の作成

axvar = new AxVar( type, [size, ...] ) : AxVar
axvar = AxVar( type, [size, ...] ) : AxVar

var {ActiveX, AxVar} = require("ole");

var word = new ActiveX("Word.Application");
word.Documents.Add();
word.Visible = true;

var window = word.ActiveWindow;
alert( window.members.GetPoint ); // [id(112)] function( [out] long* ScreenPixelsLeft, [out] long* ScreenPixelsTop, [out] long* ScreenPixelsWidth, [out] long* ScreenPixelsHeight, [in] IDispatch* obj ) : void


var left = AxVar("long",[]);
var top = AxVar("long",[]);
var width = AxVar("long",[]);
var height = AxVar("long",[]);

window.GetPoint(left,top,width,height,word.Selection.Range)

alert( left.$ );
alert( top.$ );
alert( width.$ );
alert( height.$ );

attach 関数 AxVar...

axvar.attach(index, axvarSource ) : Boolean
axvar.attach(axvarSource ) : Boolean

var {AxVar} = require('ole');

var a = new AxVar("variant",3);
var b = new AxVar("int", 5);
b(3).$ = 123;
a.attach(2,b);

print(a(2)(3).$);  // 123

a(2)(3).$ = -321;

b = a.detach(2)

print(b(3).$);  // -321

changeType 関数 AxVar...

axvar.changeType( type ) : Boolean

clear 関数 AxVar...

axvar.clear()

copy, clone 関数 AxVar...

axvar.copy()
axvar.clone()

返値

axvarと同じ中身を持つAxVarオブジェクトを返します。

var {AxVar} = require("ole");

var v1 = AxVar(1234);
var v1_ = v1;
var v2 = v1.copy();

alert( v1().$ ); // 1234
alert( v1_().$ ); // 1234
alert( v2().$ ); // 1234

v1().$ = 4321; // v1 の中身を変更
alert( v1().$ ); // 4321
alert( v1_().$ ); // 4321
alert( v2().$ ); // 1234

detach 関数 AxVar...

axvar.detach(index) : AxVar

dim 関数 AxVar...

axvar.dim( type, [size, ...] )

var {AxVar} = require("ole");

var a = new AxVar(); // var a = AxVar();
a.dim("double",[4,4]); // 要素の型は double型で、添え字の下限値0, サイズ 4x4 の配列
/*
上記２行は
var a = new AxVar("double",[4,4]); // var a = AxVar("double",[4,4]);
と同じです。
*/

a(2,3).$ = 1000;
alert( a(2,3).$ ); // 1000

get 関数 v=axvar(...).$ AxVar...

中身が配列でないとき

v = axvar.get()
v = axvar.$
v = axvar().$

中身が配列であるとき

v = axvar.get(index, ...)
v = axvar(index, ...).$

var {AxVar} = require("ole");

var s = new AxVar("ABC"); // var s = AxVar("ABC");
alert( s.get() ); // ABC
alert( s.$ ); // ABC
alert( s().$ ); // ABC

var a = new AxVar("double",[4,4]); // var a = AxVar("double",[4,4]);
a(2,3).$ = 1000;

alert( a.get(2,3) ); // 1000
alert( a(2,3).$ ); // 1000

getActiveX 関数 AxVar...

axvar.getActiveX() : ActiveX

getBool 関数 AxVar...

axvar.getBool() : Boolean

getDate 関数 AxVar...

axvar.getDate() : Date

getDbl 関数 AxVar...

axvar.getDbl() : Number

getInt 関数 AxVar...

axvar.getInt() : Integer

getStr 関数 AxVar...

axvar.getStr() : String

redim 関数 AxVar...

axvar.redim( N ) : Boolean axvar.redim( [ B, N ] ) : Boolean

var {AxVar} = require("ole");

var a = new AxVar("double",[4,4]); // var a = AxVar("double",[4,4]);
alert( a.vtype.toSource() );	//["double", [[0, 4], [0, 4]]]
a(3,3).$ = -1234;

a.redim([1,10]);
alert( a.vtype.toSource() );	//["double", [[0, 4], [1, 10]]]
alert( a(3,4).$ ); // -1234   旧index(3,3) ==> 新index(3,4) は同じ位置

set 関数 axvar(...).$=v

var {AxVar} = require("ole");

var H = AxVar(); // var H = new AxVar();
H.set("175.5cm"); // H.$ = "175.5cm"; または H().$ = "175.5cm";

alert( H.$ ); // 175.5cm

__ptr__, __rawAddress__ 関数 AxVar...

axvar.__ptr__() : ctypes.voidptr_t
axvar.__rawAddress__() : ctypes.voidptr_t

ComObj クラス ...

ComObj コンストラクター ComObj...

new ComObj( addrese, guid ) : ComObj
new ComObj( comobj, guid ) : ComObj

equal_guid メソッド関数 ComObj...

comobj.equal_guid( guid ) : Boolean

QueryInterface メソッド関数 ComObj...

comobj.QueryInterface( guid ) : Boolean

guid プロパティ ComObj...

comobj.guid : GUID (Cデータ) ReadOnly

guid_str プロパティ ComObj...

comobj.guid_str : String ReadOnly

__p__ プロパティ ComObj...

comobj.__p__ : Cデータポインター ReadOnly

make_guid_str 関数 ComObj...

ComObj.make_guid_str() : String

axa, axserverとaxclientモジュールを使ったプロセス間通信[...]

axserverモジュールとaxclientモジュールを使えば、柔軟なプロセス間通信が簡単に実現できます。
axserverモジュールはサーバーサイドのプログラム、axclientモジュールはクライアントサイドのプログラムを作成するためのライブラリーを提供します。
サーバー, クライアントは別々プロセスで動き、互いにメソッドcallしてサービスの授受やデータ交換ができます。

axaモジュールは、サーバーとクライアント両方のサイドで使います。

次の説明図は、サーバーサイドのJSプログラムを起動した後、
クライアントサイドのJSプログラムを起動しサーバーにある「add」サービスを呼び出しその結果をprint関数で表示しています。
simple_axsv.js, simple_axcli.js


Python言語では以下のように記述します。
ただし、Pythonにはメッセージループを持たないので追加処理があります。
simple_axsv.py, simple_axcli.py


実行方法は、最初にサーバーサイドを実行した後、クライアントサイドを実行します。
また逆に、クライアントサイドを先に起動し、10秒以内にサーバーサイドを実行しても正しく動作します。

さらにサーバーサイドとクライアントサイドは、JavaScript, Pythonどちらの言語の組み合わせであっても正しく動作します。

サーバーサイドは、axserverモジュールにある関数やクラスを使って実装できます。
そのモジュールには、サーバー本体のAXserverオブジェクト、サービス関数動作中のcontextであるAXcontextオブジェクトが準備されている。

クライアントサイドは、axclientモジュールにある関数やクラスを使って実装できます。
そのモジュールには、クライアント本体のAXclientオブジェクト、サービスを受け取るときに必要なAXreceiverオブジェクトが準備されている。

サーバーサイドの実装 実装スクリプトogo_server.js, ogo_server.py...

1. 準備(AXサーバーブジェクト作成関数(newAX)、削除関数(delAX)をAXsvモジュールから取り出す)

      var axserver = require('axserver');
      var axa = require('axa');
    

2. AXオブジェクト作成

      var axsv = axserver.newAX("SAMPLE");
    

3. インターフェス定義

      //加算
      axsv.on("add",
        function(a, b) { //呼出名"add"とその実行関数、それに説明文を追加
          return a + b;
        },
        "ans = a + b" //"add"処理の説明
      );
      
      //素数
      axsv.on("prime",
        function(N, delay=0) { //呼出名"prime"とその実行関数, 非同期で処理する
            var axcx = this;
            var n = 2;        //素数であるか最初に調べる数
            var primes = [];  //見つけた素数を配列に入れる
            
            delay = 0 | delay;  
            setTimeout(my_find_prime, delay);
            
            function my_find_prime() {
                if (n>N) {
                  axcx.close();
                  return;
                }
                var primed = true;
                for (var j=0; j<primes.length; j++) {
                    if ((n%primes[j])==0) {
                        primed = false;
                    }
                }
                if (primed) {
                    primes.push(n);
                    axcx.returnVals(primes.length, n);
                }
                n += 1;
                setTimeout(my_find_prime, delay);
            }
        },
        "[p-]prime(N, delay=0)"   //[p-]は、クライアントからのpost呼出で サーバーから何度もaxcx.returnVals(...)を使って値を返すことを可能にします。
      );
           

4. メッセージループ

      axa.msgLoop(); //アプリよって、メッセージループの書き方が違う
    

クライアントサイドの実装 実装スクリプトogo_client.js, ogo_client.py...

1. 準備(AXクライアントオブジェクト取得関数(getoutAX)を axclientモジュールから取り出す)

      var axa = require('axa');
      var {getoutAX} = require('axclient');
    

2. AXクライアントオブジェクトを取得)

      var axcli = getoutAX("SAMPLE");  //サーバーサイトで名前”SAMPLE"で作成されたオブジェクト
    

3. "add"サービスをsend関数(同期)で呼び出す

      alert( axcli.send("add", 20, 50) );  //  70
    

4. axcliの"prime"サービスをpost関数で呼び出し、値を非同期に返す

      axcli.rcvr(
        function(name, count, n) {
          print(`[${count}] ${n}`);
        }
      ).post("prime", 50, 100) );  // 50以下の整数リストを 100ミリ秒毎に計算
      
      axa.msgLoop(5*1000); // 5秒間、上記の計算を受け取るためのメッセージループ
      /*
      [1] 2
      [2] 3
       ・
       ・
      [14] 43
      [15] 47
      */
    

5. サーバーを終了

      axcli.close();
    

6. クライアントを終了

      axa.exit();
    

[axa]axaモジュール...

newAxA 関数 axaモジュール...

var {newAxA} = require('axa');

newAxA() : OgOx.AxA

以下は、[A]プロセスでセットした値を [B]プロセスが読み込む例です。

//[A]プロセス
var {ActiveX} = require("ole");
var {newAxA} = require('axa');

var axa = newAxA();

var excel = new ActiveX('Excel.Application');
excel.Visible = true;

axa.reg("EXCEL_TEST", excel);

var book = excel.Workbooks.Add();
var sheet1 = book.Sheets('sheet1');

sheet1.Cells(1,!).$ = 1234;	//[★]

---------------------------------------------
//[B]プロセス
var {newAxA} = require('axa');

var axa = newAxA();

var excel = axa.getout("EXCEL_TEST");	//このexcelは、[A]プロセスで作成されたActiveXオブジェクト

var book = excel.Workbooks('Book1');
var sheet1 = book.Sheets('sheet1');

alert( sheet1.Cells(1,1).$ ); 	//1234  [★]で入力した値!!!

msgLoop 関数 axaモジュール...

var {msgLoop} = require('axa');

msgLoop(msec=-1)

breakLoop 関数 axaモジュール...

var {breakLoop} = require('axa');

breakLoop(deep=1)

exit 関数 axaモジュール...

var {exit} = require('axa');

exitLoop(f=0)

launch 関数 axaモジュール...

var {launch} = require('axa');

launch(exeprogname, param=null, curdir=null, showCmd=0) : HINSTANCE

make_guid_str 関数 axaモジュール...

var {make_guid_str} = require('axa');

make_guid_str() : String

[axserver]axserverモジュール...

newAX 関数 axserverモジュール...

var {newAX} = require('axserver');

newAX(name, refcount=1) : AXserver

// [サーバ] 側
//AXサーバーオブジェクト作成とサービスの組み込み
var {newAX} = require('axserver');

var axsv = newAX("SAMPLE");

axsv.on("add",
	function(a, b) {
		return a + b;
	},
	"ans = a + b"
);

------------------------------------------
// [クラアント] 側
//AXクライアントを取得してサービスを受ける
var {getoutAX} = require('axclient');

var axcli = getoutAX("SAMPLE");

print( axcli.send("add", 20, 50) );	//70

delAX 関数 axserverモジュール...

var {delAX} = require('axserver');

delAX(name) : Boolean

getAX 関数 axserverモジュール...

var {getAX} = require('axserver');

getAX(name) : AXserver

exit 関数 axserverモジュール...

var {exit} = require('axserver');

exit(f)

[axclient]axclientモジュール...

getoutAX 関数 axclientモジュール...

var {getoutAX} = require('axclient');

getoutAX(name) : AXclient

AXserver クラス ...

on メソッド関数 ...

axsv.on( callname, func[, description] ) : AXserver

off メソッド関数 ...

axsv.off( callname ) : AXserver

returnState メソッド関数 ...

axsv.returnState( state, a1, a2,... )

// [サーバ] 側
//AXサーバーオブジェクト作成とサービスの組み込み
var {newAX} = require('axserver');

var axsv = newAX("SAMPLE");

axsv.on("add",
	function(a, b) {
		return a + b;
	},
	"ans = a + b"
);

・・・

axsv.returnState("ok!");

------------------------------------------
// [クラアント] 側
//AXクライアントを取得してサービスを受ける
var {getoutAX} = require('axclient');

var axcli = getoutAX("SAMPLE");

axcli.setHandler(
	function(state, ...rest) {
		if (state=="ok!") {
			print( axcli.send("add", 20, 50) );	//70
		}
	}
);

AXcontext クラス...

//[サーバー]
var axa = require('axa');
var {newAX} = require('axserver');

var axsv = newAX("SAMPLE");

//インターフェス定義
//加算
axsv.on("add",
  function(a, b) {
    return a + b;
  },
  "ans = a + b"
);

//素数(素数を非同期で返す)
axsv.on("prime",
  function(N) {
    var axcx = this;
    var n = 2;        //素数であるか最初に調べる数
    var primes = [];  //見つけた素数を配列に入れる

    for (var n=2; m<N; n++) {
      var primed = true;
      for (var j=0; j<primes.length; j++) {
        if ((n%primes[j])==0) {
          primed = false;
          break;
        }
      }
      if (primed) {
        primes.push(n);
        axcx.returnVals(primes.length, n);	//(count, 素数)
      }
    }
    //postによる最後のreturn
    axcx.close();	//または return "end";
  },
  "prime(N)" 
);

//メッセージループ
axa.msgLoop();

---------------------------------------------
//[クライアント]
var axa = require('axa');
var {getoutAX} = require('axclient');

var axcli = getoutAX("SAMPLE");

//"add"同期呼出
//print(axcli.send("add", 20, 50)); //70

//"add"非同期呼出
axcli.rcvr(
  function(name, ans, *rest) {
    print(`20 + 50 = ${ans}`);
  }
).post("add", 20, 50);

//"prime"同期呼出
//print(axcli.send("prime", 50)); // ans is only 2!

//"prime"非同期呼出
axcli.rcvr(
  function(name, cnt, prime, *rest) {
    if (name=='end') {
      print("completed calc-prime!!");  //サーバー側で、「return "end";」 が実行された場合
    }else{
      print("[" + cnt + "] 20 + 50 = " + ans);
    }
  }
).post("prime", 20, 50);

//メッセージループ(5秒間)
axa.msgLoop(5*1000);

/*
20 + 50 = 70
[1] 2
[2] 3
 ・
 ・
[14] 43
[15] 47
*/

callname プロパティ ...

axcontext.callname : String

rindex プロパティ ...

axcontext.rindex() : Integer

returnVals メソッド関数 ...

axcontext.returnVals( r1, r2, ... ) : Boolean

function on_return(name, r1,r2,...rest) {
    //nameは post(callname,...)のcallnameと同じ
    //r1, r2, ...に結果がセットされている
    ・・・
}

returnNVals メソッド関数 ...

axcontext.returnNVals(name, r1, r2, ... ) : Boolean

function on_return(name, r1,r2,...rest) {
    //nameは 結果名がsetされます。
    //r1, r2, ...に結果がセットされている
    ・・・
}

close メソッド関数 ...

axcontext.close() : Boolean

throwError メソッド関数 ...

axcontext.throwError( errorMsg ) : Boolean

function on_rstate(name, errorMsg, ...rest) {
    //name=="error"
    //errorMsgは上記のエラーメッセージ文字列
    ・・・
}

returnState メソッド関数 ...

axcontext.returnState(state, s1, s2, ... ) : Boolean

function on_rstate(state, s1,s2, ...rest) {
    //nameは 結果名がsetされます。
    //s1, s2, ...に状態値がセットされている
    ・・・
}

AXclient クラス...

send メソッド関数 ...

axcli.send(callname, a1, a2, ...) : Integer, String, Bool, AxVarが扱う値の型

post メソッド関数 ...

axcli.rcvr(on_return=null, on_rstate=null).post(callname, a1, a2, ...)
axcli(on_return=null, on_rstate=null).post(callname, a1, a2, ...)

axcli.post(callname, a1, a2, ...).catch(on_return=null, on_rstate=null)
axcli.post(callname, a1, a2, ...)(on_return=null, on_rstate=null)

axcli.post_(callname, a1, a2, ...)

function on_return(name, r1, r2, ...rest) {
  //name : String 返値の意味名 普通はcallname
  //r1, r2, ...rest 最大8個の返値が送られてる。AxVarオブジェクト(C/C++言語ではVARIANT型)が扱える値
  ・・・ //受け取って処理する
}

function on_rstate(state, s1, s2, ...rest) {
  //state : String 状態名 state="close", "error"なら、このpostによる通信(返値と通知)はすべて終了します。
  //s1, s2, ...rest 最大8個の状態値が送られてる。AxVarオブジェクト(C/C++言語ではVARIANT型)が扱える値
  ・・・ //受け取って処理する
}

axcli.post_(callname, a1, a2, ...)は

axcli.rcvr().post(callname, a1, a2, ...)
axcli().post(callname, a1, a2, ...)

axcli.post(callname, a1, a2, ...).catch()
axcli.post(callname, a1, a2, ...)()

と同じです。

rcvr メソッド関数 ...

axcli.rcvr(on_return=null, on_rstate=null) : AXreceiver
axcli(on_return=null, on_rstate=null) : AXreceiver

function on_return(name, r1, r2, ...rest) {
  //name : String 返値の意味名 普通はcallname
  //r1, r2, ...rest 最大8個の返値が送られてる。AxVarオブジェクト(C/C++言語ではVARIANT型)が扱える値
  ・・・ //受け取って処理する
}

function on_rstate(state, s1, s2, ...rest) {
  //state : String 状態名 state="close", "error"なら、postによる通信(返値と通知)をすべて終了します。
  //s1, s2, ...rest 最大8個の状態値が送られてる。AxVarオブジェクト(C/C++言語ではVARIANT型)が扱える値
  ・・・ //受け取って処理する
}

setHandler メソッド関数 ...

axcli.setHandler(ax_on_rstate)

function ax_on_rstate(state, s1, s2, ...rest) {
  //state : String 状態の意味名  特にstate=="close"の場合、サーバーの終了通知
  //s1, s2, ...rest 最大8個の状態値が送られてる。AxVarオブジェクト(C/C++言語ではVARIANT型)が扱える値
  ・・・ //受け取って処理する
}

axsv.returnState(state, s1,s2);

AXreceiver クラス...

post メソッド関数 ...

axrcvr.post(callname, a1, a2, ...)

catch メソッド関数 ...

axrcvr.catch(on_return=null, on_rstate=null)

function on_return(name, r1, r2, ...rest) {
  //name : String 返値の意味名 普通はcallname
  //r1, r2, ...rest 最大8個の返値が送られてる。AxVarオブジェクト(C/C++言語ではVARIANT型)が扱える値
  ・・・ //受け取って処理する
}

function on_rstate(state, s1, s2, ...rest) {
  //state : String 状態名 state="close", "error"なら、postによる通信(返値と通知)をすべて終了します。
  //s1, s2, ...rest 最大8個の状態値が送られてる。AxVarオブジェクト(C/C++言語ではVARIANT型)が扱える値
  ・・・ //受け取って処理する
}

OgOx.AxA ActiveXオブジェクトクラス...

OgOx.AxAは、ActiveXオブジェクトです。このオブジェクトをAxAオブジェクトと呼ぶことにします。
AxAオブジェクトを使えば、ActiveXオブジェクトをプロセス間で共有することができます。

AxAオブジェクトの作成方法は以下のようにします。

var axa = require('axa');
var AxA = newAxA();

以下は、２つのプロセス間でExcel(ActiveXオブジェクト)を共有する例です。



axa, axserverとaxclientモジュールを使ったプロセス間通信は、内部でこのAxAオブジェクトを使っています。

data プロパティ OgOx.AxA...

AxA.data(name,prop[,password]).$ = value
variable = AxA.data(name,prop[,password]).$

reg 関数 OgOx.AxA...

AxA.reg( name, obj[, refcount, password]) : Boolean

      const _my_excel_name_ = "36bdd843-448c-4318-8791-aabbccddeeff"; //excelオブジェクトを取り出すプロセス側にだけに教えておく名前

      var {newAxA, make_guid_str} = require('axa');
      var {ActiveX} = require('ole');

      var AxA = newAxA();
      var  _my_password_ = make_guid_str();  // 他のプロセスが知りえないパスワード

      var excel = new ActiveX("Excel.Application");
      AxA.reg(_my_excel_name_, excel, 1, _my_password_);
        ・・・
        // 他のプロセスが AxA.getout(_my_excel_name_)を実行して、このexcelオブジェクトを取り出す
        ・・・
      AxA.unreg(_my_excel_name_, _my_password_);  //プログラムの終了処理
    

unreg 関数 OgOx.AxA...

AxA.unreg( name[, password]) : Boolean

getout 関数 OgOx.AxA...

AxA.getout( name) : ActiveX

      var {newAxA} = require('axa');
      const _my_excel_name_ = "36bdd843-448c-4318-8791-aabbccddeeff"; //excelオブジェクトを登録するプロセス側から教えてもらう名前

      var AxA = newAxA();

      var excel = AxA.getout(_my_excel_name_);
    

isValid 関数 OgOx.AxA...

AxA.isValid( name, obj) : Boolean

exists 関数 OgOx.AxA...

AxA.exits( name ) : Boolean

asearch 関数 OgOx.AxA...

AxA.asearch( name )

quit_asearch 関数 OgOx.AxA...

AxA.quit_asearch( name )

Found イベントOgOx.AxA...

event Found( name )

Getouting イベントOgOx.AxA...

event Getouting( name, refcount )

axpy(OgO), ogax(Python)モジュールを使ったプロセス間通信[...]

axpy(OgO),ogax(Python)モジュールを使えば、シームレスにOgOとPythonをつないでプロセス間通信ができます。
これらモジュールの実装は「axa, axserverとaxclientモジュール」を使っており、機能追加が可能な構造になっております。

シームレスとは、通信相手の変数アクセスや関数実行を少ない手順で簡単に実現できることです。
そのために、OgOとPythonは

  接続オブジェクト
  実行環境

を準備します。
その後、getSync/getAsync, setSync/setAsync, callSync/callAsync, execSync/execAsync, evalSync/evalAsyncメソッド関数を使って相手の機能を使うだけです。

axpy(OgO)は、AxPyクラスを提供するモジュールです。
ogax(Python)は、OgAxクラスを提供するモジュールです。



使い方を以下にサンプルを持って説明します。

OgOサイドの実装 実装スクリプトtest_ogo.js...

1. 準備(AxPyクラスをaxpyモジュールから取り出す)

    var {AxPy} = require('axpy');
  

2. 接続先のPythonスクリプトを起動して接続オブジェクト作成

    var py = new AxPy(__dirname + "\\test_python.py");
  

3. Pythonからの実行環境を設定

    //グローバルスコープを実行環境とする場合
    var xyz = "";

    function multiple(x,y) {
      return x * y;
    }

    /*
    //関数内スコープを実行環境とする場合
    function env(py) {
      var xyz = "";

      function multiple(x,y) {
        return x * y;
      }
  
      return (_s,..._a)=>eval(_s);
    }
    py.set_env( enb(py) );
    */
  

====以下、PytonとOgOの連携プログラム部分====
4. Pythonにある変数、関数を(同期)アクセス

    print("=Pythonにあるabc変数をアクセス=");
    py.setSync("abc", 123);
    print(`abc = ${py.getSync("abc")}`);
    
    print("=Pythonにあるadd関数を実行=");
    print(`20 + 30 => ${py.callSync("add", 20,30)}`);
    
    //= PythonからOgOスクリプトを実行 =
    py.callSync("test_exec");
  

5. OgOからPythonの関数を定義し、その後その関数をOgOから実行

    //OgOからPythonの関数を定義
    py.execSync(`
    # Python関数の定義
    def prime(N):
      n = 2
      primes = []
      cnt = 0
      while n<=N :
        primed = True
        for j in range(len(primes)) :
          if (n % primes[j])==0 :
            primed = False
            break
        if primed :
          cnt += 1
          primes.append(n)
          ogo.callSync("catch_prime",cnt,n)
        
        n += 1
    `);
    /*
    //上記スクリプト部分をファイルにした場合
    py.execSync(
      __snarf__(__dirname + "\\prime.py")
    );
    */
    
    //その後その関数をOgOから実行
    function catch_prime(cnt, n) {
      print(`prime[${cnt}] => ${n}`);
    }
    
    async function calc_prime(N) {
      print("[start]calc_prime");
      await py.callAsync("prime", N);
      print("[end]calc_prime");
    }
    
    calc_prime(50);
    /*
    [start]calc_prime
    prime[1] => 2
    prime[2] => 3
    prime[3] => 5
    ・・・
    ・・・
    prime[15] => 47
    [end]calc_prime
    */
  

6. つないだPythonとの接続を終了したい場合

    py.close();
  

Pythonサイドの実装 実装スクリプトtest_python.py...

1. 準備(OgAxクラスをogaxモジュールから取り出す)

    import axa            #メッセージループのために axaモジュールが必要
    from ogax import OgAx
  

2. OgOから実行環境を準備

    # グローバルスコープを実行環境としたい場合
    abc = 0

    def add(x, y) :
      return x + y
    
    #Test to access to ogo
    def test_exec() :
      ogo.execSync(r"""
    print("\n[test_exec]---------");
    print("=PythonからOgOにある変数を(同期)アクセス=");
    xyz = "OgOはアプリを繋いでくれる便利なツールです!";
    print("xyz = ${xyz}");
    
    print("=PythonからOgOにあるmultiple関数を(同期)実行=");
    print("20 * 30 => ${multiple(20, 30)}");
    """)

    # 関数内スコープを実行環境としたい場合
    """
    def env( ogo ) :
      ・・・
      上記スクリプトを記述
      ・・・
      return locals()
    """
  

3. OgOから接続される接続オブジェクト作成

    ogo = OgAx();
  

4. OgOからの実行環境を設定

    # グローバルスコープを実行環境とする場合
    ogo.set_env( globals() )

    # 関数内スコープを実行環境とする場合
    # ogo.set_env( env(ogo) )
  

5. OgOとプロセス間通信にメッセージループが必要

    axa.mainMsgLoop()
    または
    axa.msgLoop()
    axa.exit()
  

AxPy (OgO)クラス ...

AxPy コンストラクター AxPy...

let {AxPy} = require('axpy');

py = new AxPy( pysname[, option] ) : AxPy
py = new AxPy( [option] ) : AxPy

set_env 関数AxPy...

old_env = py.set_env( [env] ) : Function

Pythonから実行依頼されたとき、実行するeval関数を渡す。(eval関数を囲むスコープがPythonから実行依頼されたときの実行環境となります。)
(1) 引数省略の場合、global scopeで実行するeval関数を設定します。
(2) 通常は次のような関数を作成し、その実行値(関数値)を渡します。
  function env() {
    /*
      変数の宣言や関数を定義
      そのほか、関数内でスクリプトが実行
    */
    ....
    return (_s,..._a)=>eval(_s);  //必ず最後にこのreturn文を実行
  }
  py.set_env( env() );

close 関数AxPy...

py.close()

on, addEventListener 関数AxPy...

py.on(eventname, func) : AxPy(=py)
py.addEventListener(eventname, func) : Boolean

off, removeEventListener 関数AxPy...

py.on(eventname, func) : AxPy(=py)
py.removeEventListener(eventname) : Boolean

getSync 関数AxPy...

value = py.getSync( name ) : Any

getAsync 関数AxPy...

value = await py.getAsync( name ) : Any

非同期実行なので、
  py.getAsync(name);
は、Pythonに実行依頼してすぐ終了します。
評価値(実行値)を取得したい場合、
value = await を置けば、Pythonが評価値(実行値)を返してくるのを待って値を取得します。

setSync 関数AxPy...

py.setSync( name, value )

setAsync 関数AxPy...

py.setAsync(name, value);

await py.setAsync(name, value);

非同期実行なので、
  py.getAsync(name);
は、Pythonに実行依頼してすぐ終了します。
評価値(実行値)を取得したい場合、
value = await を置けば、Pythonが評価値(実行値)を返してくるのを待って値を取得します。

callSync 関数AxPy...

value = py.callSync(fname, arg1,arg2,...)

callAsync 関数AxPy...

py.callAsync(fname, arg1,arg2,...)

value = await py.callAsync(fname, arg1,arg2,...)

非同期実行なので、
  py.callAsync(fname, arag1,arg2,...);
は、Pythonに実行依頼してすぐ終了します。
関数実行結果を取得したい場合、
value = await を置けば、Pythonが関数実行結果を返してくるのを待って、その値を取得します。

execSync 関数AxPy...

py.execSync(script[,arg1,arg2,...])

execAsync 関数AxPy...

py.execAsync(script[, arg1,arg2,...])

await py.execAsync(script[, arg1,arg2,...])

非同期実行なので、
  py.execAsync(script, arag1,arg2,...);
は、Pythonに実行依頼してすぐ終了します。
script実行を完了して次の処理を行ないたい場合、
await を置いて実行してください。

evalSync 関数AxPy...

value = py.evalSync(expression[,arg1,arg2,...])

evalAsync 関数AxPy...

value = await py.evalAsync(expression[, arg1,arg2,...])

非同期実行なので、
  py.evalAsync(expression, arag1,arg2,...);
は、Pythonに計算依頼してすぐ終了しますが、
expression の計算結果を取得するために、await を置きます。

set_async 関数AxPy...

old_mode = py.set_async(f=-1);

postMessage 関数AxPy...

py.postMessage(message)

Pythonの実行環境において送られたデータを受け取るには、以下のように事前に受け取り関数を
登録しておく必要があります。
  # Python側
  def recv( message ) :
    # 送られたデータは引数messageに入っています
    ....
  
  ogo.messageReceiver( recv )

messageReceiver 関数AxPy...

py.messageReceiver(recv)

送られたデータ(message)を受け取る関数
以下のようなrecv関数です。
function recv(message) {
  // Pythonから送られたデータは引数messageに入っています
  ...
}
py.messageReceiver(recv);

axcli プロパティAxPy...

py.axcli : AX ActiveXオブジェクト [ReadOnly]

同期呼出でPythonにあるサービスを実行する
value = axcli.send("servicename"[,arag1,arag2,...)

非同期呼出でPythonにあるサービスを実行する
axcli.post("servicename"[,arag1,arag2,...)(
  recv_result,
  recv_state
)

Pythonにあるサービスは、ogo.axsv AXオブジェクトに登録します。

usersv プロパティAxPy...

py.usersv : AX ActiveXオブジェクト [ReadOnly]

AXクラスの解説にあるように以下のようにしてサービスを実装する
py.usersv.on("servicename", servicefun(a1,a2,...) {
    //サービス処理
    ...
  },
  "[...]comment..."
);

Python側は、ogo.usercli AXオブジェクトを使ってこのサービスを呼び出します。

OgAx (Python)クラス ...

OgAx コンストラクター OgAx...

from ogax import OgAx

ogo = OgAx(genv=None)
ogo = OgAx(AX_NAME, genv=None)

OgOからPythonの実行要求があったときの実行環境。
genv = globals()を与えた場合、グローバル名前空間が実行環境となります。
また、
  def env() :
    #変数、関数を記述
    ...
    return locals();
  genv = env();
を与えた場合、env関数内のローカル名前空間が実行環境となります。

OgOから与えられた暗号文字列で、この文字列でOgOとPythonをつなぐオブジェクトが相互に交換します。
省略した場合、Pythonが起動されたときの第2引数を採用します。
  python.exe scriptファイル名 AX_NAME

接続実行されているOgOにAccessするための
  OgAxオブジェクト
を返します。

set_env 関数OgAx...

old_env = ogo.set_env(env)

OgOからの実行依頼を、この与えられたシンボル名前空間オブジェクトで実行します。
Pythonのグローバルシンボル空間で実行したい場合、env=globals()を渡します。
関数内のローカルシンボル名前空間で実行したい場合、
  def mkenv(ogo) :
    /*
      変数の宣言や関数を定義
      そのほか、関数内でスクリプトが実行
    */
    ....
    return locals()  //必ず最後にこのreturn文を実行
  
  env = mkenv( ogo );
を渡す。

close 関数OgAx...

ogo.close()

clearScope 関数OgAx...

ogo.clearScope()

OgOからpy.execSync(...), py.execAsync(...)を使うと、実行環境が変数や関数が追加され煩雑になってきます。
初期状態に戻すために
  ogo.clearScope()
を実行します。そうすると、
  ogo.set_env(env)
が実行されたときの状態に戻ります。

getSync 関数OgAx...

value = ogo.getSync(name)

getAsync 関数OgAx...

value = await ogo.getAsync(name)

非同期実行なので、
  ogo.getAsync(name);
は、OgOに実行依頼してすぐ終了します。
評価値(実行値)を取得したい場合、
value = wait を置けば、OgOが評価値(実行値)を返してくるのを待って値を取得します。

setSync 関数OgAx...

ogo.setAsync(name, value)

setAsync 関数OgAx...

ogo.setAsync(name, value)

await ogo.setAsync(name, value)

非同期実行なので、
  ogo.getAsync(name);
は、OgOに実行依頼してすぐ終了します。
評価値(実行値)を取得したい場合、
value = wait を置けば、OgOが評価値(実行値)を返してくるのを待って値を取得します。

callSync 関数OgAx...

value = ogo.callSync(fname, arg1,arg2,...)

callAsync 関数OgAx...

ogo.callAsync(fname, arg1,arg2,...)

value = await ogo.callAsync(fname, arg1,arg2,...)

非同期実行なので、
  ogo.callAsync(fname, arag1,arg2,...);
は、OgOに実行依頼してすぐ終了します。
関数実行結果を取得したい場合、
value = wait を置けば、OgOが関数実行結果を返してくるのを待って、その値を取得します。

execSync, evalSync 関数OgAx...

value = ogo.execSync(script[,arg1,arg2,...])
value = ogo.evalSync(script[,arg1,arg2,...])

execAsync 関数OgAx...

ogo.execAsync(script[, arg1,arg2,...])
ogo.evalAsync(script[, arg1,arg2,...])

value = await ogo.execAsync(script[, arg1,arg2,...])
value = await ogo.evalAsync(script[, arg1,arg2,...])

非同期実行なので、
  ogo.execAsync(script, arag1,arg2,...);
は、OgOに実行依頼してすぐ終了します。
script実行を完了して次の処理を行ないたい場合や返値を取得したい場合
value = wait を置いて実行してください。

set_env 関数OgAx...

old_mode = ogo.set_async(f=-1);

postMessage 関数OgAx...

ogo.postMessage(message)

OgOの実行環境において送られたデータを受け取るには、以下のように事前に受け取り関数を
登録しておく必要があります。
  // OgO側
  function recv( message ) {
    // 送られたデータは引数messageに入っています
    ....
  }
  py.messageReceiver( recv )

messageReceiver 関数OgAx...

ogo.messageReceiver(recv)

送られたデータ(message)を受け取る関数
以下のようなrecv関数です。
def recv(message) :
  # Pythonから送られたデータは引数messageに入っています
  ...

ogo.messageReceiver(recv)

usercli プロパティOgAx...

ogo.usercli : AX ActiveXオブジェクト [ReadOnly]

同期呼出でOgOにあるサービスを実行する
value = usercli.send("servicename"[,arag1,arag2,...)

非同期呼出でOgOにあるサービスを実行する
usercli.post("servicename"[,arag1,arag2,...)(
  recv_result,
  recv_state
)

OgOにあるサービスは、py.usersv AXオブジェクトに登録します。

axsv プロパティOgAx...

ogo.axsv : AX ActiveXオブジェクト [ReadOnly]

AXクラスの解説にあるように以下のようにしてサービスを実装する
def servicefun(axcx, arg1, arg2, ...) :
  //サービス処理
  ...

ogo.usersv.on("servicename", servicefun, "[...]comment...")

OgO側は、py.axcli AXオブジェクトを使ってこのサービスを呼び出します。