AIDA_boDeleteStack

The AIDA_boDeleteStack function deletes an AIDA stack.

bool AIDA_boDeleteStack(
  handle hStack
);

Parameters

hStack: Handle to a stack previously created by AIDA_hCreateStack, AIDA_hCreateStackEx, AIDA_hRestoreStack, AIDA_hRestoreStackRaw or AIDA_hRestoreStackEx.

Return Values

AIDA_boDeleteStack returns True on success, or False if a stack could not be deleted.

If the function fails, the application can retrieve the error code using AIDA_iGetError.

Remarks

AIDA_boDeleteStack is defined as a macro that clears the handle if the stack could be deleted. This shall avoid calls to AIDA functions with invalid handles.

Example

/* CREATESTACK.C: This program creates an AIDA
 * stack and deletes it afterwards.
 */

#include <stdio.h>
#include <errno.h>
#include "bsk_aida.h";

void main( void )
{
  handle hStack;

  /* Create a stack */
  hStack = AIDA_hCreateStack();
  if( hStack == NULL )
    printf( "Error creating stack: %d!\n", AIDA_iGetError() );
  else
  {
    printf( "Stack created.\n" );
    if( !AIDA_boDeleteStack( hStack ) )
      printf( "Error deleting stack: %d!\n", AIDA_iGetError() );
    else
      printf( "Stack deleted.\n" );
  }
}

Output

Stack created
Stack deleted

QuickInfo

  Windows NT: Requires version 3.1 or later.
  Windows: Requires Windows 95 or later.
  Linux: Requires a kernel supporting ELF binaries.
  Header: Declared in bsk_aida.h, also requires portab.h.
  Import Library (Windows): Use BSK_AIDA.lib.