html_options_collection.h File Reference

#include <dom/core/exceptions.h>
#include <dom/core/string.h>

Include dependency graph for html_options_collection.h:

This graph shows which files directly or indirectly include this file:

Go to the source code of this file.

Typedefs
typedef struct dom_html_options_collection	dom_html_options_collection

Functions
dom_exception	dom_html_options_collection_get_length (dom_html_options_collection *col, uint32_t *len)
dom_exception	dom_html_options_collection_set_length (dom_html_options_collection *col, uint32_t len)
dom_exception	dom_html_options_collection_item (dom_html_options_collection *col, uint32_t index, struct dom_node **node)
dom_exception	dom_html_options_collection_named_item (dom_html_options_collection *col, dom_string *name, struct dom_node **node)
void	dom_html_options_collection_ref (dom_html_options_collection *col)
void	dom_html_options_collection_unref (dom_html_options_collection *col)

Typedef Documentation

dom_html_options_collection

typedef struct dom_html_options_collection dom_html_options_collection

Function Documentation

dom_html_options_collection_get_length()

dom_exception dom_html_options_collection_get_length	(	dom_html_options_collection *	col,
		uint32_t *	len
	)

Get the length of this dom_html_options_collection

Parameters

col	The dom_html_options_collection object
len	The returned length of this collection

Returns

DOM_NO_ERR on success.

dom_html_options_collection_item()

dom_exception dom_html_options_collection_item	(	dom_html_options_collection *	col,
		uint32_t	index,
		struct dom_node **	node
	)

Get the node with certain index

Parameters

col	The dom_html_options_collection object
index	The index number based on zero
node	The returned node object

Returns

DOM_NO_ERR on success.

dom_html_options_collection_named_item()

dom_exception dom_html_options_collection_named_item	(	dom_html_options_collection *	col,
		dom_string *	name,
		struct dom_node **	node
	)

Get the node in the collection according name

Parameters

col	The collection
name	The name of target node
node	The returned node object

Returns

DOM_NO_ERR on success.

dom_html_options_collection_ref()

void dom_html_options_collection_ref

(

dom_html_options_collection *

col

)

Claim a reference on this collection

\pram col The collection object

dom_html_options_collection_set_length()

dom_exception dom_html_options_collection_set_length	(	dom_html_options_collection *	col,
		uint32_t	len
	)

Set the length of this dom_html_options_collection

Parameters

col	The dom_html_options_collection object
len	The length of this collection to be set

Returns

DOM_NO_ERR on success.

dom_html_options_collection_unref()

void dom_html_options_collection_unref

(

dom_html_options_collection *

col

)

Relese a reference on this collection

\pram col The collection object