Click here to Skip to main content
Click here to Skip to main content

Application Data Utility Class

, 27 Apr 2002
Rate this:
Please Sign up or sign in to vote.
ApplicationData is a generic utility library class for managing an application's data

Introduction

This article introduces a class ApplicationData that simplifies an application's data management

According to the "Designed for Windows XP spec v2.3" you should Classify application data into the following categories:

  • Per user, roaming
  • Per user, non-roaming
  • Per computer (non-user specific and non-roaming)"
NOTE: The three categories are named here as: User, LocalUser and Common respectively.

Knowing where to store files and registry settings for each of this categories can be complicated and require repeating code. This utility class tries to simplify this process. Furthermore, the spec requires that application data should be stored under:

[company name]\[product name]\[version]

The required information is extracted from the assembly attributes (e.g. AssemblyCompanyAttribute), therefore it is highly recommended to fill the appropriate attributes (typically in AssemblyInfo.cs) when using this utility.

Example locations:

  • C:\Documents and Settings\All Users\Application Data\My Company\My Product\1.0.840.34747\Sub1\Sub2\My File.txt
  • "HKEY_CURRENT_USER\Software\My Company\My Product\1.0.840.34747\Local\Sub1\Sub1"

Usage Examples:

// Working with files: 
		
FileInfo file = ApplicationData.LocalUser["Sub1"]["Sub2"].GetFile("file.txt"); 
StreamWriter writer = file.CreateText(); 
writer.WriteLine("This is a test of ApplicationData!"); 
writer.Close(); 
		
// Working with the registry:
 
RegistryKey key = ApplicationData.LocalUser["Sub1"]["Sub2"].GetRegistryKey(); 
key.SetValue("Test", "This is a test!");

Classes used in this utility library include:

System.Windows.Forms.Application which has very useful properties such as: Application.LocalUserAppDataPath, Application.CommonAppDataRegistry, etc...

System.WeakReference which is used to store the references for the three static root instances (Common, LocalUser and User). By using the weak references I don't have to recreate the instances each time they are needed and they can be garbage collected if not used. (see ApplicationData.GetAppDataByType() for implementation)


I hope this utility comes in handy. I would appreciate any comments or suggestions you may have!

License

This article has no explicit license attached to it but may contain usage terms in the article text or the download files themselves. If in doubt please contact the author via the discussion board below.

A list of licenses authors might use can be found here

About the Author

Michael Mumcuoglu

United States United States
No Biography provided

Comments and Discussions

 
GeneralAbsolute path PinmemberMark E Lawrence19-Aug-08 13:40 
GeneralThanks! Pinmemberaxelriet20-Nov-05 0:53 
GeneralIsolatedStorage PinmemberAndy Smith28-Apr-02 20:06 
GeneralRe: IsolatedStorage PinmemberMichael Mumcuoglu30-Apr-02 11:59 
GeneralRe: IsolatedStorage PinmemberJohn Fairbanks31-Mar-09 7:34 

General General    News News    Suggestion Suggestion    Question Question    Bug Bug    Answer Answer    Joke Joke    Rant Rant    Admin Admin   

Use Ctrl+Left/Right to switch messages, Ctrl+Up/Down to switch threads, Ctrl+Shift+Left/Right to switch pages.

| Advertise | Privacy | Mobile
Web04 | 2.8.140721.1 | Last Updated 28 Apr 2002
Article Copyright 2002 by Michael Mumcuoglu
Everything else Copyright © CodeProject, 1999-2014
Terms of Service
Layout: fixed | fluid