From 07bb297329b9e9754d09dcb6d70417272a626619 Mon Sep 17 00:00:00 2001 From: Anas Nashif Date: Thu, 22 Nov 2012 10:31:06 -0800 Subject: Imported Upstream version 1.2.14 --- docs/api/xmlsec-list.html | 400 +++++++++++++++++++++++----------------------- 1 file changed, 201 insertions(+), 199 deletions(-) (limited to 'docs/api/xmlsec-list.html') diff --git a/docs/api/xmlsec-list.html b/docs/api/xmlsec-list.html index 7f307fe5..f070e9de 100644 --- a/docs/api/xmlsec-list.html +++ b/docs/api/xmlsec-list.html @@ -87,50 +87,47 @@

list

-

Name

list -- Generic list structure implementation.
+

Name

list -- Generic list structure implementation.

Synopsis

struct              xmlSecPtrList;
-voidxmlSecPtrListSetDefaultAllocMode    (xmlSecAllocMode defAllocMode,
-                                                         xmlSecSize defInitialSize);
-intxmlSecPtrListInitialize             (xmlSecPtrListPtr list,
-                                                         xmlSecPtrListId id);
-voidxmlSecPtrListFinalize               (xmlSecPtrListPtr list);
-xmlSecPtrListPtr    xmlSecPtrListCreate                 (xmlSecPtrListId id);
-voidxmlSecPtrListDestroy                (xmlSecPtrListPtr list);
-voidxmlSecPtrListEmpty                  (xmlSecPtrListPtr list);
-intxmlSecPtrListCopy                   (xmlSecPtrListPtr dst,
-                                                         xmlSecPtrListPtr src);
-xmlSecPtrListPtrxmlSecPtrListDuplicate              (xmlSecPtrListPtr list);
-xmlSecSize          xmlSecPtrListGetSize                (xmlSecPtrListPtr list);
-xmlSecPtr           xmlSecPtrListGetItem                (xmlSecPtrListPtr list,
-                                                         xmlSecSize pos);
-intxmlSecPtrListAdd                    (xmlSecPtrListPtr list,
-                                                         xmlSecPtr item);
-intxmlSecPtrListSet                    (xmlSecPtrListPtr list,
-                                                         xmlSecPtr item,
-                                                         xmlSecSize pos);
-intxmlSecPtrListRemove                 (xmlSecPtrListPtr list,
-                                                         xmlSecSize pos);
-xmlSecPtr           xmlSecPtrListRemoveAndReturn        (xmlSecPtrListPtr list,
-                                                         xmlSecSize pos);
-voidxmlSecPtrListDebugDump              (xmlSecPtrListPtr list,
-                                                         FILE *output);
-voidxmlSecPtrListDebugXmlDump           (xmlSecPtrListPtr list,
-                                                         FILE *output);
+void                xmlSecPtrListSetDefaultAllocMode    (xmlSecAllocMode defAllocMode,
+                                                         xmlSecSize defInitialSize);
+int                 xmlSecPtrListInitialize             (xmlSecPtrListPtr list,
+                                                         xmlSecPtrListId id);
+void                xmlSecPtrListFinalize               (xmlSecPtrListPtr list);
+xmlSecPtrListPtr    xmlSecPtrListCreate                 (xmlSecPtrListId id);
+void                xmlSecPtrListDestroy                (xmlSecPtrListPtr list);
+void                xmlSecPtrListEmpty                  (xmlSecPtrListPtr list);
+int                 xmlSecPtrListCopy                   (xmlSecPtrListPtr dst,
+                                                         xmlSecPtrListPtr src);
+xmlSecPtrListPtr    xmlSecPtrListDuplicate              (xmlSecPtrListPtr list);
+xmlSecSize          xmlSecPtrListGetSize                (xmlSecPtrListPtr list);
+xmlSecPtr           xmlSecPtrListGetItem                (xmlSecPtrListPtr list,
+                                                         xmlSecSize pos);
+int                 xmlSecPtrListAdd                    (xmlSecPtrListPtr list,
+                                                         xmlSecPtr item);
+int                 xmlSecPtrListSet                    (xmlSecPtrListPtr list,
+                                                         xmlSecPtr item,
+                                                         xmlSecSize pos);
+int                 xmlSecPtrListRemove                 (xmlSecPtrListPtr list,
+                                                         xmlSecSize pos);
+void                xmlSecPtrListDebugDump              (xmlSecPtrListPtr list,
+                                                         FILE *output);
+void                xmlSecPtrListDebugXmlDump           (xmlSecPtrListPtr list,
+                                                         FILE *output);
 #define             xmlSecPtrListGetName                (list)
 #define             xmlSecPtrListIsValid                (list)
-#define             xmlSecPtrListCheckId                (list,
-                                                         dataId)
+#define             xmlSecPtrListCheckId                (list, dataId)
 #define             xmlSecPtrListIdUnknown
-xmlSecPtr           (*xmlSecPtrDuplicateItemMethod)     (xmlSecPtr ptr);
-void                (*xmlSecPtrDestroyItemMethod)       (xmlSecPtr ptr);
-void                (*xmlSecPtrDebugDumpItemMethod)     (xmlSecPtr ptr,
-                                                         FILE *output);
+xmlSecPtr           (*xmlSecPtrDuplicateItemMethod)     (xmlSecPtr ptr);
+void                (*xmlSecPtrDestroyItemMethod)       (xmlSecPtr ptr);
+void                (*xmlSecPtrDebugDumpItemMethod)     (xmlSecPtr ptr,
+                                                         FILE *output);
 struct              xmlSecPtrListKlass;
 #define             xmlSecPtrListKlassGetName           (klass)
 #define             xmlSecStringListId
-xmlSecPtrListIdxmlSecStringListGetKlass            (void);
+xmlSecPtrListId xmlSecStringListGetKlass (void);

Description

@@ -141,75 +138,78 @@ struct xmlSecPtrListK

struct xmlSecPtrList

struct xmlSecPtrList {
-    xmlSecPtrListId             id;
+    xmlSecPtrListId		id;        
 
-    xmlSecPtr*                  data;
-    xmlSecSize                  use;
-    xmlSecSize                  max;
-    xmlSecAllocMode             allocMode;
+    xmlSecPtr*			data;
+    xmlSecSize			use;
+    xmlSecSize			max;
+    xmlSecAllocMode 		allocMode;
 };

The pointers list.

+

- - + + - - + + - - + + - - + + - - + +
xmlSecPtrListId id;

the list items description.

xmlSecPtrListId id;

the list items description.
xmlSecPtr *data;

the list data.

xmlSecPtr *data;

the list data.
xmlSecSize use;

the current list size.

xmlSecSize use;

the current list size.
xmlSecSize max;

the max (allocated) list size.

xmlSecSize max;

the max (allocated) list size.
xmlSecAllocMode allocMode;

the memory allocation mode.

xmlSecAllocMode allocMode;

the memory allocation mode.

xmlSecPtrListSetDefaultAllocMode ()

-
void                xmlSecPtrListSetDefaultAllocMode    (xmlSecAllocMode defAllocMode,
-                                                         xmlSecSize defInitialSize);
+
void                xmlSecPtrListSetDefaultAllocMode    (xmlSecAllocMode defAllocMode,
+                                                         xmlSecSize defInitialSize);

Sets new default allocation mode and minimal initial list size.

+

- - + + - - + +
defAllocMode :

the new default memory allocation mode.

defAllocMode :

the new default memory allocation mode.
defInitialSize :

the new default minimal initial size.

defInitialSize :

the new default minimal initial size.

xmlSecPtrListInitialize ()

-
int                 xmlSecPtrListInitialize             (xmlSecPtrListPtr list,
-                                                         xmlSecPtrListId id);
-

Initializes the list of given klass. Caller is responsible +

int                 xmlSecPtrListInitialize             (xmlSecPtrListPtr list,
+                                                         xmlSecPtrListId id);
+

Initializes the list of given klass. Caller is responsible for cleaning up by calling xmlSecPtrListFinalize function.

+

- - + + - - + + - +
list :

the pointer to list.

list :

the pointer to list.
id :

the list klass.

id :

the list klass.
Returns :Returns :

0 on success or a negative value if an error occurs.
@@ -217,29 +217,31 @@ for cleaning up by calling

xmlSecPtrListFinalize ()

-
void                xmlSecPtrListFinalize               (xmlSecPtrListPtr list);
+
void                xmlSecPtrListFinalize               (xmlSecPtrListPtr list);

Cleans up the list initialized with xmlSecPtrListInitialize function.

+

- - + +
list :

the pointer to list.

list :

the pointer to list.

xmlSecPtrListCreate ()

-
xmlSecPtrListPtr    xmlSecPtrListCreate                 (xmlSecPtrListId id);
+
xmlSecPtrListPtr    xmlSecPtrListCreate                 (xmlSecPtrListId id);

Creates new list object. Caller is responsible for freeing returned list by calling xmlSecPtrListDestroy function.

+

- - + + - +
id :

the list klass.

id :

the list klass.
Returns :Returns :

pointer to newly allocated list or NULL if an error occurs.
@@ -247,45 +249,48 @@ by calling xm

xmlSecPtrListDestroy ()

-
void                xmlSecPtrListDestroy                (xmlSecPtrListPtr list);
+
void                xmlSecPtrListDestroy                (xmlSecPtrListPtr list);

Destroys list created with xmlSecPtrListCreate function.

+

- - + +
list :

the pointer to list.

list :

the pointer to list.

xmlSecPtrListEmpty ()

-
void                xmlSecPtrListEmpty                  (xmlSecPtrListPtr list);
+
void                xmlSecPtrListEmpty                  (xmlSecPtrListPtr list);

Remove all items from list (if any).

+

- - + +
list :

the pointer to list.

list :

the pointer to list.

xmlSecPtrListCopy ()

-
int                 xmlSecPtrListCopy                   (xmlSecPtrListPtr dst,
-                                                         xmlSecPtrListPtr src);
+
int                 xmlSecPtrListCopy                   (xmlSecPtrListPtr dst,
+                                                         xmlSecPtrListPtr src);

Copies src list items to dst list using duplicateItem method -of the list klass. If duplicateItem method is NULL then +of the list klass. If duplicateItem method is NULL then we jsut copy pointers to items.

+

- - + + - - + + - +
dst :

the pointer to destination list.

dst :

the pointer to destination list.
src :

the pointer to source list.

src :

the pointer to source list.
Returns :Returns :

0 on success or a negative value if an error occurs.
@@ -293,16 +298,17 @@ we jsut copy pointers to items.

xmlSecPtrListDuplicate ()

-
xmlSecPtrListPtr    xmlSecPtrListDuplicate              (xmlSecPtrListPtr list);
+
xmlSecPtrListPtr    xmlSecPtrListDuplicate              (xmlSecPtrListPtr list);

Creates a new copy of list and all its items.

+

- - + + - +
list :

the pointer to list.

list :

the pointer to list.
Returns :Returns :

pointer to newly allocated list or NULL if an error occurs.
@@ -310,16 +316,17 @@ we jsut copy pointers to items.

xmlSecPtrListGetSize ()

-
xmlSecSize          xmlSecPtrListGetSize                (xmlSecPtrListPtr list);
+
xmlSecSize          xmlSecPtrListGetSize                (xmlSecPtrListPtr list);

Gets list size.

+

- - + + - +
list :

the pointer to list.

list :

the pointer to list.
Returns :Returns :

the number of itmes in list.
@@ -327,21 +334,22 @@ we jsut copy pointers to items.

xmlSecPtrListGetItem ()

-
xmlSecPtr           xmlSecPtrListGetItem                (xmlSecPtrListPtr list,
-                                                         xmlSecSize pos);
+
xmlSecPtr           xmlSecPtrListGetItem                (xmlSecPtrListPtr list,
+                                                         xmlSecSize pos);

Gets item from the list.

+

- - + + - - + + - + @@ -350,21 +358,22 @@ than the number of items in the list or an error occurs.

xmlSecPtrListAdd ()

-
int                 xmlSecPtrListAdd                    (xmlSecPtrListPtr list,
-                                                         xmlSecPtr item);
+
int                 xmlSecPtrListAdd                    (xmlSecPtrListPtr list,
+                                                         xmlSecPtr item);

Adds item to the end of the list.

+

list :

the pointer to list.

list :

the pointer to list.
pos :

the item position.

pos :

the item position.
Returns :Returns :

the list item at position pos or NULL if pos is greater than the number of items in the list or an error occurs.
- - + + - - + + - +
list :

the pointer to list.

list :

the pointer to list.
item :

the item.

item :

the item.
Returns :Returns :

0 on success or a negative value if an error occurs.
@@ -372,27 +381,28 @@ than the number of items in the list or an error occurs.

xmlSecPtrListSet ()

-
int                 xmlSecPtrListSet                    (xmlSecPtrListPtr list,
-                                                         xmlSecPtr item,
-                                                         xmlSecSize pos);
+
int                 xmlSecPtrListSet                    (xmlSecPtrListPtr list,
+                                                         xmlSecPtr item,
+                                                         xmlSecSize pos);

Sets the value of list item at position pos. The old value is destroyed.

+

- - + + - - + + - - + + - +
list :

the pointer to list.

list :

the pointer to list.
item :

the item.

item :

the item.
pos :

the pos.

pos :

the pos.
Returns :Returns :

0 on success or a negative value if an error occurs.
@@ -400,80 +410,61 @@ is destroyed.

xmlSecPtrListRemove ()

-
int                 xmlSecPtrListRemove                 (xmlSecPtrListPtr list,
-                                                         xmlSecSize pos);
+
int                 xmlSecPtrListRemove                 (xmlSecPtrListPtr list,
+                                                         xmlSecSize pos);

Destroys list item at the position pos and sets it value to NULL.

- - - - - - - - - - - - - -
list :

the pointer to list.

pos :

the position.

Returns :

0 on success or a negative value if an error occurs.

-
-
-
-

xmlSecPtrListRemoveAndReturn ()

-
xmlSecPtr           xmlSecPtrListRemoveAndReturn        (xmlSecPtrListPtr list,
-                                                         xmlSecSize pos);
-

Remove the list item at the position pos and return it back.

- - + + - - + + - - + +
list :

the pointer to list.

list :

the pointer to list.
pos :

the position.

pos :

the position.
Returns :

the pointer to the list item.

Returns :

0 on success or a negative value if an error occurs.

xmlSecPtrListDebugDump ()

-
void                xmlSecPtrListDebugDump              (xmlSecPtrListPtr list,
-                                                         FILE *output);
+
void                xmlSecPtrListDebugDump              (xmlSecPtrListPtr list,
+                                                         FILE *output);

Prints debug information about list to the output.

+

- - + + - - + +
list :

the pointer to list.

list :

the pointer to list.
output :

the pointer to output FILE.

output :

the pointer to output FILE.

xmlSecPtrListDebugXmlDump ()

-
void                xmlSecPtrListDebugXmlDump           (xmlSecPtrListPtr list,
-                                                         FILE *output);
+
void                xmlSecPtrListDebugXmlDump           (xmlSecPtrListPtr list,
+                                                         FILE *output);

Prints debug information about list to the output in XML format.

+

- - + + - - + +
list :

the pointer to list.

list :

the pointer to list.
output :

the pointer to output FILE.

output :

the pointer to output FILE.
@@ -483,9 +474,10 @@ is destroyed.

#define             xmlSecPtrListGetName(list)

Macro. Returns lists's name.

+

- - + +
list :

the ponter to list.

list :

the ponter to list.
@@ -495,9 +487,10 @@ is destroyed.

Macro. Returns 1 if list is not NULL and list->id is not NULL or 0 otherwise.

+

- - + +
list :

the pointer to list.

list :

the pointer to list.
@@ -506,36 +499,39 @@ or 0 otherwise.

#define             xmlSecPtrListCheckId(list, dataId)

Macro. Returns 1 if list is valid and list's id is equal to dataId.

+

- - + + - - + +
list :

the pointer to list.

list :

the pointer to list.
dataId :

the list Id.

dataId :

the list Id.

xmlSecPtrListIdUnknown

-
#define xmlSecPtrListIdUnknown                  NULL
+
#define xmlSecPtrListIdUnknown 			NULL

The "unknown" id.

+

xmlSecPtrDuplicateItemMethod ()

-
xmlSecPtr           (*xmlSecPtrDuplicateItemMethod)     (xmlSecPtr ptr);
+
xmlSecPtr           (*xmlSecPtrDuplicateItemMethod)     (xmlSecPtr ptr);

Duplicates item ptr.

+

- - + + - +
ptr :

the poinetr to list item.

ptr :

the poinetr to list item.
Returns :Returns :

pointer to new item copy or NULL if an error occurs.
@@ -543,29 +539,31 @@ or 0 otherwise.

xmlSecPtrDestroyItemMethod ()

-
void                (*xmlSecPtrDestroyItemMethod)       (xmlSecPtr ptr);
+
void                (*xmlSecPtrDestroyItemMethod)       (xmlSecPtr ptr);

Destroys list item ptr.

+

- - + +
ptr :

the poinetr to list item.

ptr :

the poinetr to list item.

xmlSecPtrDebugDumpItemMethod ()

-
void                (*xmlSecPtrDebugDumpItemMethod)     (xmlSecPtr ptr,
-                                                         FILE *output);
+
void                (*xmlSecPtrDebugDumpItemMethod)     (xmlSecPtr ptr,
+                                                         FILE *output);

Prints debug information about item to output.

+

- - + + - - + +
ptr :

the poinetr to list item.

ptr :

the poinetr to list item.
output :

the output FILE.

output :

the output FILE.
@@ -573,34 +571,35 @@ or 0 otherwise.

struct xmlSecPtrListKlass

struct xmlSecPtrListKlass {
-    const xmlChar*                      name;
-    xmlSecPtrDuplicateItemMethod        duplicateItem;
-    xmlSecPtrDestroyItemMethod          destroyItem;
-    xmlSecPtrDebugDumpItemMethod        debugDumpItem;
-    xmlSecPtrDebugDumpItemMethod        debugXmlDumpItem;
+    const xmlChar*			name;
+    xmlSecPtrDuplicateItemMethod	duplicateItem;
+    xmlSecPtrDestroyItemMethod		destroyItem;
+    xmlSecPtrDebugDumpItemMethod	debugDumpItem;
+    xmlSecPtrDebugDumpItemMethod	debugXmlDumpItem;
 };

List klass.

+

- - + + - - + + - - + + - - + + - - + +
const xmlChar *name;

the list klass name.

const xmlChar *name;

the list klass name.
xmlSecPtrDuplicateItemMethod duplicateItem;

the duplciate item method.

xmlSecPtrDuplicateItemMethod duplicateItem;

the duplciate item method.
xmlSecPtrDestroyItemMethod destroyItem;

the destroy item method.

xmlSecPtrDestroyItemMethod destroyItem;

the destroy item method.
xmlSecPtrDebugDumpItemMethod debugDumpItem;

the debug dump item method.

xmlSecPtrDebugDumpItemMethod debugDumpItem;

the debug dump item method.
xmlSecPtrDebugDumpItemMethod debugXmlDumpItem;

the debug dump item in xml format method.

xmlSecPtrDebugDumpItemMethod debugXmlDumpItem;

the debug dump item in xml format method.
@@ -610,9 +609,10 @@ or 0 otherwise.

#define             xmlSecPtrListKlassGetName(klass)

Macro. Returns the list klass name.

+

- - +
klass :

the list klass. +

klass :

the list klass. 2
@@ -621,15 +621,17 @@ or 0 otherwise.

xmlSecStringListId

#define             xmlSecStringListId

Strings list klass.

+

xmlSecStringListGetKlass ()

-
xmlSecPtrListId     xmlSecStringListGetKlass            (void);
+
xmlSecPtrListId     xmlSecStringListGetKlass            (void);

The strins list class.

+

- +
Returns :Returns :

strings list klass.
-- cgit v1.2.3