バージョン 6.3.3	検索   索引   目次   |   PDF BOOKS   |   ホーム   上へ   戻る   次へ

個々の関数の詳細については、右側の選択ボックスを使用してください。

nni_get_interface

構文

int nni_get_interface( int iVersion, void** ppnni_func );

この関数は、Natural Native Interface のインスタンスを返します。

この関数は、アプリケーションでプラットフォーム依存のシステムコールを使用してインターフェイスライブラリが取得され、ロードされた後に呼び出されます。 この関数を使用すると、個々のインターフェイス関数を示す関数ポインタが含まれている構造へのポインタが返されます。 構造内で返される関数は、インターフェイスのバージョン間で異なる場合があります。

インターフェイスバージョンを指定する代わりに、定数 NNI_VERSION_CURR を指定することもできます。この場合は、最新のインターフェイスバージョンが常に参照されます。 特定の Natural バージョンに属するインターフェイスバージョン番号は、そのバージョンとともに提供されるヘッダーファイル natni.h 内で定義されています。 Natural バージョン n.n の場合、インターフェイスバージョン番号は NNI_VERSION_nn として定義されます。 NNI_VERSION_CURR も NNI_VERSION_nn として定義されます。 関数が呼び出された Natural バージョンで、要求されるインターフェイスバージョンがサポートされていない場合は、エラーコード NNI_RC VERSION_ERROR が返されます。 これ以外の場合のリターンコードは、NNI_RC_OK です。

関数によって返されるポインタは、インターフェイスの 1 つのインスタンスを表します。 このインターフェイスインスタンスを使用するため、アプリケーションではこのポインタが保持され、後続のインターフェイスコールに渡されます。

通常、アプリケーションで任意のインスタンスに対して nni_initialize を呼び出すことによって、Natural セッションがその後初期化されます。 アプリケーションで Natural セッションの使用が終了すると、同じインスタンスに対して nni_uninitialize が呼び出されます。 これ以降は、この同じインターフェイスインスタンス上で別の Natural セッションを初期化できるようになります。 アプリケーションでインターフェイスインスタンスの使用が完全に終了した後は、このインスタンスに対して nni_free_interface が呼び出されます。

パラメータ

リターンコード

リターンコードの意味については、「リターンコード」の説明を参照してください。

nni_free_interface

構文

int nni_free_interface(void* pnni_func);

この関数は、アプリケーションでインターフェイスインスタンスの使用が終了し、ホストされていた Natural セッションが初期化解除された後に呼び出されます。 この関数によって、インターフェイスインスタンスが占有していたリソースが解放されます。

パラメータ

リターンコード

リターンコードの意味については、「リターンコード」の説明を参照してください。

nni_initialize

構文

int nni_initialize(void* pnni_func, const char* szCmdLine, void*, void*);

この関数は、任意のコマンド行を使用して Natural セッションを初期化します。 コマンド行の構文と語義は、Natural を対話形式で開始した場合と同じです。 すでに任意のインターフェイスインスタンスによって Natural セッションが初期化されている場合は、新しいセッションが初期化される前に、そのセッションが暗黙的に初期化解除されます。

コマンド行は、ユーザーの操作がなくても Natural の初期化が完了するように指定する必要があります。 つまり、プログラムがスタックに渡されたり、起動プログラムが指定されたりしている場合には特に、満たされていない INPUT ステートメントをプログラムでスタックから実行ないでください。 実行した場合は、Natural セッションの後続の動作が不確定になります。

Natural セッションは、バッチセッションとしてサーバーモードで初期化されます。 このことは、実行された Natural モジュールにおける特定のステートメントおよびコマンドの使用が制限されることを意味します。 このような制限およびエラー状態は、『オペレーション』ドキュメントの「NaturalX サーバー環境でのステートメントおよびコマンドの使用」セクションの説明と同じです。

Natural Security で Natural セッションを初期化するときは、セッションを開始するために自由に選択したデフォルトライブラリに対する LOGON コマンド、および適切なユーザー ID やパスワードをコマンド行に含める必要があります。

例：

int iRes = 
pnni_func->nni_initialize( pnni_func, "STACK=(LOGON,MYLIB,MYUSER,MYPASS)", 0, 0);

この後にアプリケーションで異なるユーザー ID を使用して別のライブラリに対して nni_logon を呼び出し、その後 nni_logoff を呼び出すと、nni_initialize で渡されたライブラリおよびユーザー ID に対して Natural セッションがリセットされます。

パラメータ

リターンコード

リターンコードの意味については、「リターンコード」の説明を参照してください。

nni_is_initialized

構文

int nni_is_initialized( void* pnni_func, int* piIsInit );

この関数は、インターフェイスインスタンスに初期化済みの Natural セッションが含まれているかどうかをチェックします。

パラメータ

リターンコード

リターンコードの意味については、「リターンコード」の説明を参照してください。

nni_uninitialize

構文

int nni_uninitialize(void* pnni_func);

この関数は、指定したインターフェイスインスタンスによってホストされている Natural セッションを初期化解除します。

パラメータ

リターンコード

リターンコードの意味については、「リターンコード」の説明を参照してください。

nni_enter

構文

int nni_enter(void* pnni_func);

この関数は、現在のスレッドで、インターフェイスインスタンスおよびホストする Natural セッションへの排他的アクセスを待機できるようにします。 スレッドは、他のスレッドに中断されない一連のインターフェイスコールを発行するときに、この関数を呼び出します。 スレッドは、nni_leave を呼び出して、インターフェイスインスタンスへの排他的アクセスを解放します。

パラメータ

リターンコード

リターンコードの意味については、「リターンコード」の説明を参照してください。

nni_try_enter

構文

int nni_try_enter(void* pnni_func);

この関数は、nni_enter と同様に機能しますが、スレッドをブロックする代わりに、通常、即座に値を返します。 すでに別のスレッドがインターフェイスインスタンスに排他アクセスを行っている場合は、NNI_RC_LOCKED を返します。

パラメータ

リターンコード

リターンコードの意味については、「リターンコード」の説明を参照してください。

nni_leave

構文

int nni_leave(void* pnni_func);

この関数は、インターフェイスインスタンスへの排他的アクセスを解放し、そのインスタンスおよびホストする Natural セッションに他のスレッドがアクセスできるようにします。

パラメータ

リターンコード

リターンコードの意味については、「リターンコード」の説明を参照してください。

nni_logon

構文

int nni_logon(void* pnni_func, const char* szLibrary, const char* szUser, const char* szPassword);

この関数は、指定された Natural ライブラリに対する LOGON を実行します。

パラメータ

リターンコード

リターンコードの意味については、「リターンコード」の説明を参照してください。

nni_logoff

構文

int nni_logoff(void* pnni_func); 

この関数は、現在の Natural ライブラリからの LOGOFF を実行します。 以前のアクティブなライブラリおよびユーザー ID に LOGON することと同じです。

パラメータ

リターンコード

リターンコードの意味については、「リターンコード」の説明を参照してください。

nni_callnat

構文

int nni_callnat(void* pnni_func, const char* szName, int iParm, struct parameter_description* rgDesc, struct natural_exception* pExcep);

関数が Natural サブプログラムを呼び出します。

関数は、パラメータを parameter_description 構造の配列として受け取ります。 呼び出し元は、NNI 関数を使用して、次の方法でこれらの構造を作成します。

• 関数 create_parm または create_module_parm を使用すると、サブプログラムの適切なパラメータセットを作成できます。

• create_parm を使用した場合、関数 init_parm_* を使用して、各パラメータを適切な Natural データフォーマットに初期化します。 create_module_parm を使用した場合、パラメータはすでに適切な Natural データフォーマットに初期化されています。

• 関数 nni_put_parm または nni_put_parm_array を使用すると、値を各パラメータに割り当てることができます。

• セット内の各パラメータで nni_get_parm を呼び出します。 これにより、parameter_description 構造に値が指定されます。

• parameter_description 構造の配列を関数 nni_callnat に渡します。

• コールが実行されたら、関数 nni_get_parm または nni_get_parm_array を使用して、パラメータセットから修正されたパラメータ値を抽出します。

パラメータ

リターンコード

リターンコードの意味については、「リターンコード」の説明を参照してください。

nni_function

構文

int nni_callnat(void* pnni_func, const char* szName, int iParm, struct parameter_description* rgDesc, struct natural_exception* pExcep);

関数が Natural サブプログラムを呼び出します。

関数は、パラメータを parameter_description 構造の配列として受け取ります。 呼び出し元は、NNI 関数を使用して、次の方法でこれらの構造を作成します。

• 関数 create_parm または create_module_parm を使用すると、サブプログラムの適切なパラメータセットを作成できます。

• create_parm を使用した場合、関数 init_parm_* を使用して、各パラメータを適切な Natural データフォーマットに初期化します。 create_module_parm を使用した場合、パラメータはすでに適切な Natural データフォーマットに初期化されています。

• 関数 nni_put_parm または nni_put_parm_array を使用すると、値を各パラメータに割り当てることができます。

• セット内の各パラメータで nni_get_parm を呼び出します。 これにより、parameter_description 構造に値が指定されます。

• parameter_description 構造の配列を関数 nni_callnat に渡します。

• コールが実行されたら、関数 nni_get_parm または nni_get_parm_array を使用して、パラメータセットから修正されたパラメータ値を抽出します。

パラメータ

リターンコード

リターンコードの意味については、「リターンコード」の説明を参照してください。

nni_create_object

構文

int nni_create_object(void* pnni_func, const char* szName, int iParm, struct parameter_description* rgDesc, struct natural_exception* pExcep); 

Natural オブジェクト（Natural クラスのインスタンス）を作成します。

関数は、パラメータを、parameter_description 構造の 1 つの要素の配列として受け取ります。 呼び出し元は、NNI 関数を使用して、次の方法でこれらの構造を作成します。

• 関数 nni_create_parm を使用すると、1 つの要素を含むパラメータセットを作成できます。

• 関数 nni_init_parm_s を使用すると、タイプ HANDLE OF OBJECT のパラメータを初期化できます。

• このパラメータで nni_get_parm_info を呼び出します。 これにより、parameter_description 構造に値が指定されます。

• parameter_description 構造を関数 nni_create_object に渡します。

• コールが実行された後、関数 nni_get_parm の 1 つを使用して、パラメータセットから修正されたパラメータ値を抽出します。

rgDesc で渡されたパラメータの意味は、次のとおりです。

• 最初かつ唯一のパラメータは、データタイプ HANDLE OF OBJECT で初期化する必要があります。リターン時にはこのパラメータに、新しく作成されたオブジェクトの Natural オブジェクトハンドルが含まれます。

パラメータ

リターンコード

リターンコードの意味については、「リターンコード」の説明を参照してください。

nni_send_method

構文

int nni_send_method(void* pnni_func, const char* szName, int iParm, struct parameter_description* rgDesc, struct natural_exception* pExcep);

Natural オブジェクト（Natural クラスのインスタンス）にメソッドコールを送ります。

関数は、パラメータを parameter_description 構造の配列として受け取ります。 呼び出し元は、NNI 関数を使用して、次の方法でこれらの構造を作成します。

• 関数 nni_create_parm または nni_create_method_parm を使用すると、一致するパラメータセットを作成できます。

• create_parm を使用した場合、関数 init_parm_* を使用して、各パラメータを適切な Natural データフォーマットに初期化します。 nni_create_method_parm を使用した場合、パラメータはすでに適切な Natural データフォーマットに初期化されています。

• 関数 nni_put_parm または nni_put_parm_array を使用すると、値を各パラメータに割り当てることができます。

• セット内の各パラメータで nni_get_parm_info を呼び出します。 これにより、parameter_description 構造に値が指定されます。

• parameter_description 構造の配列を関数 nni_send_method に渡します。

• コールが実行されたら、関数 nni_get_parm の 1 つを使用して、パラメータセットから修正されたパラメータ値を抽出します。

rgDesc で渡されたパラメータの意味は、次のとおりです。

• 最初のパラメータには、オブジェクトハンドルが含まれています。

• 2 つ目のパラメータは、メソッドの戻り値のデータタイプに初期化する必要があります。 メソッドに戻り値がない場合、2 つ目のパラメータは初期化されないままです。 メソッドコールからのリターン時には、このパラメータにメソッドの戻り値が含まれます。

• 残りのパラメータはメソッドパラメータです。

パラメータ

リターンコード

リターンコードの意味については、「リターンコード」の説明を参照してください。

nni_get_property

構文

int nni_get_property(void* pnni_func, const char* szName, int iParm, struct parameter_description* rgDesc, struct natural_exception* pExcep); 

Natural オブジェクト（Natural クラスのインスタンス）のプロパティ値を取得します。

関数は、パラメータを parameter_description 構造の配列として受け取ります。 呼び出し元は、NNI 関数を使用して、次の方法でこれらの構造を作成します。

• 関数 nni_create_parm または nni_create_method_parm を使用すると、一致するパラメータセットを作成できます。

• create_parm を使用した場合、関数 init_parm_* を使用して、各パラメータを適切な Natural データフォーマットに初期化します。 create_method_parm を使用した場合、パラメータはすでに適切な Natural データフォーマットに初期化されています。

• 関数 nni_put_parm または nni_put_parm_array を使用すると、値を各パラメータに割り当てることができます。

• セット内の各パラメータで nni_get_parm_info を呼び出します。 これにより、parameter_description 構造に値が指定されます。

• parameter_description 構造の配列を関数 nni_send_method に渡します。

• コールが実行されたら、関数 nni_get_parm の 1 つを使用して、パラメータセットから修正されたパラメータ値を抽出します。

rgDesc で渡されたパラメータの意味は、次のとおりです。

• 最初のパラメータには、オブジェクトハンドルが含まれています。

• 2 つ目のパラメータは、プロパティのデータタイプに初期化されまます。 プロパティアクセスからのリターン時には、このパラメータにプロパティ値が含まれています。

パラメータ

リターンコード

リターンコードの意味については、「リターンコード」の説明を参照してください。

nni_set_property

構文

int nni_set_property(void* pnni_func, const char* szName, int iParm, struct parameter_description* rgDesc, struct natural_exception* pExcep);

Natural オブジェクト（Natural クラスのインスタンス）にプロパティ値を割り当てます。

関数は、パラメータを parameter_description 構造の配列として受け取ります。 呼び出し元は、NNI 関数を使用して、次の方法でこれらの構造を作成します。

• 関数 nni_create_parm または nni_create_prop_parm を使用して、一致するパラメータセットを作成します。

• create_parm を使用した場合、関数 init_parm_* を使用して、各パラメータを適切な Natural データフォーマットに初期化します。 create_prop_parm を使用した場合、パラメータはすでに適切な Natural データフォーマットに初期化されています。 関数 nni_put_parm の 1 つを使用して、各パラメータに値を割り当てます。

• 関数 nni_put_parm または nni_put_parm_array を使用すると、値を各パラメータに割り当てることができます。

• セット内の各パラメータで nni_get_parm_info を呼び出します。 これにより、parameter_description 構造に値が指定されます。

• parameter_description 構造の配列を関数 nni_set_property に渡します。

rgDesc で渡されたパラメータの意味は、次のとおりです。

• 最初のパラメータには、オブジェクトハンドルが含まれています。

• 2 つ目のパラメータには、プロパティ値が含まれています。

パラメータ

リターンコード

リターンコードの意味については、「リターンコード」の説明を参照してください。

nni_delete_object

構文

int nni_delete_object(void* pnni_func, int iParm, struct parameter_description* rgDesc, struct natural_exception* pExcep);

nni_create_object で作成した Natural オブジェクト（Natural クラスのインスタンス）を削除します。

関数は、パラメータを、parameter_description 構造の 1 つの要素の配列として受け取ります。 呼び出し元は、NNI 関数を使用して、次の方法でこれらの構造を作成します。

• 関数 nni_create_parm を使用すると、1 つの要素を含むパラメータセットを作成できます。

• 関数 nni_init_parm_s を使用すると、タイプ HANDLE OF OBJECT のパラメータを初期化できます。

• 関数 nni_put_parm の 1 つを使用して、パラメータに値を割り当てます。

• このパラメータで nni_get_parm_info を呼び出します。 これにより、parameter_description 構造に値が指定されます。

• parameter_description 構造を関数 nni_delete_object に渡します。

rgDesc で渡されたパラメータの意味は、次のとおりです。

• 最初かつ唯一のパラメータは、データタイプ HANDLE OF OBJECT で初期化する必要があります。このパラメータには、削除される オブジェクトの Natural オブジェクトハンドルが含まれています。

パラメータ

リターンコード

リターンコードの意味については、「リターンコード」の説明を参照してください。

nni_create_parm

構文

int nni_create_parm(void* pnni_func, int iParm, void** pparmhandle);

Natural モジュールに渡すことができるパラメータセットを作成します。

セットに含まれているパラメータは、まだ Natural の特定のデータタイプに初期化されていません。 このパラメータを nni_callnat、nni_create_object、nni_send_method、nni_set_property、または nni_get_property へのコールで使用する前に、次の手順が必要です。

• 関数 nni_init_parm_s、nni_init_parm_sa、nni_init_parm_d、nni_init_parm_da のうちの 1 つを使用して、各パラメータを必要な Natural データタイプに初期化します。

• 関数 nni_put_parm または nni_put_parm_array を使用すると、値を各パラメータに割り当てることができます。

• 関数 nni_get_parm_info を使用して、各パラメータを parm_description 構造に変更します。

パラメータ

リターンコード

リターンコードの意味については、「リターンコード」の説明を参照してください。

nni_create_module_parm

構文

int nni_create_module_parm(void* pnni_func, char chType, const char* szName, void** pparmhandle); 

nni_callnat へのコールで使用できるパラメータセットを作成します。 この関数を使用すると、呼び出し可能な Natural モジュールの署名をアプリケーションでダイナミックに検索できます。

返されるセットに含まれているパラメータは、指定されたモジュールのパラメータデータエリアに従って、すでに Natural データタイプに初期化されています。 このパラメータセットを nni_callnat へのコールで使用する前に、次の手順が必要です。

• 関数 nni_put_parm または nni_put_parm_array を使用すると、値を各パラメータに割り当てることができます。

• 関数 nni_get_parm_info を使用して、各パラメータを parm_description 構造に変更します。

パラメータ

リターンコード

リターンコードの意味については、「リターンコード」の説明を参照してください。

nni_create_method_parm

構文

int nni_create_method_parm( void* pnni_func, const char* szClass, const char* szMethod, void** pparmhandle ); 

nni_send_method へのコールで使用できるパラメータセットを作成します。 この関数を使用すると、Natural クラスのメソッドの署名をアプリケーションでダイナミックに検索できます。

返されるパラメータセットには、メソッドパラメータだけでなく、nni_send_method で必要なその他のパラメータも含まれています。 つまり、メソッドに n 個のパラメータがある場合、パラメータセットには n + 2 個のパラメータが含まれることになります。

• セットの最初のパラメータは、データタイプ HANDLE OF OBJECT に初期化されます。

• セットの 2 つ目のパラメータは、メソッドの戻り値のデータタイプに初期化されます。 メソッドに戻り値がない場合、2 つ目のパラメータは初期化されません。

• セットの残りのパラメータは、メソッドパラメータのデータタイプに初期化されます。

このパラメータセットを nni_send_method へのコールで使用する前に、次の手順が必要です。

• 関数 nni_put_parm または nni_put_parm_array を使用すると、値を各パラメータに割り当てることができます。

• 関数 nni_get_parm_info を使用して、各パラメータを parm_description 構造に変更します。

パラメータ

リターンコード

リターンコードの意味については、「リターンコード」の説明を参照してください。

nni_create_prop_parm

構文

int nni_create_prop_parm(void* pnni_func, const char* szClass, const char* szProp,void** pparmhandle); 

nni_get_property または nni_set_property へのコールで使用できるパラメータセットを作成します。 返されるパラメータセットには、nni_get_property または nni_set_property で必要となるすべてのパラメータが含まれます。 この関数を使用すると、Natural クラスのプロパティのデータタイプをアプリケーションで決定できます。

• セットの最初のパラメータは、データタイプ HANDLE OF OBJECT に初期化されます。

• セットの 2 つ目のパラメータは、プロパティのデータタイプに初期化されます。

このパラメータセットを nni_get_property または nni_set_property へのコールで使用する前に、次の手順が必要です。

• 関数 nni_put_parm または nni_put_parm_array を使用すると、値を各パラメータに割り当てることができます。

• 関数 nni_get_parm_info を使用して、各パラメータを parm_description 構造に変更します。

パラメータ

リターンコード

リターンコードの意味については、「リターンコード」の説明を参照してください。

nni_parm_count

構文

int nni_parm_count( void* pnni_func, void* parmhandle, int* piParm )

この関数は、パラメータセット内のパラメータの数を取得します。

パラメータ

リターンコード

リターンコードの意味については、「リターンコード」の説明を参照してください。

nni_init_parm_s

構文

int nni_init_parm_s(void* pnni_func, int iParm, void* parmhandle, char chFormat, int iLength, int iPrecision, int iFlags); 

パラメータセット内のパラメータをスタティックデータタイプに初期化します。

パラメータ

リターンコード

リターンコードの意味については、「リターンコード」の説明を参照してください。

nni_init_parm_sa

構文

int nni_init_parm_sa (void* pnni_func, int iParm, void* parmhandle, char chFormat, int iLength, int iPrecision, int iDim, int* rgiOcc, int iFlags); 

パラメータセット内のパラメータをスタティックデータタイプの配列に初期化します。

パラメータ

リターンコード

リターンコードの意味については、「リターンコード」の説明を参照してください。

nni_init_parm_d

構文

int nni_init_parm_d(void* pnni_func, int iParm, void* parmhandle, char chFormat, int iFlags); 

パラメータセット内のパラメータをダイナミックデータタイプに初期化します。

パラメータ

リターンコード

リターンコードの意味については、「リターンコード」の説明を参照してください。

nni_init_parm_da

構文

int nni_init_parm_da (void* pnni_func, int iParm, void* parmhandle, char chFormat, int iDim, int* rgiOcc, int iFlags); 

パラメータセット内のパラメータをダイナミックデータタイプの配列に初期化します。

パラメータ

リターンコード

リターンコードの意味については、「リターンコード」の説明を参照してください。

nni_get_parm_info

構文

int nni_get_parm_info (void* pnni_func, int iParm, void* parmhandle, struct parameter_description* pDesc); 

パラメータセット内の特定のパラメータに関する詳細情報を返します。

パラメータ

リターンコード

リターンコードの意味については、「リターンコード」の説明を参照してください。

nni_get_parm

構文

int nni_get_parm(void* pnni_func, int iParm, void* parmhandle, int iBufferLength, void* pBuffer); 

パラメータセット内の特定のパラメータの値を返します。 pBuffer で指定されたアドレスのバッファに、iBufferLength に指定されたサイズで値が返されます。 値が正常に返されると、このバッファには Natural 内部フォーマットのデータが含まれます。 バッファの内容を解釈する方法については、「Natural データタイプ」を参照してください。

Natural データタイプに基づくパラメータの長さが iBufferLength よりも長い場合は、Natural によってデータが指定された長さに切り捨てられ、コード NNI_RC_DATA_TRUNC が返されます。 呼び出し元は、関数 nni_get_parm_info を使用して、パラメータ値の長さを事前に要求できます。

Natural データタイプに基づくパラメータの長さが iBufferLength よりも短い場合は、Natural によってパラメータの長さまでバッファが埋められ、リターンコードにコピーされたデータの長さが返されます。

パラメータが配列である場合は、バッファ内の配列全体が返されます。 このことは、固定サイズ要素の固定サイズ配列に対してのみ意味があります。これは、これ以外の場合には呼び出し元がバッファの内容を解釈できないためです。 任意の配列の個別オカレンスを取得するには、関数 nni_get_parm_array を使用します。

pBuffer に指定されたアドレスに割り当てられた iBufferLength で、メモリのサイズが指定されていない場合、操作の結果は予測できません。 Natural では、pBuffer が NULL ではないことのみがチェックされます。

パラメータ

リターンコード

リターンコードの意味については、「リターンコード」の説明を参照してください。

nni_get_parm_array

構文

int nni_get_parm_array(void* pnni_func, int parmnum, void* parmhandle, int iBufferLength, void* pBuffer, int* rgiInd);

パラメータセット内の特定の配列パラメータの特定のオカレンスの値を返します。 nni_get_parm との唯一の違いは、配列インデックスを指定できる点です。 未使用の次元のインデックス数は、0 として指定する必要があります。

パラメータ

リターンコード

リターンコードの意味については、「リターンコード」の説明を参照してください。

nni_get_parm_array_length

構文

int nni_get_parm_array_length(void* pnni_func, int iParm, void* parmhandle, int* piLength, int* rgiInd);

パラメータセット内の特定の配列パラメータの特定のオカレンスの長さを返します。

パラメータ

リターンコード

リターンコードの意味については、「リターンコード」の説明を参照してください。

nni_put_parm

構文

int nni_put_parm(void* pnni_func, int iParm, void* parmhandle, int iBufferLength, const void* pBuffer); 

パラメータセット内の特定のパラメータに値を割り当てます。 pBuffer で指定されたアドレスのバッファ内の関数に、iBufferLength に指定されたサイズで値が渡されます。 バッファの内容を作成する方法については、「Natural データタイプ」を参照してください。

Natural データタイプに基づくパラメータの長さが、指定されたバッファの長さよりも短い場合、データは指定されたパラメータの長さに切り捨てられます。 バッファの残りは無視されます。 Natural データタイプに基づくパラメータの長さが、指定されたバッファの長さよりも長い場合、データは指定されたバッファの長さまでしかコピーされず、パラメータ値の残りはそのまま残ります。 Natural データタイプの内部的な長さについては、「Natural データタイプ」を参照してください。

パラメータがダイナミック変数である場合は、指定されたバッファの長さに従って、自動的にサイズ変更されます。

パラメータが配列である場合、関数ではバッファ内の配列全体が要求されます。 このことは、固定サイズ要素の固定サイズ配列に対してのみ意味があります。これは、これ以外の場合には呼び出し元がバッファの内容を解釈できないためです。 任意の配列の個々のオカレンスの値を割り当てるには、関数 nni_put_parm_array を使用します。

パラメータ

リターンコード

リターンコードの意味については、「リターンコード」の説明を参照してください。

nni_put_parm_array

構文

int nni_put_parm_array(void* pnni_func, int iParm, void* parmhandle, int iBufferLength, const void* pBuffer, int* rgiInd);

パラメータセット内の特定の配列パラメータの特定のオカレンスに値を割り当てます。 nni_get_parm との唯一の違いは、配列インデックスを指定できる点です。 未使用の次元のインデックス数は、0 として指定する必要があります。

パラメータ

リターンコード

リターンコードの意味については、「リターンコード」の説明を参照してください。

nni_resize_parm_array

構文

int nni_resize_parm_array(void* pnni_func, int iParm, void* parmhandle, int* rgiOcc); 

パラメータセット内の特定の X-array パラメータのオカレンス数を変更します。 n 次元配列では、すべての n 次元についてオカレンス数を指定する必要があります。 配列の次元が 3 次元未満の場合は、値 0 を使用しない次元に指定する必要があります。

この関数では、任意の X-array について下限または上限の適切な方を変更することによって、各次元のオカレンス数のサイズ変更が試行されます。

パラメータ

リターンコード

リターンコードの意味については、「リターンコード」の説明を参照してください。

nni_delete_parm

構文

int nni_delete_parm(void* pnni_func, void* parmhandle);

指定されたパラメータセットを削除します。

パラメータ

リターンコード

リターンコードの意味については、「リターンコード」の説明を参照してください。

nni_from_string

構文

int nni_from_string(void* pnni_func, const char* szString, char chFormat, int iLength, int iPrecision, int iBufferLength, void* pBuffer); 

Natural P 値、N 値、D 値、または T 値の文字列表現を、関数 nni_get_parm、nni_get_parm_array、nni_put_parm、および nni_put_parm_array で使用されるような値の内部表現に変換します。

これらの Natural データタイプの文字列表現は、次のようになります。

パラメータ

リターンコード

リターンコードの意味については、「リターンコード」の説明を参照してください。

nni_to_string

構文

int nni_to_string(void* pnni_func, int iBufferLength, const void* pBuffer, char chFormat, int iLength, int iPrecision, int iStringLength, char* szString);

Natural P 値、N 値、D 値、または T 値の内部表現を、関数 nni_get_parm、nni_get_parm_array、nni_put_parm、および nni_put_parm_array で使用されるような文字列表現に変換します。

これらの Natural データタイプの文字列表現は、関数 nni_from_string で説明したものと同じです。

パラメータ

リターンコード

リターンコードの意味については、「リターンコード」の説明を参照してください。

www.softwareag.com

Copyright © Software AG 1992-2008. All rights reserved.

検索   索引   目次   |   PDF BOOKS   |   ホーム   上へ   戻る   次へ