環境情報をサーバ側に伝えるための擬似オブジェクトインタフェースです。

CORBA::Contextは環境情報をサーバ側に伝えるためのクラスです。最初にコンテキストのインスタンスを得るには、CORBA::ORB::get_default_context関数を呼び出してデフォルトコンテキストを取得します。コンテキストに子コンテキストを作ることで、コンテキストに階層を持たせることができます。コンテキストを階層化することで、標準の環境設定とオプションの(または一時的な)環境設定とを分離することができます。ひとつのコンテキストには複数の環境設定値(プロパティ値)を設定することができます。これらのプロパティ値はCORBA::NVListのインスタンスとして保持されています。

context_name	コンテキスト名を取得する
parent	親コンテキストを取得する
create_child	子コンテキストを作成する
set_one_value	プロパティ値を1つ設定する
set_values	複数のプロパティ値を設定する
delete_values	複数のプロパティ値を削除する
get_values	複数のプロパティ値を取得する
_duplicate	コンテキストの論理的コピーを作る
_nil	nilコンテキストを取得する

関連項目

CORBA::ORB::get_default_context

名前

CORBA::Context::context_name - コンテキスト名を取得する

形式

#include <orb.h>

const char* CORBA::Context::context_name(
	CORBA::Environment& env = Ob_default_environment()
) const;

機能説明

CORBA::Context::context_nameはコンテキストの名前を返します。

envは、関数を呼び出した後、例外の有無を調べるために指定します(オプション)。

戻り値

コンテキストの名前を返します。

エラー

CORBAシステム例外がthrowされます。

関連項目

CORBA::Context::crate_child,

動的起動インタフェース(DII)

注意

戻り値を削除してはいけません。

名前

CORBA::Context::parent - 親コンテキストを取得する

形式

#include <orb.h>

CORBA::Context_ptr CORBA::Context::parent(
	CORBA::Environment& env = Ob_default_environment()
) const;

機能説明

CORBA::Context::parentは親コンテキストを返します。コンテキストには親子関係があり、parentを呼び出すと該当するコンテキストの親コンテキストが返ります。

デフォルトコンテキストに対して呼び出すとnilオブジェクトが返ります。

envは、関数を呼び出した後、例外の有無を調べるために指定します(オプション)。

戻り値

親コンテキストを返します。

エラー

CORBAシステム例外がthrowされます。

関連項目

CORBA::Context::crate_child,

動的起動インタフェース(DII)

名前

CORBA::Context::create_child - 子コンテキストを作成する

形式

#include <orb.h>

CORBA::Status CORBA::Context::create_child(
	const char* ctx_name,
	CORBA::Context_ptr& child_ctx,
	CORBA::Environment& env = Ob_default_environment()
);

機能説明

CORBA::Context::create_childは名前がctx_nameの子コンテキストを作成し、作成した子コンテキストをout引数child_ctxに返します。

envは、関数を呼び出した後、例外の有無を調べるために指定します(オプション)。

戻り値

作成できた場合はCORBA::Status_Successを返します。それ以外はCORBA::Status_Failedを返します。

エラー

CORBAシステム例外がthrowされます。

関連項目

CORBA::Context::parent,

動的起動インタフェース(DII)

名前

CORBA::Context::set_one_value - プロパティ値を1つ設定する

形式

#include <orb.h>

CORBA::Status CORBA::Context::set_one_value(
	const char* prop_name,
	const CORBA::Any& value,
	CORBA::Environment& env = Ob_default_environment()
);

機能説明

CORBA::Context::set_one_valueは名前がprop_nameで値がvalueのプロパティ値をコンテキストに設定します。valueはCORBA::Any型ですが、このCORBA::Any型に設定できる値は文字列だけです。

envは、関数を呼び出した後、例外の有無を調べるために指定します(オプション)。

戻り値

設定できた場合はCORBA::Status_Successを返します。それ以外はCORBA::Status_Failedを返します。

エラー

CORBAシステム例外がthrowされます。

関連項目

CORBA::Context::set_values,

CORBA::Context::delete_values,

CORBA::Context::get_values,

CORBA::ORB::get_default_context,

動的起動インタフェース(DII)

名前

CORBA::Context::set_values - 複数のプロパティ値を設定する

形式

#include <orb.h>

CORBA::Status CORBA::Context::set_values(
	CORBA::NVList_ptr values,
	CORBA::Environment& env = Ob_default_environment()
);

機能説明

CORBA::Context::set_valuesはプロパティの名前と値のペアを1つ以上コンテキストに登録します。

valuesはCORBA::NVList型で表現されるプロパティのリストです。valuesにプロパティを設定するときは、CORBA::NVList::add_value関数を使います。そのとき、第1引数にはプロパティ名、第2引数にはプロパティ値、第3引数には0を指定します。プロパティ値はCORBA::Any型で指定しますが、その内容は文字列でなければなりません。

envは、関数を呼び出した後、例外の有無を調べるために指定します(オプション)。

戻り値

設定できた場合はCORBA::Status_Successを返します。それ以外はCORBA::Status_Failedを返します。

エラー

CORBAシステム例外がthrowされます。

関連項目

CORBA::Context::set_one_value,

CORBA::Context::delete_values,

CORBA::Context::get_values,

CORBA::ORB::get_default_context,

引き数リストを表すインターフェース,

動的起動インタフェース(DII)

名前

CORBA::Context::delete_values - 複数のプロパティ値を削除する

形式

#include <orb.h>

CORBA::Status CORBA::Context::delete_values(
	const char* prop_name,
	CORBA::Environment& env = Ob_default_environment()
);

機能説明

CORBA::Context::delete_valuesはprop_nameと一致する名前のプロパティ値を削除します。prop_nameの最後に限りワイルドカード("*")を使うことができます。そのときは文字列の先頭からワイルドカードの前までが一致するすべてのプロパティ値が削除されます。

envは、関数を呼び出した後、例外の有無を調べるために指定します(オプション)。

戻り値

削除できた場合はCORBA::Status_Successを返します。それ以外はCORBA::Status_Failedを返します。

エラー

CORBAシステム例外がthrowされます。

関連項目

CORBA::Context::set_one_value,

CORBA::Context::set_values,

CORBA::Context::get_values,

CORBA::ORB::get_default_context,

動的起動インタフェース(DII)

名前

CORBA::Context::get_values - 複数のプロパティ値を取得する

形式

#include <orb.h>

CORBA::Status CORBA::Context::get_values(
	const char* start_scope,
	CORBA::Flags op_flags,
	const char* prop_name,
	CORBA::NVList_ptr& values,
	CORBA::Environment& env = Ob_default_environment()
);

機能説明

CORBA::Context::get_valuesは検索の結果一致したプロパティ値のリストをvaluesに返します。

start_scopeには検索を開始するスコープ名を指定します。

op_flagsには検索する方法を指定します。op_flagsにはCORBA::CTX_RESTRICT_SCOPEを指定したときは、検索を開始したコンテキストだけを検索します。それ以外を指定したときは検索を開始したコンテキストからデフォルトコンテキストまで親コンテキスト方向に検索します。

prop_nameには検索するプロパティ名を指定します。プロパティ名の文字列の最後に限りワイルドカード("*")を使うことができます。そのときは文字列の先頭からワイルドカードの前までが一致するすべてのプロパティ値を返します。

envは、関数を呼び出した後、例外の有無を調べるために指定します(オプション)。

戻り値

プロパティ値が返された場合はCORBA::Status_Successを返し、valuesにプロパティ値のリストを返します。それ以外はCORBA::Status_Failedを返します。

エラー

CORBAシステム例外がthrowされます。

関連項目

CORBA::Context::set_one_value,

CORBA::Context::set_values,

CORBA::Context::delete_values,

CORBA::ORB::get_default_context,

引き数リストを表すインターフェース,

動的起動インタフェース(DII)

名前

CORBA::Context::_duplicate - コンテキストの論理的コピーを作る

形式

#include <orb.h>

CORBA::Context_ptr CORBA::Context::_duplicate(
	CORBA::Context_ptr p,
	CORBA::Environment& env = Ob_default_environment()
);

機能説明

CORBA::Context::_duplicateは引数pの論理的コピーを作ります。

envは、関数を呼び出した後、例外の有無を調べるために指定します(オプション)。

戻り値

引数pの論理的コピーを返します。

エラー

CORBAシステム例外がthrowされます。

関連項目

CORBA::Context::parent,

CORBA::ORB::get_default_context,

動的起動インタフェース(DII)

名前

CORBA::Context::_nil - nil Contextを取得する

形式

#include <orb.h>

CORBA::Context_ptr CORBA::Context::_nil(
	CORBA::Environment& env = Ob_default_environment()
);

機能説明

CORBA::Context::_nilはnilコンテキストを返します。

envは、関数を呼び出した後、例外の有無を調べるために指定します(オプション)。

戻り値

nilコンテキストを返します。

エラー

CORBAシステム例外がthrowされます。

関連項目

CORBA::ORB::get_default_context,

動的起動インタフェース(DII)