arch/all-hosted/hostlib/freeerrorstr.c

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