Autodoc formatting fixes.
[AROS.git] / arch / all-hosted / hostlib / lock.c
blob531cf72d3c2a34b01a63234f2fc2ede28df7ee66
1 #include <aros/libcall.h>
2 #include <proto/exec.h>
4 #include "hostlib_intern.h"
6 /*****************************************************************************
8 NAME */
9 #include <proto/hostlib.h>
11 AROS_LH0(void, HostLib_Lock,
13 /* SYNOPSIS */
15 /* LOCATION */
16 struct HostLibBase *, HostLibBase, 7, HostLib)
18 /* FUNCTION
19 Acquire global host OS call semaphore.
21 INPUTS
22 None.
24 RESULT
25 None.
27 NOTES
28 Host OS calls are typically not reentrant. You have to
29 call this function before you may use any host OS API.
30 Use HostLib_Unlock() function when you're done with it.
32 This function has negative impact on AROS multitasking, so
33 use it gently.
35 EXAMPLE
37 BUGS
39 SEE ALSO
40 HostLib_Unlock()
42 INTERNALS
43 The actual implementation of this function depends on
44 the host OS. Do not assume anything particular about it.
45 For example under Windows it's Forbid(), not a semaphore.
47 *****************************************************************************/
49 AROS_LIBFUNC_INIT
51 HOSTLIB_LOCK();
53 AROS_LIBFUNC_EXIT