From 6b6383d52bc147134bb6b60b07e924b176c67e3a Mon Sep 17 00:00:00 2001 From: Anas Nashif Date: Fri, 20 Sep 2013 04:45:41 -0400 Subject: Imported Upstream version 1.2.19 --- docs/api/xmlsec-list.html | 644 +++++++++++++++++++++++----------------------- 1 file changed, 321 insertions(+), 323 deletions(-) (limited to 'docs/api/xmlsec-list.html') diff --git a/docs/api/xmlsec-list.html b/docs/api/xmlsec-list.html index f070e9de..63b01594 100644 --- a/docs/api/xmlsec-list.html +++ b/docs/api/xmlsec-list.html @@ -87,47 +87,50 @@

list

-

Name

list -- Generic list structure implementation.
+

Name

list -- Generic list structure implementation.

Synopsis

-
struct              xmlSecPtrList;
-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);
+
void                (*xmlSecPtrDebugDumpItemMethod)     (xmlSecPtr ptr,
+                                                         FILE *output);
+void                (*xmlSecPtrDestroyItemMethod)       (xmlSecPtr ptr);
+xmlSecPtr           (*xmlSecPtrDuplicateItemMethod)     (xmlSecPtr ptr);
+struct              xmlSecPtrList;
+intxmlSecPtrListAdd                    (xmlSecPtrListPtr list,
+                                                         xmlSecPtr item);
+#define             xmlSecPtrListCheckId                (list,
+                                                         dataId)
+intxmlSecPtrListCopy                   (xmlSecPtrListPtr dst,
+                                                         xmlSecPtrListPtr src);
+xmlSecPtrListPtr    xmlSecPtrListCreate                 (xmlSecPtrListId id);
+voidxmlSecPtrListDebugDump              (xmlSecPtrListPtr list,
+                                                         FILE *output);
+voidxmlSecPtrListDebugXmlDump           (xmlSecPtrListPtr list,
+                                                         FILE *output);
+voidxmlSecPtrListDestroy                (xmlSecPtrListPtr list);
+xmlSecPtrListPtrxmlSecPtrListDuplicate              (xmlSecPtrListPtr list);
+voidxmlSecPtrListEmpty                  (xmlSecPtrListPtr list);
+voidxmlSecPtrListFinalize               (xmlSecPtrListPtr list);
+xmlSecPtr           xmlSecPtrListGetItem                (xmlSecPtrListPtr list,
+                                                         xmlSecSize pos);
 #define             xmlSecPtrListGetName                (list)
-#define             xmlSecPtrListIsValid                (list)
-#define             xmlSecPtrListCheckId                (list, dataId)
+xmlSecSize          xmlSecPtrListGetSize                (xmlSecPtrListPtr list);
 #define             xmlSecPtrListIdUnknown
-xmlSecPtr           (*xmlSecPtrDuplicateItemMethod)     (xmlSecPtr ptr);
-void                (*xmlSecPtrDestroyItemMethod)       (xmlSecPtr ptr);
-void                (*xmlSecPtrDebugDumpItemMethod)     (xmlSecPtr ptr,
-                                                         FILE *output);
+intxmlSecPtrListInitialize             (xmlSecPtrListPtr list,
+                                                         xmlSecPtrListId id);
+#define             xmlSecPtrListIsValid                (list)
 struct              xmlSecPtrListKlass;
 #define             xmlSecPtrListKlassGetName           (klass)
-#define             xmlSecStringListId
-xmlSecPtrListId     xmlSecStringListGetKlass            (void);

+intxmlSecPtrListRemove                 (xmlSecPtrListPtr list,
+                                                         xmlSecSize pos);
+xmlSecPtr           xmlSecPtrListRemoveAndReturn        (xmlSecPtrListPtr list,
+                                                         xmlSecSize pos);
+intxmlSecPtrListSet                    (xmlSecPtrListPtr list,
+                                                         xmlSecPtr item,
+                                                         xmlSecSize pos);
+voidxmlSecPtrListSetDefaultAllocMode    (xmlSecAllocMode defAllocMode,
+                                                         xmlSecSize defInitialSize);
+xmlSecPtrListIdxmlSecStringListGetKlass            (void);
+#define             xmlSecStringListId

Description

@@ -136,484 +139,492 @@ struct xmlSecPtrListK

Details

-

struct xmlSecPtrList

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

The pointers list.

-

+

xmlSecPtrDebugDumpItemMethod ()

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

Prints debug information about item to output.

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

the list items description.

xmlSecPtr *data;

the list data.

xmlSecSize use;

the current list size.

xmlSecSize max;

the max (allocated) list size.

ptr :

the poinetr to list item.
xmlSecAllocMode allocMode;

the memory allocation mode.

output :

the output FILE.
-

xmlSecPtrListSetDefaultAllocMode ()

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

Sets new default allocation mode and minimal initial list size.

+

xmlSecPtrDestroyItemMethod ()

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

Destroys list item ptr.

+ + + +
ptr :

the poinetr to list item.

+
+
+
+

xmlSecPtrDuplicateItemMethod ()

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

Duplicates item ptr.

- - + + - - + +
defAllocMode :

the new default memory allocation mode.

ptr :

the poinetr to list item.
defInitialSize :

the new default minimal initial size.

Returns :

pointer to new item copy or NULL if an error occurs.
-

xmlSecPtrListInitialize ()

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

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

-

+

struct xmlSecPtrList

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

The pointers list.

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

the pointer to list.

xmlSecPtrListId id;

the list items description.

xmlSecPtr *data;

the list data.
id :

the list klass.

xmlSecSize use;

the current list size.
Returns :

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

xmlSecSize max;

the max (allocated) list size.

xmlSecAllocMode allocMode;

the memory allocation mode.
-

xmlSecPtrListFinalize ()

-
void                xmlSecPtrListFinalize               (xmlSecPtrListPtr list);
-

Cleans up the list initialized with xmlSecPtrListInitialize -function.

-

-

- - - -
list :

the pointer to list.

-
-
-
-

xmlSecPtrListCreate ()

-
xmlSecPtrListPtr    xmlSecPtrListCreate                 (xmlSecPtrListId id);
-

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

-

+

xmlSecPtrListAdd ()

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

Adds item to the end of the list.

- - + + + + + + - - + +
id :

the list klass.

list :

the pointer to list.

item :

the item.
Returns :

pointer to newly allocated list or NULL if an error occurs.

Returns :

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

xmlSecPtrListDestroy ()

-
void                xmlSecPtrListDestroy                (xmlSecPtrListPtr list);
-

Destroys list created with xmlSecPtrListCreate function.

-

-

- - - -
list :

the pointer to list.

-
-
-
-

xmlSecPtrListEmpty ()

-
void                xmlSecPtrListEmpty                  (xmlSecPtrListPtr list);
-

Remove all items from list (if any).

-

+

xmlSecPtrListCheckId()

+
#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.

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 :

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

Returns :

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

xmlSecPtrListDuplicate ()

-
xmlSecPtrListPtr    xmlSecPtrListDuplicate              (xmlSecPtrListPtr list);
-

Creates a new copy of list and all its items.

-

+

xmlSecPtrListCreate ()

+
xmlSecPtrListPtr    xmlSecPtrListCreate                 (xmlSecPtrListId id);
+

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

- - + + - - + +
list :

the pointer to list.

id :

the list klass.
Returns :

pointer to newly allocated list or NULL if an error occurs.

Returns :

pointer to newly allocated list or NULL if an error occurs.
-

xmlSecPtrListGetSize ()

-
xmlSecSize          xmlSecPtrListGetSize                (xmlSecPtrListPtr list);
-

Gets list size.

-

+

xmlSecPtrListDebugDump ()

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

Prints debug information about list to the output.

- - + + - - + +
list :

the pointer to list.

list :

the pointer to list.
Returns :

the number of itmes in list.

output :

the pointer to output FILE.
-

xmlSecPtrListGetItem ()

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

Gets item from the list.

-

+

xmlSecPtrListDebugXmlDump ()

+
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.
pos :

the item position.

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.

output :

the pointer to output FILE.
-

xmlSecPtrListAdd ()

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

Adds item to the end of the list.

+

xmlSecPtrListDestroy ()

+
void                xmlSecPtrListDestroy                (xmlSecPtrListPtr list);
+

Destroys list created with xmlSecPtrListCreate function.

+ + + +
list :

the pointer to list.

+
+
+
+

xmlSecPtrListDuplicate ()

+
xmlSecPtrListPtr    xmlSecPtrListDuplicate              (xmlSecPtrListPtr list);
+

Creates a new copy of list and all its items.

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

the pointer to list.

item :

the item.

list :

the pointer to list.
Returns :

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

Returns :

pointer to newly allocated list or NULL if an error occurs.
-

xmlSecPtrListSet ()

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

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

-

+

xmlSecPtrListEmpty ()

+
void                xmlSecPtrListEmpty                  (xmlSecPtrListPtr list);
+

Remove all items from list (if any).

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

the pointer to list.

item :

the item.

pos :

the pos.

Returns :

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

+ + + +
list :

the pointer to list.

-

xmlSecPtrListRemove ()

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

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

+

xmlSecPtrListFinalize ()

+
void                xmlSecPtrListFinalize               (xmlSecPtrListPtr list);
+

Cleans up the list initialized with xmlSecPtrListInitialize +function.

+ + + +
list :

the pointer to list.

+
+
+
+

xmlSecPtrListGetItem ()

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

Gets item from the list.

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

the pointer to list.

list :

the pointer to list.
pos :

the position.

pos :

the item position.
Returns :

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

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.
-

xmlSecPtrListDebugDump ()

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

Prints debug information about list to the output.

+

xmlSecPtrListGetName()

+
#define             xmlSecPtrListGetName(list)
+

Macro. Returns lists's name.

+ + + +
list :

the ponter to list.

+
+
+
+

xmlSecPtrListGetSize ()

+
xmlSecSize          xmlSecPtrListGetSize                (xmlSecPtrListPtr list);
+

Gets list size.

- - + + - - + +
list :

the pointer to list.

list :

the pointer to list.
output :

the pointer to output FILE.

Returns :

the number of itmes in list.
-

xmlSecPtrListDebugXmlDump ()

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

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

-

+

xmlSecPtrListIdUnknown

+
#define xmlSecPtrListIdUnknown                  NULL
+

The "unknown" id.

+
+
+
+

xmlSecPtrListInitialize ()

+
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.
output :

the pointer to output FILE.

Returns :

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

xmlSecPtrListGetName()

-
#define             xmlSecPtrListGetName(list)
-

Macro. Returns lists's name.

-

-

- - - -
list :

the ponter to list.

-
-
-

xmlSecPtrListIsValid()

#define             xmlSecPtrListIsValid(list)

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.
-

xmlSecPtrListCheckId()

-
#define             xmlSecPtrListCheckId(list, dataId)
-

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

-

+

struct xmlSecPtrListKlass

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

List klass.

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

the pointer to list.

const xmlChar *name;

the list klass name.

xmlSecPtrDuplicateItemMethod duplicateItem;

the duplciate item method.

xmlSecPtrDestroyItemMethod destroyItem;

the destroy item method.

xmlSecPtrDebugDumpItemMethod debugDumpItem;

the debug dump item method.
dataId :

the list Id.

xmlSecPtrDebugDumpItemMethod debugXmlDumpItem;

the debug dump item in xml format method.
-

xmlSecPtrListIdUnknown

-
#define xmlSecPtrListIdUnknown 			NULL
-

The "unknown" id.

+

xmlSecPtrListKlassGetName()

+
#define             xmlSecPtrListKlassGetName(klass)
+

Macro. Returns the list klass name.

+ + + +
klass :

the list klass. +2

-

xmlSecPtrDuplicateItemMethod ()

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

Duplicates item ptr.

-

+

xmlSecPtrListRemove ()

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

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

- - + + + + + + - - + +
ptr :

the poinetr to list item.

list :

the pointer to list.

pos :

the position.
Returns :

pointer to new item copy or NULL if an error occurs.

Returns :

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

xmlSecPtrDestroyItemMethod ()

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

Destroys list item ptr.

-

-

- - - -
ptr :

the poinetr to list item.

-
-
-
-

xmlSecPtrDebugDumpItemMethod ()

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

Prints debug information about item to output.

-

+

xmlSecPtrListRemoveAndReturn ()

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

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

- - + + + + + + - - + +
ptr :

the poinetr to list item.

list :

the pointer to list.

pos :

the position.
output :

the output FILE.

Returns :

the pointer to the list item.
-

struct xmlSecPtrListKlass

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

List klass.

-

+

xmlSecPtrListSet ()

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

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

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

the list klass name.

list :

the pointer to list.

item :

the item.
xmlSecPtrDuplicateItemMethod duplicateItem;

the duplciate item method.

pos :

the pos.
xmlSecPtrDestroyItemMethod destroyItem;

the destroy item method.

Returns :

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

xmlSecPtrListSetDefaultAllocMode ()

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

Sets new default allocation mode and minimal initial list size.

+

+ - - + + - - + +
xmlSecPtrDebugDumpItemMethod debugDumpItem;

the debug dump item method.

defAllocMode :

the new default memory allocation mode.
xmlSecPtrDebugDumpItemMethod debugXmlDumpItem;

the debug dump item in xml format method.

defInitialSize :

the new default minimal initial size.
-

xmlSecPtrListKlassGetName()

-
#define             xmlSecPtrListKlassGetName(klass)
-

Macro. Returns the list klass name.

-

+

xmlSecStringListGetKlass ()

+
xmlSecPtrListId     xmlSecStringListGetKlass            (void);
+

The strins list class.

- - + +
klass :

the list klass. -2

Returns :

strings list klass.
@@ -621,19 +632,6 @@ or 0 otherwise.

xmlSecStringListId

#define             xmlSecStringListId

Strings list klass.

-

-
-
-
-

xmlSecStringListGetKlass ()

-
xmlSecPtrListId     xmlSecStringListGetKlass            (void);
-

The strins list class.

-

-

- - - -
Returns :

strings list klass.

-- cgit v1.2.3