kc3-lang/SDL/visualtest/docs/latex/sut__configparser_8c.tex

• Show log

  Commit

• Hash : 9c398852
  Author :
  Date : 2014-11-22T22:20:40
  

  Corrected header file documentation comment.

Download

• visualtest/docs/latex/sut__configparser_8c.tex

• \hypertarget{sut__configparser_8c}{\section{C\-:/\-Users/\-D\-E\-L\-L/\-Work/sdlvisualtest/visualtest/src/sut\-\_\-configparser.c File Reference}
  \label{sut__configparser_8c}\index{C\-:/\-Users/\-D\-E\-L\-L/\-Work/sdlvisualtest/visualtest/src/sut\-\_\-configparser.\-c@{C\-:/\-Users/\-D\-E\-L\-L/\-Work/sdlvisualtest/visualtest/src/sut\-\_\-configparser.\-c}}
  }
  {\ttfamily \#include $<$limits.\-h$>$}\\*
  {\ttfamily \#include $<$string.\-h$>$}\\*
  {\ttfamily \#include $<$S\-D\-L\-\_\-test.\-h$>$}\\*
  {\ttfamily \#include $<$S\-D\-L\-\_\-rwops.\-h$>$}\\*
  {\ttfamily \#include \char`\"{}S\-D\-L\-\_\-visualtest\-\_\-sut\-\_\-configparser.\-h\char`\"{}}\\*
  {\ttfamily \#include \char`\"{}S\-D\-L\-\_\-visualtest\-\_\-parsehelper.\-h\char`\"{}}\\*
  {\ttfamily \#include \char`\"{}S\-D\-L\-\_\-visualtest\-\_\-rwhelper.\-h\char`\"{}}\\*
  \subsection*{Functions}
  \begin{DoxyCompactItemize}
  \item 
  int \hyperlink{sut__configparser_8c_a8e178cd8a1f279f5d2cf908545e97544}{S\-D\-L\-Visual\-Test\-\_\-\-Parse\-S\-U\-T\-Config} (char $\ast$file, \hyperlink{struct_s_d_l_visual_test___s_u_t_config}{S\-D\-L\-Visual\-Test\-\_\-\-S\-U\-T\-Config} $\ast$config)
  \item 
  void \hyperlink{sut__configparser_8c_a1bddf9732c0d3ed1c24455d22193de9a}{S\-D\-L\-Visual\-Test\-\_\-\-Free\-S\-U\-T\-Config} (\hyperlink{struct_s_d_l_visual_test___s_u_t_config}{S\-D\-L\-Visual\-Test\-\_\-\-S\-U\-T\-Config} $\ast$config)
  \end{DoxyCompactItemize}
  
  
  \subsection{Detailed Description}
  Source file for the parser for S\-U\-T config files. 
  
  \subsection{Function Documentation}
  \hypertarget{sut__configparser_8c_a1bddf9732c0d3ed1c24455d22193de9a}{\index{sut\-\_\-configparser.\-c@{sut\-\_\-configparser.\-c}!S\-D\-L\-Visual\-Test\-\_\-\-Free\-S\-U\-T\-Config@{S\-D\-L\-Visual\-Test\-\_\-\-Free\-S\-U\-T\-Config}}
  \index{S\-D\-L\-Visual\-Test\-\_\-\-Free\-S\-U\-T\-Config@{S\-D\-L\-Visual\-Test\-\_\-\-Free\-S\-U\-T\-Config}!sut_configparser.c@{sut\-\_\-configparser.\-c}}
  \subsubsection[{S\-D\-L\-Visual\-Test\-\_\-\-Free\-S\-U\-T\-Config}]{\setlength{\rightskip}{0pt plus 5cm}void S\-D\-L\-Visual\-Test\-\_\-\-Free\-S\-U\-T\-Config (
  \begin{DoxyParamCaption}
  \item[{{\bf S\-D\-L\-Visual\-Test\-\_\-\-S\-U\-T\-Config} $\ast$}]{config}
  \end{DoxyParamCaption}
  )}}\label{sut__configparser_8c_a1bddf9732c0d3ed1c24455d22193de9a}
  Free any resources associated with the config object pointed to by {\ttfamily config}. \hypertarget{sut__configparser_8c_a8e178cd8a1f279f5d2cf908545e97544}{\index{sut\-\_\-configparser.\-c@{sut\-\_\-configparser.\-c}!S\-D\-L\-Visual\-Test\-\_\-\-Parse\-S\-U\-T\-Config@{S\-D\-L\-Visual\-Test\-\_\-\-Parse\-S\-U\-T\-Config}}
  \index{S\-D\-L\-Visual\-Test\-\_\-\-Parse\-S\-U\-T\-Config@{S\-D\-L\-Visual\-Test\-\_\-\-Parse\-S\-U\-T\-Config}!sut_configparser.c@{sut\-\_\-configparser.\-c}}
  \subsubsection[{S\-D\-L\-Visual\-Test\-\_\-\-Parse\-S\-U\-T\-Config}]{\setlength{\rightskip}{0pt plus 5cm}int S\-D\-L\-Visual\-Test\-\_\-\-Parse\-S\-U\-T\-Config (
  \begin{DoxyParamCaption}
  \item[{char $\ast$}]{file, }
  \item[{{\bf S\-D\-L\-Visual\-Test\-\_\-\-S\-U\-T\-Config} $\ast$}]{config}
  \end{DoxyParamCaption}
  )}}\label{sut__configparser_8c_a8e178cd8a1f279f5d2cf908545e97544}
  Parses a configuration file that describes the command line options an S\-U\-T application will take and populates a S\-U\-T config object. All lines in the config file must be smaller than
  
  
  \begin{DoxyParams}{Parameters}
  {\em file} & Path to the configuration file. \\
  \hline
  {\em config} & Pointer to an object that represents an S\-U\-T configuration.\\
  \hline
  \end{DoxyParams}
  \begin{DoxyReturn}{Returns}
  zero on failure, non-\/zero on success 
  \end{DoxyReturn}
  

Download