API de SOAP › API de gestión de escenarios › Inicio del trabajo: create_session()

Inicio del trabajo: create_session()

La función de la API create_session permite la autenticación frente al servicio de control y devuelve el ID de la sesión. Transfiere el ID de sesión como un argumento cuando se llama a otras funciones de la API. La sesión abierta se puede invalidar mediante la API close_session.

Argumentos

La función de API create_session incluye los argumentos descritos en la tabla siguiente:

Valores de retorno

Cuando la autenticación mediante create_session sea correcta, esta función devuelve un valor uint con el ID de sesión y un argumento de error_code establecido como 0. De lo contrario, se devuelve el valor uint MAX (0xFFFFFFFF) y el argumento error_code contiene el código de error detallado.

Nota: Debería especificar el argumento nombre_usuario en el formulario <NOMBRE_DOMINIO>\<NOMBRE_USUARIO>. Por ejemplo, test_dominio\Administrador.

Ejemplos

Ejemplo 1: Creación de un objeto de servicios web.

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

Ejemplo 2: Creación de una sesión.

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;
        }