uci.h-Dateireferenz

#include <stdio.h>

gehe zum Quellcode dieser Datei

Makrodefinitionen
#define	UCI_UCI_EXTENSION   ".uci"
#define	UCI_CFG_EXTENSION   ".cfg"
#define	UCI_DEF_EXTENSION   ".def"
#define	UCI_HLP_EXTENSION   ".hlp"
#define	UCI_TYPE_STR   "str"
#define	UCI_TYPE_IP   "ip"
#define	UCI_TYPE_INT   "int"
#define	UCI_TYPE_CB   "cb"
#define	UCI_TYPE_STR   "str"
#define	UCI_TYPE_SEL   "sel"
#define	UCI_TYPE_RB   "rb"
#define	UCI_TYPE_BIT   "bits"
#define	UCI_TYPE_TXT   "txt"
#define	UciCloseUci(FilePointer)   fclose(FilePointer)
#define	UciCloseCfg(FilePointer)   fclose(FilePointer)
#define	UciCloseDef(FilePointer)   fclose(FilePointer)
#define	UciCloseHlp(FilePointer)   fclose(FilePointer)

Aufzählungen
enum	UciSelType { UciSelTypeBut, UciSelTypeTab, UciSelTypeSel }

Funktionen
FILE *	UciOpenWr (char *Pfad, char *BaseName, char *Extension)
FILE *	UciOpenUciWr (char *Pfad, char *BaseName)
	Öffnen einer UCI cfg Datei
void	UciWrUciHdr (FILE *FilePointer, char *CfgName, UciSelType SelType)
void	UciWrUciTab (FILE *FilePointer, char *TabName, char *SubDir)
FILE *	UciOpenCfgWr (char *Pfad, char *BaseName)
	Öffnen einer UCI cfg Datei
void	UciWrCfgInt (FILE *FilePointer, char *Name, int Wert)
void	UciWrCfgStr (FILE *FilePointer, char *Name, char *Wert)
FILE *	UciOpenDefWr (char *Pfad, char *BaseName)
	Öffnen einer UCI cfg Datei
void	UciWrDefHdr (FILE *FilePointer, char *BaseName)
void	UciWrDefTxt (FILE *FilePointer, char *Name, unsigned int MinChars, unsigned int MaxChars, char *HelpText)
void	UciWrDefStr (FILE *FilePointer, char *Name, unsigned int MinChars, unsigned int MaxChars, char *HelpText)
void	UciWrDefInt (FILE *FilePointer, char *Name, int MinVal, int MaxVal, char *HelpText)
void	UciWrDefIp (FILE *FilePointer, char *Name, char *HelpText)
void	UciWrDefCb (FILE *FilePointer, char *Name, char *HelpText)
void	UciWrDefSel (FILE *FilePointer, char *Name, char *SelText, char *HelpText)
void	UciWrDefRb (FILE *FilePointer, char *Name, char *RbText, char *HelpText)
void	UciWrDefBits (FILE *FilePointer, char *Name, char *BitText, char *HelpText)
void	UciWrTxt (FILE *DefFilePointer, FILE *CfgFilePointer, char *Name, unsigned int MinChars, unsigned int MaxChars, char *Value)
void	UciWrInt (FILE *DefFilePointer, FILE *CfgFilePointer, char *Name, int MinVal, int MaxVal, int Value)
FILE *	UciOpenHlpWr (char *Pfad, char *BaseName)
	Öffnen einer UCI cfg Datei
void	UciWrHlp (FILE *FilePointer, char *Name, char *Beschreibung)

Ausführliche Beschreibung

Makro-Dokumentation

#define UCI_CFG_EXTENSION   ".cfg"

#define UCI_DEF_EXTENSION   ".def"

#define UCI_HLP_EXTENSION   ".hlp"

#define UCI_TYPE_BIT   "bits"

#define UCI_TYPE_CB   "cb"

#define UCI_TYPE_INT   "int"

#define UCI_TYPE_IP   "ip"

#define UCI_TYPE_RB   "rb"

#define UCI_TYPE_SEL   "sel"

#define UCI_TYPE_STR   "str"

#define UCI_TYPE_STR   "str"

#define UCI_TYPE_TXT   "txt"

#define UCI_UCI_EXTENSION   ".uci"

#define UciCloseCfg

(

FilePointer

)

fclose(FilePointer)

#define UciCloseDef

(

FilePointer

)

fclose(FilePointer)

#define UciCloseHlp

(

FilePointer

)

fclose(FilePointer)

#define UciCloseUci

(

FilePointer

)

fclose(FilePointer)

Dokumentation der Aufzählungstypen

enum UciSelType

Aufzählungswerte:

UciSelTypeBut
UciSelTypeTab
UciSelTypeSel

Dokumentation der Funktionen

FILE* UciOpenCfgWr	(	char *	Pfad,
		char *	BaseName
	)

Öffnen einer UCI cfg Datei

Diese Funktion wird aufgerufen, wenn auf einem Socket Daten gelesen werden können. Die Funktion hat folgende Parameter:

Parameter

[in]	Pfad	Verzeichnis, in dem die UCI Dateien liegen.
[in]	BaseName	Name der UCI Datei ohne Extension. Die .uci Datei bekommt den Basisnamen, der auch in dem Link (Formular) auf dieses Verzeichnis eingetragen ist. Die .def und zugehörige .cfg Datei bekommt den Basisnamen, der auch in die .uci Datei als Konfigseite eingetragen ist.

Rückgabe

Pointer auf Filestruktur oder NULL im Fehlerfall.

FILE* UciOpenDefWr	(	char *	Pfad,
		char *	BaseName
	)

Öffnen einer UCI cfg Datei

Diese Funktion wird aufgerufen, wenn auf einem Socket Daten gelesen werden können. Die Funktion hat folgende Parameter:

Parameter

[in]	Pfad	Verzeichnis, in dem die UCI Dateien liegen.
[in]	BaseName	Name der UCI Datei ohne Extension. Die .uci Datei bekommt den Basisnamen, der auch in dem Link (Formular) auf dieses Verzeichnis eingetragen ist. Die .def und zugehörige .cfg Datei bekommt den Basisnamen, der auch in die .uci Datei als Konfigseite eingetragen ist.

Rückgabe

Pointer auf Filestruktur oder NULL im Fehlerfall.

FILE* UciOpenHlpWr	(	char *	Pfad,
		char *	BaseName
	)

Öffnen einer UCI cfg Datei

Diese Funktion wird aufgerufen, wenn auf einem Socket Daten gelesen werden können. Die Funktion hat folgende Parameter:

Parameter

[in]	Pfad	Verzeichnis, in dem die UCI Dateien liegen.
[in]	BaseName	Name der UCI Datei ohne Extension. Die .uci Datei bekommt den Basisnamen, der auch in dem Link (Formular) auf dieses Verzeichnis eingetragen ist. Die .def und zugehörige .cfg Datei bekommt den Basisnamen, der auch in die .uci Datei als Konfigseite eingetragen ist.

Rückgabe

Pointer auf Filestruktur oder NULL im Fehlerfall.

FILE* UciOpenUciWr	(	char *	Pfad,
		char *	BaseName
	)

Öffnen einer UCI cfg Datei

Diese Funktion wird aufgerufen, wenn auf einem Socket Daten gelesen werden können. Die Funktion hat folgende Parameter:

Parameter

[in]	Pfad	Verzeichnis, in dem die UCI Dateien liegen.
[in]	BaseName	Name der UCI Datei ohne Extension. Die .uci Datei bekommt den Basisnamen, der auch in dem Link (Formular) auf dieses Verzeichnis eingetragen ist. Die .def und zugehörige .cfg Datei bekommt den Basisnamen, der auch in die .uci Datei als Konfigseite eingetragen ist.

Rückgabe

Pointer auf Filestruktur oder NULL im Fehlerfall.

FILE* UciOpenWr	(	char *	Pfad,
		char *	BaseName,
		char *	Extension
	)

void UciWrCfgInt	(	FILE *	FilePointer,
		char *	Name,
		int	Wert
	)

void UciWrCfgStr	(	FILE *	FilePointer,
		char *	Name,
		char *	Wert
	)

void UciWrDefBits	(	FILE *	FilePointer,
		char *	Name,
		char *	BitText,
		char *	HelpText
	)

void UciWrDefCb	(	FILE *	FilePointer,
		char *	Name,
		char *	HelpText
	)

void UciWrDefHdr	(	FILE *	FilePointer,
		char *	BaseName
	)

void UciWrDefInt	(	FILE *	FilePointer,
		char *	Name,
		int	MinVal,
		int	MaxVal,
		char *	HelpText
	)

void UciWrDefIp	(	FILE *	FilePointer,
		char *	Name,
		char *	HelpText
	)

void UciWrDefRb	(	FILE *	FilePointer,
		char *	Name,
		char *	RbText,
		char *	HelpText
	)

void UciWrDefSel	(	FILE *	FilePointer,
		char *	Name,
		char *	SelText,
		char *	HelpText
	)

void UciWrDefStr	(	FILE *	FilePointer,
		char *	Name,
		unsigned int	MinChars,
		unsigned int	MaxChars,
		char *	HelpText
	)

void UciWrDefTxt	(	FILE *	FilePointer,
		char *	Name,
		unsigned int	MinChars,
		unsigned int	MaxChars,
		char *	HelpText
	)

void UciWrHlp	(	FILE *	FilePointer,
		char *	Name,
		char *	Beschreibung
	)

void UciWrInt	(	FILE *	DefFilePointer,
		FILE *	CfgFilePointer,
		char *	Name,
		int	MinVal,
		int	MaxVal,
		int	Value
	)

void UciWrTxt	(	FILE *	DefFilePointer,
		FILE *	CfgFilePointer,
		char *	Name,
		unsigned int	MinChars,
		unsigned int	MaxChars,
		char *	Value
	)

void UciWrUciHdr	(	FILE *	FilePointer,
		char *	CfgName,
		UciSelType	SelType
	)

void UciWrUciTab	(	FILE *	FilePointer,
		char *	TabName,
		char *	SubDir
	)