arch/all-hosted/hostlib/freeerrorstr.c

   1 /*
   2     Copyright © 1995-2014, The AROS Development Team. All rights reserved.
   3     $Id$
   4 */
   5
   6 #include <aros/libcall.h>
   7
   8 /*****************************************************************************
   9
  10     NAME */
  11 #include <proto/hostlib.h>
  12
  13         AROS_LH1(void, HostLib_FreeErrorStr,
  14
  15 /*  SYNOPSIS */
  16         AROS_LHA(char *, error, A0),
  17
  18 /*  LOCATION */
  19         APTR, HostLibBase, 4, HostLib)
  20
  21 /*  FUNCTION
  22         Release error description string.
  23         In some dynamic library loaders (like in Windows) error strings
  24         are allocated dynamically. They need to be explicitly freed
  25         when not used any more.
  26
  27     INPUTS
  28         error  - Pointer to a string ro free.
  29
  30     RESULT
  31         None.
  32
  33     NOTES
  34         For portability sake, it is recommended to call this function on any
  35         error string returned by hostlib.resource. However you can omit this
  36         if you exactly know that your code runs only on UNIX-alike operating
  37         system (it's UNIX-specific library or driver).
  38
  39     EXAMPLE
  40
  41     BUGS
  42
  43     SEE ALSO
  44
  45     INTERNALS
  46
  47 *****************************************************************************/
  48 {
  49     AROS_LIBFUNC_INIT
  50
  51     /* Our error strings are static, there's nothing to do here */
  52
  53     AROS_LIBFUNC_EXIT
  54 }