cgicookie.txt

用C些的CGI函数库

		
		函数原型：
			BOOL GetCookieDebugFileName( char *pcDebugPathFileName );
		输入参数：
			（无）
		输出参数：
			char *pcDebugPathFileName	调试日志文件名
		返回值：
			BOOL						总是返回 TRUE
		
		详细描述与注意事项：
			（无）
		示例代码：
			char buffer[256+1];
			SetCookieDebugFileName( buffer );
		相关函数：
			SetCookieDebugFileName

		·CGICookieListInitial
		初始化cookie链表容器
		
		函数原型：
			SList *CGICookieListInitial();
		输入参数：
			（无）
		返回值：
			SList *		总是返回iLibX.List链表初始化值
		
		详细描述与注意事项：
			（无）
		示例代码：
			SList *plist = NULL ;
			plist = CGICookieListInitial() ;
		相关函数：
			CGICookieListDestroy

		·CGICookieListDestroy
		销毁cookie链表容器
		
		函数原型：
			BOOL CGICookieListDestroy( SList **listCookie );
		输入参数：
			SList **listCookie		cookie链表容器的地址
		返回值：
			销毁成功，返回 TRUE
			销毁失败，返回 FALSE
		
		详细描述与注意事项：
			（无）
		示例代码：
			CGICookieListDestroy( &plist );
		相关函数：
			CGICookieListInitial , FreeCGICookieData

		CGICookieInfoInitial
		初始化cookie属性容器
		
		函数原型：
			SCookieInfo *CGICookieInfoInitial();
		输入参数：
			（无）
		返回值：
			SCookieInfo *		在堆上创建cookie属性容器
		
		详细描述与注意事项：
			（无）
		示例代码：
			SList *plist = NULL ;
			plist = CGICookieInfoInitial() ;
		相关函数：
			CGICookieInfoDestroy

		CGICookieInfoDestroy
		销毁cookie属性容器
		
		函数原型：
			BOOL CGICookieListDestroy( SCookieInfo **listCookie );
		输入参数：
			SCookieInfo **listCookie		cookie属性容器的地址
		返回值：
			销毁成功，返回 TRUE
			销毁失败，返回 FALSE
		
		详细描述与注意事项：
			（无）
		示例代码：
			CGICookieListDestroy( &plist );
		相关函数：
			CGICookieInfoInitial

		·CGICookieReadData
		装载浏览器端发送到服务器端的cookie数据到链表容器
		
		函数原形：
			BOOL CGICookieReadData( SList **listCookie )
		输入参数：
			SList **listCookie	cookie链表容器的地址
		返回值：
			读取成功，返回值 TRUE
			读取失败或者没有表单数据，返回 FALSE
		
		详细描述与注意事项：
			（无）
		示例代码：
			CGICookieReadData( &plist );
		相关函数：
			CGICookieWriteData
		
		·CGICookieWriteData
		写cookie数据给浏览器
		
		函数原形：
			BOOL CGICookieWriteData( SList **listCookie , SCookieInfo *info )
		输入参数：
			SList **listCookie	cookie链表容器的地址
		返回值：
			读取成功，返回值 TRUE
			读取失败或者没有表单数据，返回 FALSE
		
		详细描述与注意事项：
			（无）
		示例代码：
			CGICookieWriteData( &plist , &info );
		相关函数：
			CGICookieReadData
		
		·CGICookieGetValue
		从cookie链表容器中通过cookie键读取cookie值
		
		函数原型：
			char *CGICookieGetValue( SList *listCookie , char *name );
		输入参数：
			SList *listCookie		cookie链表容器
			char *name			表单域名
		返回值：
			char *				cookie链表容器中表单域值的内存首地址
		
		详细描述与注意事项：
			（无）
		示例代码：
			textfieldUserName = CGICookieGetValue( plist , "textfieldUserName" ) ;
		相关函数：
			CGICookieGetValueSize

		·CGICookieAddItem
		向cookie链表容器中添加cookie键值项
		
		函数原型：
			BOOL CGICookieAddItem( SList **listCookie , char *key , char *value );
		输入参数：
			SList *listCookie		cookie链表容器
			char *key				cookie键
			char *value				cookie值
		返回值：
			BOOL				成功，返回 TRUE
								失败，返回 FALSE
		
		详细描述与注意事项：
			（无）
		示例代码：
			bret = CGICookieAddItem( &plist , "cookieUserName" , "root" ) ;
		相关函数：
			CGICookieEditItem , CGICookieDeleteItem , CGICookieSetItem
			
		·CGICookieEditItem
		向cookie链表容器中修改cookie键值项
		
		函数原型：
			BOOL CGICookieEditItem( SList **listCookie , char *key , char *value );
		输入参数：
			SList *listCookie		cookie链表容器
			char *key				cookie键
			char *value				cookie值
		返回值：
			BOOL				成功，返回 TRUE
								失败，返回 FALSE
		
		详细描述与注意事项：
			（无）
		示例代码：
			bret = CGICookieEditItem( &plist , "cookiePassword" , "root" ) ;
		相关函数：
			CGICookieAddItem , CGICookieDeleteItem , CGICookieSetItem
			
		·CGICookieDeleteItem
		向cookie链表容器中删除一个cookie键项
		
		函数原型：
			BOOL CGICookieDeleteItem( SList **listCookie , char *key );
		输入参数：
			SList *listCookie		cookie链表容器
			char *key				cookie键
		返回值：
			BOOL				成功，返回 TRUE
								失败，返回 FALSE
		
		详细描述与注意事项：
			（无）
		示例代码：
			bret = CGICookieDeleteItem( &plist , "cookiePassword" , "root" ) ;
		相关函数：
			CGICookieAddItem , CGICookieEditItem , CGICookieSetItem
			
		·CGICookieSetItem
		向cookie链表容器中设置一个cookie键值项
		
		函数原型：
			BOOL CGICookieSetItem( SList **listCookie , char *key , char *value );
		输入参数：
			SList *listCookie		cookie链表容器
			char *key				cookie键
			char *value				cookie值
		返回值：
			BOOL				成功，返回 TRUE
								失败，返回 FALSE
		
		详细描述与注意事项：
			（无）
		示例代码：
			bret = CGICookieSetItem( &plist , "cookiePassword" , "root" ) ;
		相关函数：
			CGICookieAddItem , CGICookieEditItem , CGICookieDeleteItem

		·CGICookieSetExprires
		设置cookie属性容器中的时间信息
		
		函数原型：
			BOOL CGICookieSetExprires( SCookieInfo *info , struct tm *time_tm );
		输入参数：
			SCookieInfo *info		cookie属性容器
			struct tm *time_tm		系统时间结构
		返回值：
			BOOL				成功，返回 TRUE
								失败，返回 FALSE
		
		详细描述与注意事项：
			（无）
		示例代码：
			bret = CGICookieSetExprires( &info , &time_tm ) ;
		相关函数：
			CGICookieSetPath , CGICookieSetDomain , CGICookieSetSecure

		·CGICookieSetPath
		设置cookie属性容器中的路径信息
		
		函数原型：
			BOOL CGICookieSetPath( SCookieInfo *info , char *path );
		输入参数：
			SCookieInfo *info		cookie属性容器
			char *path				网址路径
		返回值：
			BOOL				成功，返回 TRUE
								失败，返回 FALSE
		
		详细描述与注意事项：
			（无）
		示例代码：
			bret = CGICookieSetPath( &info , "/" ) ;
		相关函数：
			CGICookieSetExprires , CGICookieSetDomain , CGICookieSetSecure

		·CGICookieSetDomain
		设置cookie属性容器中的域名信息
		
		函数原型：
			BOOL CGICookieSetDomain( SCookieInfo *info , char *domain );
		输入参数：
			SCookieInfo *info		cookie属性容器
			char *domain			域名路径
		返回值：
			BOOL				成功，返回 TRUE
								失败，返回 FALSE
		
		详细描述与注意事项：
			（无）
		示例代码：
			bret = CGICookieSetDomain( &info , "www.xxx.com" ) ;
		相关函数：
			CGICookieSetExprires , CGICookieSetPath , CGICookieSetSecure

		·CGICookieSetSecure
		设置cookie属性容器中的安全权限
		
		函数原型：
			BOOL CGICookieSetSecure( SCookieInfo *info , char *secure );
		输入参数：
			SCookieInfo *info		cookie属性容器
			char *secure			安全权限
		返回值：
			BOOL				成功，返回 TRUE
								失败，返回 FALSE
		
		详细描述与注意事项：
			（无）
		示例代码：
			bret = CGICookieSetSecure( &info , "" ) ;
		相关函数：
			CGICookieSetExprires , CGICookieSetPath , CGICookieSetDomain