XML Security Library

LibXML2
LibXSLT
OpenSSL

list

Name

list -- 

Synopsis


typedef     xmlSecPtr;
struct      xmlSecPtrList;
void        xmlSecPtrListSetDefaultAllocMode
                                            (xmlSecAllocMode defAllocMode,
                                             size_t defInitialSize);
int         xmlSecPtrListInitialize         (xmlSecPtrListPtr list,
                                             xmlSecPtrListId id);
void        xmlSecPtrListFinalize           (xmlSecPtrListPtr list);
xmlSecPtrListPtr xmlSecPtrListCreate        (xmlSecPtrListId id);
void        xmlSecPtrListDestroy            (xmlSecPtrListPtr list);
int         xmlSecPtrListCopy               (xmlSecPtrListPtr dst,
                                             xmlSecPtrListPtr src);
xmlSecPtrListPtr xmlSecPtrListDuplicate     (xmlSecPtrListPtr list);
size_t      xmlSecPtrListGetSize            (xmlSecPtrListPtr list);
xmlSecPtr   xmlSecPtrListGetItem            (xmlSecPtrListPtr list,
                                             size_t pos);
int         xmlSecPtrListAdd                (xmlSecPtrListPtr list,
                                             xmlSecPtr item);
int         xmlSecPtrListSet                (xmlSecPtrListPtr list,
                                             xmlSecPtr item,
                                             size_t pos);
int         xmlSecPtrListRemove             (xmlSecPtrListPtr list,
                                             size_t pos);
void        xmlSecPtrListDebugDump          (xmlSecPtrListPtr list,
                                             FILE *output);
void        xmlSecPtrListDebugXmlDump       (xmlSecPtrListPtr list,
                                             FILE *output);
#define     xmlSecPtrListGetName            (list)
#define     xmlSecPtrListIsValid            (list)
#define     xmlSecPtrListCheckId            (list, dataId)
#define     xmlSecPtrListIdUnknown
xmlSecPtr   (*xmlSecPtrDuplicateItemMethod) (xmlSecPtr ptr);
void        (*xmlSecPtrDestroyItemMethod)   (xmlSecPtr ptr);
void        (*xmlSecPtrDebugDumpItemMethod) (xmlSecPtr ptr,
                                             FILE *output);
struct      xmlSecPtrListKlass;
#define     xmlSecPtrListKlassGetName       (klass)
#define     xmlSecStaticObjectListId
xmlSecPtrListId xmlSecStaticObjectListGetKlass
                                            (void);
#define     xmlSecStringListId
xmlSecPtrListId xmlSecStringListGetKlass    (void);

Description

Details

xmlSecPtr

typedef void*	xmlSecPtr;

Void pointer.


struct xmlSecPtrList

struct xmlSecPtrList {
    xmlSecPtrListId		id;        

    xmlSecPtr*			data;
    size_t			use;
    size_t			max;
    xmlSecAllocMode 		allocMode;
};

The pointers list.

xmlSecPtrListId id the list items description.
xmlSecPtr *data the list data.
size_t use the current list size.
size_t max the max (allocated) list size.
xmlSecAllocMode allocMode the memory allocation mode.


xmlSecPtrListSetDefaultAllocMode ()

void        xmlSecPtrListSetDefaultAllocMode
                                            (xmlSecAllocMode defAllocMode,
                                             size_t defInitialSize);

defAllocMode :  
defInitialSize :  


xmlSecPtrListInitialize ()

int         xmlSecPtrListInitialize         (xmlSecPtrListPtr list,
                                             xmlSecPtrListId id);

list :  
id :  
Returns :  


xmlSecPtrListFinalize ()

void        xmlSecPtrListFinalize           (xmlSecPtrListPtr list);

list :  


xmlSecPtrListCreate ()

xmlSecPtrListPtr xmlSecPtrListCreate        (xmlSecPtrListId id);

id :  
Returns :  


xmlSecPtrListDestroy ()

void        xmlSecPtrListDestroy            (xmlSecPtrListPtr list);

list :  


xmlSecPtrListCopy ()

int         xmlSecPtrListCopy               (xmlSecPtrListPtr dst,
                                             xmlSecPtrListPtr src);

dst :  
src :  
Returns :  


xmlSecPtrListDuplicate ()

xmlSecPtrListPtr xmlSecPtrListDuplicate     (xmlSecPtrListPtr list);

list :  
Returns :  


xmlSecPtrListGetSize ()

size_t      xmlSecPtrListGetSize            (xmlSecPtrListPtr list);

list :  
Returns :  


xmlSecPtrListGetItem ()

xmlSecPtr   xmlSecPtrListGetItem            (xmlSecPtrListPtr list,
                                             size_t pos);

list :  
pos :  
Returns :  


xmlSecPtrListAdd ()

int         xmlSecPtrListAdd                (xmlSecPtrListPtr list,
                                             xmlSecPtr item);

list :  
item :  
Returns :  


xmlSecPtrListSet ()

int         xmlSecPtrListSet                (xmlSecPtrListPtr list,
                                             xmlSecPtr item,
                                             size_t pos);

list :  
item :  
pos :  
Returns :  


xmlSecPtrListRemove ()

int         xmlSecPtrListRemove             (xmlSecPtrListPtr list,
                                             size_t pos);

list :  
pos :  
Returns :  


xmlSecPtrListDebugDump ()

void        xmlSecPtrListDebugDump          (xmlSecPtrListPtr list,
                                             FILE *output);

list :  
output :  


xmlSecPtrListDebugXmlDump ()

void        xmlSecPtrListDebugXmlDump       (xmlSecPtrListPtr list,
                                             FILE *output);

list :  
output :  


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.


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.
dataId : the list Id.


xmlSecPtrListIdUnknown

#define xmlSecPtrListIdUnknown 			NULL

The "unknown" id.


xmlSecPtrDuplicateItemMethod ()

xmlSecPtr   (*xmlSecPtrDuplicateItemMethod) (xmlSecPtr ptr);

Duplicates item ptr.

ptr : the poinetr to list item.
Returns : pointer to new item copy or NULL 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.

ptr : the poinetr to list item.
output : the output FILE.


struct xmlSecPtrListKlass

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

name: the list klass name. duplicateItem: the duplciate item method. destroyItem: the destroy item method. debugDumpItem: the debug dump item method. debugXmlDumpItem: the debug dump item in xml format method.

List klass.


xmlSecPtrListKlassGetName()

#define     xmlSecPtrListKlassGetName(klass)

Macro. Returns the list klass name.

klass :  


xmlSecStaticObjectListId

#define     xmlSecStaticObjectListId

Static objects klass (no destroy or duplicate methods).


xmlSecStaticObjectListGetKlass ()

xmlSecPtrListId xmlSecStaticObjectListGetKlass
                                            (void);

Returns :  


xmlSecStringListId

#define     xmlSecStringListId

Strings list klass.


xmlSecStringListGetKlass ()

xmlSecPtrListId xmlSecStringListGetKlass    (void);

Returns :  



Aleksey Sanin