Application.UserAppDataPath プロパティとは何？わかりやすく解説 Weblio辞書

.NET Framework クラスライブラリリファレンス

索引トップ用語の索引ランキング

Application.UserAppDataPath プロパティ

ユーザーのアプリケーションデータのパスを取得します。

名前空間: System.Windows.Forms
アセンブリ: System.Windows.Forms (system.windows.forms.dll 内)
構文

Visual Basic (宣言)

Public Shared ReadOnly Property
 UserAppDataPath As String

Visual Basic (使用法)

Dim value As String

value = Application.UserAppDataPath

public static string UserAppDataPath
 { get; }

C++

public:
static property String^ UserAppDataPath {
    String^ get ();
}

/** @property */
public static String get_UserAppDataPath ()

JScript

public static function get
 UserAppDataPath () : String

プロパティ値
ユーザーのアプリケーションデータのパス。

解説

パスが存在しない場合は、次の形式で作成されます。

ベースパス\ CompanyName \ ProductName \ ProductVersion

このパスに格納されるデータは、ローミングが有効になっているユーザープロファイルの一部です。ローミングユーザーは、ネットワーク上の複数のコンピュータで作業します。ローミングユーザーのユーザープロファイルは、ネットワーク上のサーバーで保持され、ユーザーがログオンするとシステムに読み込まれます。ローミングを検討しているユーザーのプロファイルについては、オペレーティングシステムがローミングプロファイルをサポートし、ローミングプロファイルを有効にしておく必要があります。

通常、ベースパスは C:\Documents and Settings\username\Application Data になります。

使用例

2 つのフォームを表示し、両方のフォームが閉じられたときにアプリケーションを終了するコード例を、次に示します。アプリケーションの開始時と終了時に、各フォームの位置が記憶されます。この例では、UserAppDataPath プロパティを使用してユーザーのアプリケーションデータを格納します。

MyApplicationContext クラスは、ApplicationContext の継承クラスで、各フォームがいつ閉じられたのかを追跡し、両方のフォームが閉じられたときに現在のスレッドを終了します。このクラスは、ユーザーの代わりに各フォームの位置を格納します。フォームの位置データは、Appdata.txt という名前のファイルに格納されます。このファイルは、UserAppDataPath で指定された場所に作成されます。Main メソッドは、Application.Run(context) を呼び出すことにより、ApplicationContext を指定してアプリケーションを起動します。

このコードは、ApplicationContext クラスの概要で紹介されている例からの抜粋です。簡略にするため、コードの一部は示されていません。コード全体については、ApplicationContext を参照してください。

Visual Basic

Public Sub New()
    MyBase.New()
    formCount = 0

    ' Handle the ApplicationExit event to know when the application
 is exiting.
    AddHandler Application.ApplicationExit, AddressOf
 OnApplicationExit

    Try
        ' Create a file that the application will store user specific
 data in.
        userData = New FileStream(Application.UserAppDataPath
 + "\appdata.txt", FileMode.OpenOrCreate)

    Catch e As IOException
        ' Inform the user that an error occurred.
        MessageBox.Show("An error occurred while attempting to
 show the application." + _
                        "The error is:" + e.ToString())

        ' Exit the current thread instead of showing the windows.
        ExitThread()
    End Try

    ' Create both application forms and handle the Closed event
    ' to know when both forms are closed.
    form1 = New AppForm1()
    AddHandler form1.Closed, AddressOf OnFormClosed
    AddHandler form1.Closing, AddressOf OnFormClosing
    formCount = formCount + 1

    form2 = New AppForm2()
    AddHandler form2.Closed, AddressOf OnFormClosed
    AddHandler form2.Closing, AddressOf OnFormClosing
    formCount = formCount + 1

    ' Get the form positions based upon the user specific data.
    If (ReadFormDataFromFile()) Then
        ' If the data was read from the file, set the form
        ' positions manually.
        form1.StartPosition = FormStartPosition.Manual
        form2.StartPosition = FormStartPosition.Manual

        form1.Bounds = form1Position
        form2.Bounds = form2Position
    End If

    ' Show both forms.
    form1.Show()
    form2.Show()
End Sub

Private Sub OnApplicationExit(ByVal
 sender As Object, ByVal
 e As EventArgs)
    ' When the application is exiting, write the application data to
 the
    ' user file and close it.
    WriteFormDataToFile()

    Try
        ' Ignore any errors that might occur while closing the file
 handle.
        userData.Close()
    Catch
    End Try
End Sub

private MyApplicationContext() {
    formCount = 0;

    // Handle the ApplicationExit event to know when the application
 is exiting.
    Application.ApplicationExit += new EventHandler(this.OnApplicationExit);

    try {
        // Create a file that the application will store user specific
 data in.
        userData = new FileStream(Application.UserAppDataPath
 + "\\appdata.txt", FileMode.OpenOrCreate);

    } catch(IOException e) {
        // Inform the user that an error occurred.
        MessageBox.Show("An error occurred while attempting
 to show the application." + 
                        "The error is:" + e.ToString());

        // Exit the current thread instead of showing the windows.
        ExitThread();
    }

    // Create both application forms and handle the Closed event
    // to know when both forms are closed.
    form1 = new AppForm1();
    form1.Closed += new EventHandler(OnFormClosed);          
  
    form1.Closing += new CancelEventHandler(OnFormClosing);  
          
    formCount++;

    form2 = new AppForm2();
    form2.Closed += new EventHandler(OnFormClosed);          
  
    form2.Closing += new CancelEventHandler(OnFormClosing);  
          
    formCount++;

    // Get the form positions based upon the user specific data.
    if (ReadFormDataFromFile()) {
        // If the data was read from the file, set the form
        // positions manually.
        form1.StartPosition = FormStartPosition.Manual;
        form2.StartPosition = FormStartPosition.Manual;
        
        form1.Bounds = form1Position;
        form2.Bounds = form2Position;
    }

    // Show both forms.
    form1.Show();
    form2.Show();
}

private void OnApplicationExit(object sender,
 EventArgs e) {
    // When the application is exiting, write the application data to
 the
    // user file and close it.
    WriteFormDataToFile();

    try {
        // Ignore any errors that might occur while closing the file
 handle.
        userData.Close();
    } catch {}
}

C++

   MyApplicationContext()
   {
      formCount = 0;
      
      // Handle the ApplicationExit event to know when the application
 is exiting.
      Application::ApplicationExit += gcnew EventHandler( this,
 &MyApplicationContext::OnApplicationExit );
      try
      {
         
         // Create a file that the application will store user specific
 data in.
         userData = gcnew FileStream( String::Concat( Application::UserAppDataPath,
 "\\appdata.txt" ),FileMode::OpenOrCreate );
      }
      catch ( IOException^ e ) 
      {
         
         // Inform the user that an error occurred.
         MessageBox::Show( "An error occurred while attempting
 to show the application. The error is: {0}", dynamic_cast<String^>(e)
 );
         
         // Exit the current thread instead of showing the windows.
         ExitThread();
      }

      
      // Create both application forms and handle the Closed event
      // to know when both forms are closed.
      form1 = gcnew AppForm1;
      form1->Closed += gcnew EventHandler( this, &MyApplicationContext::OnFormClosed
 );
      form1->Closing += gcnew CancelEventHandler( this, &MyApplicationContext::OnFormClosing
 );
      formCount++;
      form2 = gcnew AppForm2;
      form2->Closed += gcnew EventHandler( this, &MyApplicationContext::OnFormClosed
 );
      form2->Closing += gcnew CancelEventHandler( this, &MyApplicationContext::OnFormClosing
 );
      formCount++;
      
      // Get the form positions based upon the user specific data.
      if ( ReadFormDataFromFile() )
      {
         
         // If the data was read from the file, set the form
         // positions manually.
         form1->StartPosition = FormStartPosition::Manual;
         form2->StartPosition = FormStartPosition::Manual;
         form1->Bounds = form1Position;
         form2->Bounds = form2Position;
      }

      
      // Show both forms.
      form1->Show();
      form2->Show();
   }

   void OnApplicationExit( Object^ /*sender*/, EventArgs^ /*e*/
 )
   {
      
      // When the application is exiting, write the application data to
 the
      // user file and close it.
      WriteFormDataToFile();
      try
      {
         
         // Ignore any errors that might occur while closing the file
 handle.
         userData->Close();
      }
      catch ( Exception^ ) 
      {
      }

   }


private:

private MyApplicationContext()
{
    formCount = 0;

    // Handle the ApplicationExit event to know 
    // when the application is exiting.
    Application.add_ApplicationExit(new EventHandler(
        this.OnApplicationExit));
    try {
        // Create a file that the application will store 
        // user specific data in.
        userData = new FileStream(Application.get_UserAppDataPath()
 
            + "\\appdata.txt", FileMode.OpenOrCreate);
    }
    catch (IOException e) {
        // Inform the user that an error occurred.
        MessageBox.Show("An error occurred while attempting
 to show the "
            + " application. The error is:" + e.ToString());

        // Exit the current thread instead of showing the windows.
        ExitThread();
    }

    // Create both application forms and handle the Closed event
    // to know when both forms are closed.
    form1 = new AppForm1();
    form1.add_Closed(new EventHandler(OnFormClosed));
    form1.add_Closing(new CancelEventHandler(OnFormClosing));
    formCount++;
    form2 = new AppForm2();
    form2.add_Closed(new EventHandler(OnFormClosed));
    form2.add_Closing(new CancelEventHandler(OnFormClosing));
    formCount++;

    // Get the form positions based upon the user specific data.
    if (ReadFormDataFromFile()) {
        // If the data was read from the file, set the form
        // positions manually.
        form1.set_StartPosition(FormStartPosition.Manual);
        form2.set_StartPosition(FormStartPosition.Manual);
        form1.set_Bounds(form1Position);
        form2.set_Bounds(form2Position);
    }

    // Show both forms.
    form1.Show();
    form2.Show();
} //MyApplicationContext

private void OnApplicationExit(Object sender,
 EventArgs e)
{
    // When the application is exiting, write the application data to
 the
    // user file and close it.
    WriteFormDataToFile();
    try {
        // Ignore any errors that might occur while closing the file
 handle.
        userData.Close();
    }
    catch (System.Exception exp) {
    }
} //OnApplicationExit