AIDA_boSaveStack

The AIDA_boSaveStack function saves the current configuration of an AIDA stack into a configuration file. AIDA Configuration files consist of various data chunks so that different parts of the AIDA system can share the same configuration file. The AIDA_boSaveStack function uses the STACKCFG data chunk for storing its information.

bool AIDA_boSaveStack(
  handle hStack,
  const xchar *xsFileName,
  bool boReplaceFile,
  const xchar *xsComment
);

Parameters

hStack

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

xsFileName

Filename of the configuration file to be used. The filename has to be a valid name for the target operating system. It has to be passed without extension.

boReplaceFile

When set to true the configuration file will be overwritten. Otherwise AIDA_boSaveStack will just replace the chunk with the stack configuration data.

xsComment

points to a string that contains a comment to be added to the configuration file. If no comment shall be added xsComment can be NULL. Please note that xsComment will be stored as ASCII string. The maximum size of the comment including the trailing '\0' character is AIDA_nMaxCommentBufferSize. Longer comments will be truncated.

Return Values

AIDA_boSaveStack returns true in case of success.

If the function fails, the returned value is false. The application can retrieve the error code using AIDA_iGetError.

Remarks

Attention: Stack manipulation functions and component configuration functions may not be called simultaneously from different threads with the same handle or otherwise will cause unpredictable results.

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.

See Also

AIDA Overview, AIDA Functions, AIDA_hCreateStack, AIDA_hCreateStackEx, AIDA_boDeleteStack, AIDA_hRestoreStack, AIDA_hRestoreStackRaw, AIDA_hRestoreStackEx, AIDA_pastSetReplacementTable, AIDA_bAddToStack, AIDA_boRemoveFromStack, AIDA_xsComponentName