SOAP API › シナリオ管理 API › 作業開始： create_session()

作業開始： create_session()

create_session API 関数を使用すると、コントロール サービスに対する認証を実行でき、セッション ID が返されます。このセッション ID は、他の API 関数の呼び出し時に引数として渡されます。オープン セッションは、close_session API を使用して無効にすることができます。

引数

create_session API 関数には、以下のテーブルに記述されている引数が含まれています。

戻り値

create_session を使用した認証が成功した場合、この関数はセッション ID を含む uint 値を返します。また、error_code 引数が 0 に設定されます。それ以外の場合、MAX uint 値（0xFFFFFFFF）が返され、error_code 引数には詳細なエラー コードが含まれます。

注：user_name 引数は、<DOMAIN_NAME>\<USER_NAME> という形式で指定する必要があります。たとえば、test_domain\Administrator というように指定します。

例

例 1：Web サービス オブジェクトの作成。

xosoapapi_c get_mng()
        {
            xosoapapi_c mng = new xosoapapi_c();
            return mng;
        }

例 2：セッションの作成。

public bool create_session_example()
        {
            try
            {
                uint err = 0;
                string user_name = global::api_examples.Properties.Settings.Default.user_name;
                string password = global::api_examples.Properties.Settings.Default.password;
                _session_id = get_mng().create_session(user_name, password, out err);
                if (_session_id == 0xffffffff)
                {
                    return false;
                }
                return true;
            }
            catch (Exception ex)
            {
                System.Windows.Forms.MessageBox.Show(ex.Message);
            }
            return false;
        }