SPBlockDebugSuite Struct Reference
[API Suite List]

This suite provides basic debugging capability for blocks of memory allocated with the SPBlocksSuite. More...

#include <SPBckDbg.h>

List of all members.

Public Attributes
SPAPI SPErr(*	GetBlockDebugEnabled )(ai::int32 *enabled)
	Reports whether block debugging is enabled.
SPAPI SPErr(*	SetBlockDebugEnabled )(ai::int32 debug)
	Turns debugging on or off.
SPAPI SPErr(*	GetFirstBlock )(void **block)
	Retrieves the first block of memory allocated.
SPAPI SPErr(*	GetNextBlock )(void *block, void **nextblock)
	Retrieves the block of memory allocated immediately after a given block.
SPAPI SPErr(*	GetBlockDebug )(void *block, const char **debug)
	Retrieves the debugging tag assigned to a block of memory when it was allocated or reallocated.

---

Detailed Description

This suite provides basic debugging capability for blocks of memory allocated with the SPBlocksSuite.

Debugging can only be enabled in the development environment.

• Acquire this suite using SPBasicSuite::AcquireSuite() with the constants kSPBlockDebugSuite and kSPBlockDebugSuiteVersion.

---

Member Data Documentation

SPAPI SPErr(* SPBlockDebugSuite::GetBlockDebug)(void *block, const char **debug)

Retrieves the debugging tag assigned to a block of memory when it was allocated or reallocated.

Parameters:

	block	The block pointer.
	debug	[out] A buffer in which to return the tag string.

See also:

SPBlocksSuite::AllocateBlock(), SPBlocksSuite::ReallocateBlock()

SPAPI SPErr(* SPBlockDebugSuite::GetBlockDebugEnabled)(ai::int32 *enabled)

Reports whether block debugging is enabled.

Parameters:

enabled

[out] A buffer in which to return 1 if debugging is enabled, 0 otherwise.

SPAPI SPErr(* SPBlockDebugSuite::GetFirstBlock)(void **block)

Retrieves the first block of memory allocated.

Use with GetNextBlock() to iterate through all allocated blocks.

Parameters:

block

[out] A buffer in which to return the block pointer.

SPAPI SPErr(* SPBlockDebugSuite::GetNextBlock)(void *block, void **nextblock)

Retrieves the block of memory allocated immediately after a given block.

Use with GetFirstBlock() to iterate through all allocated blocks.

Parameters:

	block	The current block pointer
	nextblock	[out] A buffer in which to return the next block pointer.

SPAPI SPErr(* SPBlockDebugSuite::SetBlockDebugEnabled)(ai::int32 debug)

Turns debugging on or off.

Parameters:

debug

1 to turn debugging on, 0 to turn it off.

---

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

• SPBckDbg.h