Improve c2man Documented-Total count. Changes:

- add missing description
- add missing returns section
This commit is contained in:
Markus Amsler 2005-11-12 19:12:03 +00:00 committed by Alexandre Julliard
parent 8ba040e157
commit ec350525e3
5 changed files with 90 additions and 5 deletions

View File

@ -1533,6 +1533,8 @@ BOOL WINAPI CryptHashData (HCRYPTHASH hHash, const BYTE *pbData, DWORD dwDataLen
/****************************************************************************** /******************************************************************************
* CryptHashSessionKey (ADVAPI32.@) * CryptHashSessionKey (ADVAPI32.@)
* *
* Compute the cryptographic hash of a session key object.
*
* PARAMS * PARAMS
* hHash [I] Handle to the hash object. * hHash [I] Handle to the hash object.
* hKey [I] Handle to the key to be hashed. * hKey [I] Handle to the key to be hashed.
@ -1563,6 +1565,8 @@ BOOL WINAPI CryptHashSessionKey (HCRYPTHASH hHash, HCRYPTKEY hKey, DWORD dwFlags
/****************************************************************************** /******************************************************************************
* CryptImportKey (ADVAPI32.@) * CryptImportKey (ADVAPI32.@)
* *
* Transfer a cryptographic key from a key BLOB into a cryptographic service provider (CSP).
*
* PARAMS * PARAMS
* hProv [I] Handle of a CSP. * hProv [I] Handle of a CSP.
* pbData [I] Contains the key to be imported. * pbData [I] Contains the key to be imported.

View File

@ -101,6 +101,12 @@ void SHA1Transform(ULONG State[5], UCHAR Buffer[64])
* A_SHAInit [ADVAPI32.@] * A_SHAInit [ADVAPI32.@]
* *
* Initialize a SHA context structure. * Initialize a SHA context structure.
*
* PARAMS
* Context [O] SHA context
*
* RETURNS
* Nothing
*/ */
VOID WINAPI VOID WINAPI
A_SHAInit(PSHA_CTX Context) A_SHAInit(PSHA_CTX Context)
@ -119,6 +125,14 @@ A_SHAInit(PSHA_CTX Context)
* A_SHAUpdate [ADVAPI32.@] * A_SHAUpdate [ADVAPI32.@]
* *
* Update a SHA context with a hashed data from supplied buffer. * Update a SHA context with a hashed data from supplied buffer.
*
* PARAMS
* Context [O] SHA context
* Buffer [I] hashed data
* BufferSize [I] hashed data size
*
* RETURNS
* Nothing
*/ */
VOID WINAPI VOID WINAPI
A_SHAUpdate(PSHA_CTX Context, PCHAR Buffer, UINT BufferSize) A_SHAUpdate(PSHA_CTX Context, PCHAR Buffer, UINT BufferSize)
@ -155,6 +169,13 @@ A_SHAUpdate(PSHA_CTX Context, PCHAR Buffer, UINT BufferSize)
* A_SHAFinal [ADVAPI32.@] * A_SHAFinal [ADVAPI32.@]
* *
* Finalize SHA context and return the resulting hash. * Finalize SHA context and return the resulting hash.
*
* PARAMS
* Context [I/O] SHA context
* Result [O] resulting hash
*
* RETURNS
* Nothing
*/ */
VOID WINAPI VOID WINAPI
A_SHAFinal(PSHA_CTX Context, PULONG Result) A_SHAFinal(PSHA_CTX Context, PULONG Result)

View File

@ -442,6 +442,25 @@ BOOL WINAPI ReportEventW( HANDLE hEventLog, WORD wType, WORD wCategory, DWORD dw
/****************************************************************************** /******************************************************************************
* RegisterTraceGuidsW [ADVAPI32.@] * RegisterTraceGuidsW [ADVAPI32.@]
* *
* Register an event trace provider and the event trace classes that it uses
* to generate events.
*
* PARAMS
* RequestAddress [I] ControlCallback function
* RequestContext [I] Optional provider-defined context
* ControlGuid [I] GUID of the registering provider
* GuidCount [I] Number of elements in the TraceGuidReg array
* TraceGuidReg [I/O] Array of TRACE_GUID_REGISTRATION structures
* MofImagePath [I] not supported, set to NULL
* MofResourceNmae [I] not supported, set to NULL
* RegistrationHandle [O] Provider's registration handle
*
* RETURNS
* Success: ERROR_SUCCESS
* Failure: System error code
*
* FIXME
* Stub.
*/ */
ULONG WINAPI RegisterTraceGuidsW( WMIDPREQUEST RequestAddress, ULONG WINAPI RegisterTraceGuidsW( WMIDPREQUEST RequestAddress,
PVOID RequestContext, LPCGUID ControlGuid, ULONG GuidCount, PVOID RequestContext, LPCGUID ControlGuid, ULONG GuidCount,
@ -457,6 +476,10 @@ ULONG WINAPI RegisterTraceGuidsW( WMIDPREQUEST RequestAddress,
/****************************************************************************** /******************************************************************************
* RegisterTraceGuidsA [ADVAPI32.@] * RegisterTraceGuidsA [ADVAPI32.@]
* *
* See RegisterTraceGuidsW.
*
* FIXME
* Stub.
*/ */
ULONG WINAPI RegisterTraceGuidsA( WMIDPREQUEST RequestAddress, ULONG WINAPI RegisterTraceGuidsA( WMIDPREQUEST RequestAddress,
PVOID RequestContext, LPCGUID ControlGuid, ULONG GuidCount, PVOID RequestContext, LPCGUID ControlGuid, ULONG GuidCount,

View File

@ -381,7 +381,19 @@ DWORD WINAPI RegOpenKeyA( HKEY hkey, LPCSTR name, PHKEY retkey )
/****************************************************************************** /******************************************************************************
* RegOpenCurrentUser [ADVAPI32.@] * RegOpenCurrentUser [ADVAPI32.@]
* *
* FIXME: This function is supposed to retrieve a handle to the * Get a handle to the HKEY_CURRENT_USER key for the user
* the current thread is impersonating.
*
* PARAMS
* access [I] Desired access rights to the key
* retkey [O] Handle to the opened key
*
* RETURNS
* Success: ERROR_SUCCESS
* Failure: nonzero error code from Winerror.h
*
* FIXME
* This function is supposed to retrieve a handle to the
* HKEY_CURRENT_USER for the user the current thread is impersonating. * HKEY_CURRENT_USER for the user the current thread is impersonating.
* Since Wine does not currently allow threads to impersonate other users, * Since Wine does not currently allow threads to impersonate other users,
* this stub should work fine. * this stub should work fine.
@ -396,6 +408,8 @@ DWORD WINAPI RegOpenCurrentUser( REGSAM access, PHKEY retkey )
/****************************************************************************** /******************************************************************************
* RegEnumKeyExW [ADVAPI32.@] * RegEnumKeyExW [ADVAPI32.@]
* *
* Enumerate subkeys of the specified open registry key.
*
* PARAMS * PARAMS
* hkey [I] Handle to key to enumerate * hkey [I] Handle to key to enumerate
* index [I] Index of subkey to enumerate * index [I] Index of subkey to enumerate
@ -1837,6 +1851,9 @@ DWORD WINAPI RegDeleteValueA( HKEY hkey, LPCSTR name )
/****************************************************************************** /******************************************************************************
* RegLoadKeyW [ADVAPI32.@] * RegLoadKeyW [ADVAPI32.@]
* *
* Create a subkey under HKEY_USERS or HKEY_LOCAL_MACHINE and store
* registration information from a specified file into that subkey.
*
* PARAMS * PARAMS
* hkey [I] Handle of open key * hkey [I] Handle of open key
* subkey [I] Address of name of subkey * subkey [I] Address of name of subkey
@ -1900,6 +1917,8 @@ LONG WINAPI RegLoadKeyA( HKEY hkey, LPCSTR subkey, LPCSTR filename )
/****************************************************************************** /******************************************************************************
* RegSaveKeyW [ADVAPI32.@] * RegSaveKeyW [ADVAPI32.@]
* *
* Save a key and all of its subkeys and values to a new file in the standard format.
*
* PARAMS * PARAMS
* hkey [I] Handle of key where save begins * hkey [I] Handle of key where save begins
* lpFile [I] Address of filename to save to * lpFile [I] Address of filename to save to
@ -1981,6 +2000,8 @@ LONG WINAPI RegSaveKeyA( HKEY hkey, LPCSTR file, LPSECURITY_ATTRIBUTES sa )
/****************************************************************************** /******************************************************************************
* RegRestoreKeyW [ADVAPI32.@] * RegRestoreKeyW [ADVAPI32.@]
* *
* Read the registry information from a file and copy it over a key.
*
* PARAMS * PARAMS
* hkey [I] Handle of key where restore begins * hkey [I] Handle of key where restore begins
* lpFile [I] Address of filename containing saved tree * lpFile [I] Address of filename containing saved tree
@ -2026,6 +2047,8 @@ LONG WINAPI RegRestoreKeyA( HKEY hkey, LPCSTR lpFile, DWORD dwFlags )
/****************************************************************************** /******************************************************************************
* RegUnLoadKeyW [ADVAPI32.@] * RegUnLoadKeyW [ADVAPI32.@]
* *
* Unload a registry key and its subkeys from the registry.
*
* PARAMS * PARAMS
* hkey [I] Handle of open key * hkey [I] Handle of open key
* lpSubKey [I] Address of name of subkey to unload * lpSubKey [I] Address of name of subkey to unload
@ -2073,6 +2096,8 @@ LONG WINAPI RegUnLoadKeyA( HKEY hkey, LPCSTR lpSubKey )
/****************************************************************************** /******************************************************************************
* RegReplaceKeyW [ADVAPI32.@] * RegReplaceKeyW [ADVAPI32.@]
* *
* Replace the file backing a registry key and all its subkeys with another file.
*
* PARAMS * PARAMS
* hkey [I] Handle of open key * hkey [I] Handle of open key
* lpSubKey [I] Address of name of subkey * lpSubKey [I] Address of name of subkey
@ -2119,6 +2144,8 @@ LONG WINAPI RegReplaceKeyA( HKEY hkey, LPCSTR lpSubKey, LPCSTR lpNewFile,
/****************************************************************************** /******************************************************************************
* RegSetKeySecurity [ADVAPI32.@] * RegSetKeySecurity [ADVAPI32.@]
* *
* Set the security of an open registry key.
*
* PARAMS * PARAMS
* hkey [I] Open handle of key to set * hkey [I] Open handle of key to set
* SecurityInfo [I] Descriptor contents * SecurityInfo [I] Descriptor contents
@ -2212,6 +2239,8 @@ DWORD WINAPI RegFlushKey( HKEY hkey )
/****************************************************************************** /******************************************************************************
* RegConnectRegistryW [ADVAPI32.@] * RegConnectRegistryW [ADVAPI32.@]
* *
* Establishe a connection to a predefined registry key on another computer.
*
* PARAMS * PARAMS
* lpMachineName [I] Address of name of remote computer * lpMachineName [I] Address of name of remote computer
* hHey [I] Predefined registry handle * hHey [I] Predefined registry handle
@ -2276,6 +2305,8 @@ LONG WINAPI RegConnectRegistryA( LPCSTR machine, HKEY hkey, PHKEY reskey )
/****************************************************************************** /******************************************************************************
* RegNotifyChangeKeyValue [ADVAPI32.@] * RegNotifyChangeKeyValue [ADVAPI32.@]
* *
* Notify the caller about changes to the attributes or contents of a registry key.
*
* PARAMS * PARAMS
* hkey [I] Handle of key to watch * hkey [I] Handle of key to watch
* fWatchSubTree [I] Flag for subkey notification * fWatchSubTree [I] Flag for subkey notification

View File

@ -274,6 +274,8 @@ CheckTokenMembership( HANDLE TokenHandle, PSID SidToCheck,
/****************************************************************************** /******************************************************************************
* GetTokenInformation [ADVAPI32.@] * GetTokenInformation [ADVAPI32.@]
* *
* Get a type of information about an access token.
*
* PARAMS * PARAMS
* token [I] Handle from OpenProcessToken() or OpenThreadToken() * token [I] Handle from OpenProcessToken() or OpenThreadToken()
* tokeninfoclass [I] A TOKEN_INFORMATION_CLASS from "winnt.h" * tokeninfoclass [I] A TOKEN_INFORMATION_CLASS from "winnt.h"
@ -629,6 +631,10 @@ GetLengthSid (PSID pSid)
* pOldSD [I] * pOldSD [I]
* lpdwBufferLength [I/O] * lpdwBufferLength [I/O]
* pNewSD [O] * pNewSD [O]
*
* RETURNS
* Success: ERROR_SUCCESS
* Failure: nonzero error code from Winerror.h
*/ */
DWORD WINAPI BuildSecurityDescriptorA( DWORD WINAPI BuildSecurityDescriptorA(
IN PTRUSTEE_A pOwner, IN PTRUSTEE_A pOwner,