StarBurn SDK (Software Development Kit)
ContentsIndexHome
PreviousUpNext
StarBurn_ISO9660JolietFileTree_Remove Function
C++
__stdcall STARBURN_IMPEX_API BOOLEAN StarBurn_ISO9660JolietFileTree_Remove(IN PVOID p__PVOID__ISO9660JolietFileTree, IN OUT PVOID * p__PPVOID__ISO9660JolietFileTreeNode);
Parameters 
Description 
IN PVOID p__PVOID__ISO9660JolietFileTree 
Pointer to the ISO9660 or Joliet file tree object that toolkit allocated during call to StarBurn_ISO9660JolietFileTree_Create().
 
IN OUT PVOID * p__PPVOID__ISO9660JolietFileTreeNode 
Pointer to pointer to the ISO9660 or Joliet file tree node object that is either result of previous tree node kids enumeration with StarBurn_ISO9660JolietFileTree_GetFirstKid() and StarBurn_ISO9660JolietFileTree_GetNextKid() or the result of call to StarBurn_ISO9660JolietFileTree_GetRoot(). 

TRUE if the node was destroyed, FALSE if node was not destroyed.

This function deletes ISO9660 or Joliet file tree node and all it's kids.

You cannot delete root node - FALSE will be returned in this case.

This example allocates Joliet file tree, get root node, gets first kid, deletes first node and destroys it (tree) after it's not needed any more. 

 

// Somewhere in the data region
PVOID l__PVOID__FileTree;
EXCEPTION_NUMBER l__EXCEPTION_NUMBER;
ULONG l__ULONG__TreeNodes;
ULONG l__ULONG__SystemError;
CHAR l__CHAR__ExceptionText[ 1024 ];
PVOID l__PVOID__RootNode;
PVOID l__PVOID__FirstKidNode;

// Prepare exception text buffer
RtlZeroMemory(
    &l__CHAR__ExceptionText,
    sizeof( l__CHAR__ExceptionText )
    );

// Try to create Joliet file tree
l__EXCEPTION_NUMBER =
StarBurn_ISO9660JolietFileTree_Create(
    &l__PVOID__FileTree,
    ( PCHAR )( &l__CHAR__ExceptionText ),
    sizeof( l__CHAR__ExceptionText ),
    &l__ULONG__Status,
    ( PCALLBACK )( StarBurn_Callback ),
    ( PVOID )( &l__LONG__TreeNodes ),
    TRUE,
    FALSE,
    FILE_TREE_JOLIET
    );

// Check for correct reply
if (  l__EXCEPTION_NUMBER != EN_SUCCESS )
{
// Handle error here...
}

// Add directories or files with the help of the StarBurn_ISO9660JolietFileTree_Add here...

// Get root node here
l__PVOID__RootNode =
StarBurn_ISO9660JolietFileTree_GetRoot( l__PVOID__FileTree );

// Check for correct response
if ( l__PVOID__RootNode == NULL )
{
// Handle error here...
}

// Get first kid node here
l__PVOID__FirstKidNode =
StarBurn_ISO9660JolietFileTree_GetFirstKid(
    l__PVOID__FileTree,
    l__PVOID__RootNode
    );

// Check for correct response
if ( l__PVOID__FirstKidNode == NULL )
{
// Handle error here...
}

// Try to delete first kid
if (
StarBurn_ISO9660JolietFileTree_Remove(
    l__PVOID__ISO9660JolietFileTree,
    &l__PVOID__FirstKidNode
    ) == FALSE
)
{
// Handle error here...
}

// Do something with Joliet file tree root node here...

// Destroy the Joliet file tree
StarBurn_Destroy( &l__PVOID__FileTree );

// Just check for pointer (paranoid?)
if ( l__PVOID__FileTree != NULL )
{
// Handle error here...
}