=================================================================== RCS file: /home/cvs/OpenXM/doc/OpenXM-specs/library.tex,v retrieving revision 1.3 retrieving revision 1.6 diff -u -p -r1.3 -r1.6 --- OpenXM/doc/OpenXM-specs/library.tex 2000/01/24 02:48:24 1.3 +++ OpenXM/doc/OpenXM-specs/library.tex 2002/01/20 09:26:22 1.6 @@ -1,4 +1,4 @@ -%% $OpenXM: OpenXM/doc/OpenXM-specs/library.tex,v 1.2 2000/01/24 00:57:11 noro Exp $ +%% $OpenXM: OpenXM/doc/OpenXM-specs/library.tex,v 1.5 2000/09/08 18:57:49 takayama Exp $ /*&jp \section{ OX サーバに対する C ライブラリインタフェース } @@ -14,8 +14,8 @@ In some OX servers, one can use the OX server as a C l \section{ OX servers as a C library} In some OX servers, one can use the OX server as a C library. -The interface functions of the C library -are similar to Asir OX client functions such as +The API to the C library +is similar to Asir OX client API such as {\tt ox\_push\_cmo()}, {\tt ox\_pop\_cmo()}. CMO should be converted into the binary encoded form to call these functions. @@ -30,15 +30,15 @@ CMO should be converted into the binary encoded form t /*&eg This function initializes the library interface. {\tt type} specifies the byte order to send int32 to the OX server xxx. - If type is equal to 0, the network byte order will be used. - If type is equal to 1, the little endian order will be used. + If type is equal to 0, the native byte order will be used. + If type is equal to 1, the network byte order will be used. In case of error, -1 will be returned. */ /*&jp この関数はライブラリインタフェースの初期化を行う. OX サーバ xxx へ int32 を送るための byte order を type で指定する. - type = 0 の場合 network byte order が設定される. - type = 1 の場合 little endian order が設定される. + type = 0 の場合 native byte order が設定される. + type = 1 の場合 network byte order が設定される. 失敗した場合, -1 を戻す. */ @@ -110,11 +110,24 @@ This function sends a stack machine command void xxx_ox_execute_string(char *s) \end{verbatim} /*&eg -These function requests a server to execute a string {\tt s}. +This function requests a server to execute a command expressed by +a string {\tt s}. {\tt s} should be acceptable by the parser of the server. */ /*&jp 文字列 {\tt s} をサーバに実行させる. {\tt s} はサーバのパーザ が受理可能なものでなければならない. +*/ + +//&C + +/*&jp +ライブラリモードのサンプルソースは {\tt OpenXM/doc/oxlib} +にある. +*/ + +/*&eg +Sample source codes to use the library mode interface can be found in +{\tt OpenXM/doc/oxlib}. */