uFLink.h File Reference

Define uFLink component and it's operation. More...

#include <CoconutXML/CoconutXML.h>

Go to the source code of this file.

Classes
struct	uFLink
	License component. More...
Enumerations
enum	uFLinkType { uFUnknownLink, uFLicenseLink, uFTagLink, uFNoFollowLink }
	Type of link. More...
Functions
struct uFLink *	uFAllocateLink (uFLinkType type, struct CNString *url, struct CNResource *resource)
	Allocate UFLINK component.
static void	uFRetainLink (struct uFLink *dst)
	Retain the uFLink component.
static void	uFReleaseLink (struct uFLink *dst)
	Release the uFLink component.
static struct CNXMLObject *	CNCastLinkToXMLObject (struct uFLink *src)
	Cast uFLink to XML object.
static xmlNodePtr	uFEncodeLink (const struct uFLink *src)
	Encode the uFLink into XML node.
static struct CNString *	uFURLInLink (const struct uFLink *src)
	Get URL of the UFLINK component.
static void	uFSetContextOfLink (struct uFLink *dst, struct CNXMLObject *src)
	Set context of the link.
static struct CNXMLObject *	uFContextInLink (struct uFLink *src)
	Get context of link.

---

Detailed Description

Define uFLink component and it's operation.

Copyright

Copyright (C) 2012 Steel Wheels Project

---

Enumeration Type Documentation

enum uFLinkType

Type of link.

Enumerator:

uFUnknownLink	Unknown link type.
uFLicenseLink	License link type.
uFTagLink	Tag link type.
uFNoFollowLink	No Follow link.

---

Function Documentation

struct uFLink* uFAllocateLink	(	uFLinkType	type,
		struct CNString *	url,
		struct CNResource *	resource
	)		[read]

Allocate UFLINK component.

Return values:

comp	Allocate UFLINK component
NULL	Failed to allocate the component

Parameters:

type	Type of link
url	URL for the new license
resource	Resource to allocate the new component

static void uFRetainLink

(

struct uFLink *

dst

)

[inline, static]

Retain the uFLink component.

Parameters:

dst	Destination component

References uFLink::superClass.

static void uFReleaseLink

(

struct uFLink *

dst

)

[inline, static]

Release the uFLink component.

Parameters:

dst	Destination component

References uFLink::superClass.

static struct CNXMLObject* CNCastLinkToXMLObject

(

struct uFLink *

src

)

[static, read]

Cast uFLink to XML object.

Returns:

XML Object

Parameters:

src	Source link

References uFLink::superClass.

static xmlNodePtr uFEncodeLink

(

const struct uFLink *

src

)

[inline, static]

Encode the uFLink into XML node.

Returns:

XML node

Parameters:

src	Source uFLink component

References uFLink::superClass.

static struct CNString* uFURLInLink

(

const struct uFLink *

src

)

[static, read]

Get URL of the UFLINK component.

Returns:

URL

Parameters:

src	Source component

References uFLink::url.

static void uFSetContextOfLink	(	struct uFLink *	dst,
		struct CNXMLObject *	src
	)		[inline, static]

Set context of the link.

Parameters:

dst	Destination link
src	Source context

References uFLink::context.

static struct CNXMLObject* uFContextInLink

(

struct uFLink *

src

)

[static, read]

Get context of link.

Returns:

Context of link

Parameters:

src	Source link

References uFLink::context.