Changeset - a90602b890f3
[Not reviewed]
default
0 1 0
Nathan Brink (binki) - 16 years ago 2009-04-06 20:38:36
ohnobinki@ohnopublishing.net
remoteio: some more API docs
1 file changed with 4 insertions and 3 deletions:
0 comments (0 inline, 0 general)
src/common/options.h
Show inline comments
 
@@ -34,20 +34,21 @@
 
struct options_common
 
{
 
  char *remoteio_rsh;
 
  char *remoteio_user;
 
  struct remoteio_opts *remoteio;
 
};
 

	
 
/**
 
  This function needs to eat some of your arguments to it, just like gtk+ and other libs like to. It particularly needs to be able to find the location of the config file, which should be taken from arguments if it's there. The argument list will have members that I recognize removed.
 
  
 
  Options should be kept alive during the program's life.
 
  
 
  *mycfg will be set to the section of the configuration file specific to the caller (client or server specific section)
 
  
 
  *allopts will be set to a pointer that many functions need for operation
 
  \param mycfg will be set to the section of the configuration file specific to the caller (client or server specific section)
 
  \param allopts will be set to a pointer that many functions need for operation
 
  \param argc the argc that was passed to main()
 
  \param argv the argv that was passed to main()
 
 */
 
int options_init(int argc, char *argv[], cfg_t **mycfg, struct options_common **allopts);
 

	
 
int options_free(struct options_common *allopts);
 
#endif
0 comments (0 inline, 0 general)