Main Page   Class Hierarchy   Alphabetical List   Compound List   File List   Compound Members   File Members  

panda/src/express/get_config_path.h

Go to the documentation of this file.
00001 // Filename: get_config_path.h
00002 // Created by:  drose (01Jul00)
00003 //
00004 ////////////////////////////////////////////////////////////////////
00005 //
00006 // PANDA 3D SOFTWARE
00007 // Copyright (c) 2001, Disney Enterprises, Inc.  All rights reserved
00008 //
00009 // All use of this software is subject to the terms of the Panda 3d
00010 // Software license.  You should have received a copy of this license
00011 // along with this source code; you will also find a current copy of
00012 // the license at http://www.panda3d.org/license.txt .
00013 //
00014 // To contact the maintainers of this program write to
00015 // panda3d@yahoogroups.com .
00016 //
00017 ////////////////////////////////////////////////////////////////////
00018 
00019 #ifndef GET_CONFIG_PATH_H
00020 #define GET_CONFIG_PATH_H
00021 
00022 #include <pandabase.h>
00023 
00024 #include <dSearchPath.h>
00025 
00026 ////////////////////////////////////////////////////////////////////
00027 //     Function: get_config_path
00028 //  Description: A generic function for reading path strings
00029 //               (e.g. model-path, texture-path, etc.) from the Config
00030 //               database.  It automatically handles concatenating
00031 //               together multiple appearances of the indicated
00032 //               variable name as a single long path string.
00033 //
00034 //               static_ptr must be a statically-defined string
00035 //               pointer, unique to each different config_var_name.
00036 //               It should be initialized to NULL.  This will
00037 //               automatically be allocated and filled with the string
00038 //               path the first time this function is called;
00039 //               thereafter, the same string value will be returned.
00040 //               This allows the function to work during static init
00041 //               time when we can't be sure what has or hasn't been
00042 //               already initialized.
00043 ////////////////////////////////////////////////////////////////////
00044 EXPCL_PANDAEXPRESS DSearchPath &
00045 get_config_path(const string &config_var_name, DSearchPath *&static_ptr);
00046 
00047 #endif

Generated on Fri May 2 00:38:23 2003 for Panda by doxygen1.3