include/razorback/block_id.h File Reference

BlockId functions. More...

#include <razorback/visibility.h>
#include <razorback/types.h>

Include dependency graph for block_id.h:

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

Go to the source code of this file.

Functions
SO_PUBLIC bool	BlockId_IsEqual (const struct BlockId *p_pA, const struct BlockId *p_pB)
	Tests whether two blockids are equal.
SO_PUBLIC void	BlockId_ToText (const struct BlockId *p_pA, uint8_t *p_sText)
	Converts a block id to text.
SO_PUBLIC struct BlockId *	BlockId_Create_Shallow (void)
	Constructs a block id wihtout internal parts.
SO_PUBLIC struct BlockId *	BlockId_Create (void)
	Constructs a block id.
SO_PUBLIC uint32_t	BlockId_StringLength (struct BlockId *p_pB)
	Returns the size of string required in the ToText function.
SO_PUBLIC void	BlockId_Destroy (struct BlockId *p_pBlockId)
	Destroys a block id.
SO_PUBLIC struct BlockId *	BlockId_Clone (const struct BlockId *p_pSource)
	Copies a block id.
SO_PUBLIC uint32_t	BlockId_BinaryLength (const struct BlockId *p_pBlockId)
	Gets binary length of block id.

---

Detailed Description

BlockId functions.

---

Function Documentation

SO_PUBLIC uint32_t BlockId_BinaryLength

(

const struct BlockId *

p_pBlockId

)

Gets binary length of block id.

Parameters:

p_pBlockId

the block id

Returns:

the size when placed in a binary buffer

SO_PUBLIC struct BlockId* BlockId_Clone

(

const struct BlockId *

p_pSource

)

[read]

Copies a block id.

Parameters:

p_pSource

the source

Returns:

A copy of the block id on success, NULL on an error.

SO_PUBLIC struct BlockId* BlockId_Create

(

void

)

[read]

Constructs a block id.

Returns:

a new block ID or null on error

SO_PUBLIC struct BlockId* BlockId_Create_Shallow

(

void

)

[read]

Constructs a block id wihtout internal parts.

Returns:

a new block ID or null on error

SO_PUBLIC void BlockId_Destroy

(

struct BlockId *

p_pBlockId

)

Destroys a block id.

Parameters:

p_pBlockId

the block to destroy

SO_PUBLIC bool BlockId_IsEqual	(	const struct BlockId *	p_pA,
		const struct BlockId *	p_pB
	)

Tests whether two blockids are equal.

Parameters:

	p_pA	the first BlockId to compare
	p_pB	the second BlockId to compare

Returns:

true if they are the same, false if they are not

SO_PUBLIC uint32_t BlockId_StringLength

(

struct BlockId *

p_pB

)

Returns the size of string required in the ToText function.

Returns:

the size of the string

SO_PUBLIC void BlockId_ToText	(	const struct BlockId *	p_pA,
		uint8_t *	p_sText
	)

Converts a block id to text.

Parameters:

	p_pA	the block id to convert
	p_sText	the destination text