A token representing a user identified by a user name and password. More...

#include <usernameidentitytoken.h>

Data Fields
struct ua_string	policy_id

struct ua_string	user_name

struct ua_bytestring	password

struct ua_string	encryption_algorithm

Related Functions
void	ua_usernameidentitytoken_init (struct ua_usernameidentitytoken *t)
	Initialize an ua_usernameidentitytoken struct with a valid value. More...

void	ua_usernameidentitytoken_clear (struct ua_usernameidentitytoken *t)
	Clear all resources alloctated in an ua_usernameidentitytoken struct. More...

int	ua_usernameidentitytoken_compare (const struct ua_usernameidentitytoken a, const struct ua_usernameidentitytoken b)
	Compare two ua_usernameidentitytoken structs. More...

int	ua_usernameidentitytoken_copy (struct ua_usernameidentitytoken dst, const struct ua_usernameidentitytoken src)
	Create a copy of a ua_usernameidentitytoken struct. More...

Detailed Description

A token representing a user identified by a user name and password.

Friends And Related Function Documentation

void ua_usernameidentitytoken_clear ( struct ua_usernameidentitytoken * t )

Frees allocated memory like arrays and resets numeric values. The ua_usernameidentitytoken struct itself is not freed and must be freed by the caller if required. This function always succeeds for a valid ua_usernameidentitytoken struct, that was validly decoded, initilized by ua_usernameidentitytoken_init or created with ua_usernameidentitytoken_copy.

int ua_usernameidentitytoken_compare	(	const struct ua_usernameidentitytoken *	a,
		const struct ua_usernameidentitytoken *	b
	)

Compares the content of the ua_usernameidentitytoken struct a to the content of the ua_usernameidentitytoken struct b. If a is smaller than b, an integer less than zero is returned, if a is bigger than b, an integer greater than zero is returned. If both structs are equal zero is returned.

This function creates a total order on ua_usernameidentitytoken structs, so it is well suited to not only determine equality, but also sort multiple instances of this struct.

int ua_usernameidentitytoken_copy	(	struct ua_usernameidentitytoken *	dst,
		const struct ua_usernameidentitytoken *	src
	)

Copy all fields from struct ua_usernameidentitytoken src to dst. Creates a deep copy so all content is recusively copied and both src and dst can be used and must be freed separately.

dst is not cleared before the copy operation, so it must not have any allocated data. It may or may not be initilized by the caller before copy.

Returns: Zero on success or ua_statuscode on failure.

void ua_usernameidentitytoken_init ( struct ua_usernameidentitytoken * t )

After initialization the fields of the struct are set to valid and consistent values and can safley be accessed. An initialized ua_usernameidentitytoken struct can also be passed to ua_usernameidentitytoken_compare, ua_usernameidentitytoken_copy and ua_usernameidentitytoken_clear. This function will always succeed as long as an ua_usernameidentitytoken struct is passed to it.

The documentation for this struct was generated from the following files:

C:/work/embeddedstack/src/uabase/structure/usernameidentitytoken.h
C:/work/embeddedstack/src/uabase/structure/usernameidentitytoken.c

Data Fields

Related Functions

Detailed Description

Friends And Related Function Documentation