Cross platform C header for obtaining paths to user configuration files and directories
Switch branches/tags
Nothing to show
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
.gitignore
Makefile
README.md
cfgpath.h
shlobj.h
test-linux.c
test-win.c

README.md

cfgpath.h: Cross platform methods for obtaining paths to configuration files

Copyright 2013 Adam Nielsen malvineous@shikadi.net


This is a simple header file that provides a handful of functions to obtain paths to configuration files, regardless of the operating system the application is running under.

It requires no dependencies beyond each platform's standard API.

This code is placed in the public domain. You are free to use it for any purpose. If you add new platform support, please contribute a patch!

Basic use:

#include "cfgpath.h"

char cfgdir[MAX_PATH];
get_user_config_file(cfgdir, sizeof(cfgdir), "myapp");
if (cfgdir[0] == 0) {
    printf("Unable to find home directory.\n");
    return 1;
}
printf("Saving configuration file to %s\n", cfgdir);

To integrate it into your own project, just copy cfgpath.h. All the other files are for testing to make sure it works correctly, so you don't need them unless you intend to make changes and send me a patch.

Supported platforms are currently:

  • Linux
  • Mac OS X
  • Windows

Patches adding support for more platforms would be greatly appreciated.