kernel: Some documentation improvements.

This commit is contained in:
Hans Leidekker 2005-12-21 20:44:49 +01:00 committed by Alexandre Julliard
parent 9a583763ee
commit fa57544a46
1 changed files with 33 additions and 21 deletions

View File

@ -2127,17 +2127,19 @@ void WINAPI ExitProcess( DWORD status )
/*********************************************************************** /***********************************************************************
* GetExitCodeProcess [KERNEL32.@] * GetExitCodeProcess [KERNEL32.@]
* *
* Gets termination status of specified process * Gets termination status of specified process.
*
* PARAMS
* hProcess [in] Handle to the process.
* lpExitCode [out] Address to receive termination status.
* *
* RETURNS * RETURNS
* Success: TRUE * Success: TRUE
* Failure: FALSE * Failure: FALSE
*/ */
BOOL WINAPI GetExitCodeProcess( BOOL WINAPI GetExitCodeProcess( HANDLE hProcess, LPDWORD lpExitCode )
HANDLE hProcess, /* [in] handle to the process */
LPDWORD lpExitCode) /* [out] address to receive termination status */
{ {
NTSTATUS status; NTSTATUS status;
PROCESS_BASIC_INFORMATION pbi; PROCESS_BASIC_INFORMATION pbi;
@ -2166,12 +2168,12 @@ UINT WINAPI SetErrorMode( UINT mode )
/********************************************************************** /**********************************************************************
* TlsAlloc [KERNEL32.@] Allocates a TLS index. * TlsAlloc [KERNEL32.@]
* *
* Allocates a thread local storage index * Allocates a thread local storage index.
* *
* RETURNS * RETURNS
* Success: TLS Index * Success: TLS index.
* Failure: 0xFFFFFFFF * Failure: 0xFFFFFFFF
*/ */
DWORD WINAPI TlsAlloc( void ) DWORD WINAPI TlsAlloc( void )
@ -2209,16 +2211,18 @@ DWORD WINAPI TlsAlloc( void )
/********************************************************************** /**********************************************************************
* TlsFree [KERNEL32.@] Releases a TLS index. * TlsFree [KERNEL32.@]
* *
* Releases a thread local storage index, making it available for reuse * Releases a thread local storage index, making it available for reuse.
*
* PARAMS
* index [in] TLS index to free.
* *
* RETURNS * RETURNS
* Success: TRUE * Success: TRUE
* Failure: FALSE * Failure: FALSE
*/ */
BOOL WINAPI TlsFree( BOOL WINAPI TlsFree( DWORD index )
DWORD index) /* [in] TLS Index to free */
{ {
BOOL ret; BOOL ret;
@ -2241,14 +2245,18 @@ BOOL WINAPI TlsFree(
/********************************************************************** /**********************************************************************
* TlsGetValue [KERNEL32.@] Gets value in a thread's TLS slot * TlsGetValue [KERNEL32.@]
*
* Gets value in a thread's TLS slot.
*
* PARAMS
* index [in] TLS index to retrieve value for.
* *
* RETURNS * RETURNS
* Success: Value stored in calling thread's TLS slot for index * Success: Value stored in calling thread's TLS slot for index.
* Failure: 0 and GetLastError() returns NO_ERROR * Failure: 0 and GetLastError() returns NO_ERROR.
*/ */
LPVOID WINAPI TlsGetValue( LPVOID WINAPI TlsGetValue( DWORD index )
DWORD index) /* [in] TLS index to retrieve value for */
{ {
LPVOID ret; LPVOID ret;
@ -2273,15 +2281,19 @@ LPVOID WINAPI TlsGetValue(
/********************************************************************** /**********************************************************************
* TlsSetValue [KERNEL32.@] Stores a value in the thread's TLS slot. * TlsSetValue [KERNEL32.@]
*
* Stores a value in the thread's TLS slot.
*
* PARAMS
* index [in] TLS index to set value for.
* value [in] Value to be stored.
* *
* RETURNS * RETURNS
* Success: TRUE * Success: TRUE
* Failure: FALSE * Failure: FALSE
*/ */
BOOL WINAPI TlsSetValue( BOOL WINAPI TlsSetValue( DWORD index, LPVOID value )
DWORD index, /* [in] TLS index to set value for */
LPVOID value) /* [in] Value to be stored */
{ {
if (index < TLS_MINIMUM_AVAILABLE) if (index < TLS_MINIMUM_AVAILABLE)
{ {