logout()

構文

1connection.logout();

使用方法

このコールは、コールを発行したログインユーザーのセッションを終了させます。引数は不要です。

ログインユーザー以外のユーザーによって開始された 1 つ以上のセッションを終了させる方法については、「invalidateSessions()」を参照してください。

サンプルコード — Java

このサンプルでは logout() をコールし、現在のユーザーをログアウトして、メッセージをコンソールに書き込みます。

1public void logoutSample() {
2   try {
3      connection.logout();
4      System.out.println("Logged out.");
5   } catch (ConnectionException ce) {
6      ce.printStackTrace();
7   }
8}

サンプルコード — C#

このサンプルでは logout() をコールし、現在のユーザーをログアウトして、メッセージをコンソールに書き込みます。

1public void logoutSample()
2{
3   try
4   {
5      binding.logout();
6      Console.WriteLine("Logged out.");
7   }
8   catch (SoapException e)
9   {
10      Console.WriteLine("An unexpected error has occurred: " +
11                                 e.Message + "\n" + e.StackTrace);
12   }
13}

引数

このコールは、引数を使用しません。コールを発行したログインユーザーのセッションを終了させるため、引数は不要です。ログインユーザーは、このコール用に SessionHeader 内で指定された sessionId によって判別されます。

応答

void が返されます。コールの失敗エラーが、セッションがすでにログアウトされていることを意味しているため、結果は必要ありません。システム利用不能などの予期せぬエラーは、クライアントアプリケーションによって処理される必要があるエラーを発生させます。

障害

UnexpectedErrorFault