From 640605a8d95e6c14d08cb8bda1cb04a062750c5c Mon Sep 17 00:00:00 2001 From: Simon Rozman Date: Fri, 24 Jul 2020 08:29:55 +0200 Subject: api: update documentation Signed-off-by: Simon Rozman --- api/registry.c | 101 ++++++++++++++++++++++++++++----------------------------- 1 file changed, 50 insertions(+), 51 deletions(-) (limited to 'api/registry.c') diff --git a/api/registry.c b/api/registry.c index 7a68e58..f822a0e 100644 --- a/api/registry.c +++ b/api/registry.c @@ -53,15 +53,15 @@ OpenKeyWait(_In_ HKEY Key, _Inout_z_ WCHAR *Path, _In_ DWORD Access, _In_ ULONGL * * @param Key Handle of the parent registry key. Must be opened with notify access. * - * @param Path Subpath of the registry key to open + * @param Path Subpath of the registry key to open. * - * @param Access A mask that specifies the desired access rights to the key to be opened + * @param Access A mask that specifies the desired access rights to the key to be opened. * - * @param Timeout Timeout to wait for the value in milliseconds + * @param Timeout Timeout to wait for the value in milliseconds. * - * @param KeyOut Pointer to a variable to receive the key handle + * @param KeyOut Pointer to a variable to receive the key handle. * - * @return ERROR_SUCCESS on success; WAIT_TIMEOUT on timeout; error code otherwise + * @return ERROR_SUCCESS on success; WAIT_TIMEOUT on timeout; Win32 error code otherwise. */ WINTUN_STATUS RegistryOpenKeyWait( @@ -88,19 +88,19 @@ RegistryWaitForKey(_In_ HKEY Key, _In_z_count_c_(MAX_REG_PATH) const WCHAR *Path } /** - * Validate and/or sanitize string value read from registry. + * Validates and/or sanitizes string value read from registry. * - * @param Buf On input, it contains pointer to pointer where the data is stored. The data must be - * allocated using HeapAlloc(GetProcessHeap(), 0). - * On output, it contains pointer to pointer where the sanitized data is stored. It must be - * released with HeapFree(GetProcessHeap(), 0, *Buf) after use. + * @param Buf On input, it contains a pointer to pointer where the data is stored. The data must be allocated + * using HeapAlloc(GetProcessHeap(), 0). On output, it contains a pointer to pointer where the + * sanitized data is stored. It must be released with HeapFree(GetProcessHeap(), 0, *Buf) after + * use. * - * @param Len Length of data string in wide characters + * @param Len Length of data string in wide characters. * * @param ValueType Type of data. Must be either REG_SZ or REG_EXPAND_SZ. REG_MULTI_SZ is treated like REG_SZ; only * the first string of a multi-string is to be used. * - * @return ERROR_SUCCESS on success; Win32 error code otherwise + * @return ERROR_SUCCESS on success; Win32 error code otherwise. */ WINTUN_STATUS RegistryGetString(_Inout_ WCHAR **Buf, _In_ DWORD Len, _In_ DWORD ValueType) @@ -153,18 +153,18 @@ RegistryGetString(_Inout_ WCHAR **Buf, _In_ DWORD Len, _In_ DWORD ValueType) } /** - * Validate and/or sanitize multi-string value read from registry. + * Validates and/or sanitizes multi-string value read from registry. * - * @param Buf On input, it contains pointer to pointer where the data is stored. The data must be - * allocated using HeapAlloc(GetProcessHeap(), 0). - * On output, it contains pointer to pointer where the sanitized data is stored. It must be - * released with HeapFree(GetProcessHeap(), 0, *Buf) after use. + * @param Buf On input, it contains a pointer to pointer where the data is stored. The data must be allocated + * using HeapAlloc(GetProcessHeap(), 0). On output, it contains a pointer to pointer where the + * sanitized data is stored. It must be released with HeapFree(GetProcessHeap(), 0, *Buf) after + * use. * - * @param Len Length of data string in wide characters + * @param Len Length of data string in wide characters. * * @param ValueType Type of data. Must be one of REG_MULTI_SZ, REG_SZ or REG_EXPAND_SZ. * - * @return ERROR_SUCCESS on success; Win32 error code otherwise + * @return ERROR_SUCCESS on success; Win32 error code otherwise. */ WINTUN_STATUS RegistryGetMultiString(_Inout_ WCHAR **Buf, _In_ DWORD Len, _In_ DWORD ValueType) @@ -223,10 +223,9 @@ RegistryGetMultiString(_Inout_ WCHAR **Buf, _In_ DWORD Len, _In_ DWORD ValueType /** * Retrieves the type and data for the specified value name associated with an open registry key. * - * @param Key Handle of the registry key to read from. Must be opened with read - * access. + * @param Key Handle of the registry key to read from. Must be opened with read access. * - * @param Name Name of the value to read + * @param Name Name of the value to read. * * @param ValueType A pointer to a variable that receives a code indicating the type of data stored in the specified * value. @@ -237,7 +236,7 @@ RegistryGetMultiString(_Inout_ WCHAR **Buf, _In_ DWORD Len, _In_ DWORD ValueType * @param BufLen On input, a hint of expected registry value size in bytes; on output, actual registry value size * in bytes. * - * @return ERROR_SUCCESS on success; Win32 error code otherwise + * @return ERROR_SUCCESS on success; Win32 error code otherwise. */ static WINTUN_STATUS RegistryQuery( @@ -265,17 +264,17 @@ RegistryQuery( /** * Reads string value from registry key. * - * @param Key Handle of the registry key to read from. Must be opened with read - * access. + * @param Key Handle of the registry key to read from. Must be opened with read access. * - * @param Name Name of the value to read + * @param Name Name of the value to read. * - * @param Value Pointer to string to retrieve registry value. If the value type is - * REG_EXPAND_SZ the value is expanded using ExpandEnvironmentStrings(). If the value type is - * REG_MULTI_SZ, only the first string from the multi-string is returned. - * The string must be released with HeapFree(GetProcessHeap(), 0, Value) after use. + * @param Value Pointer to string to retrieve registry value. If the value type is REG_EXPAND_SZ the value is + * expanded using ExpandEnvironmentStrings(). If the value type is REG_MULTI_SZ, only the first + * string from the multi-string is returned. The string must be released with + * HeapFree(GetProcessHeap(), 0, Value) after use. * - * @return ERROR_SUCCESS on success; Win32 error code otherwise + * @return ERROR_SUCCESS on success; ERROR_INVALID_DATATYPE when the registry value is not a string; Win32 error code + * otherwise. */ WINTUN_STATUS RegistryQueryString(_In_ HKEY Key, _In_opt_z_ const WCHAR *Name, _Out_ WCHAR **Value) @@ -302,19 +301,19 @@ RegistryQueryString(_In_ HKEY Key, _In_opt_z_ const WCHAR *Name, _Out_ WCHAR **V /** * Reads string value from registry key. It waits for the registry value to become available. * - * @param Key Handle of the registry key to read from. Must be opened with read and notify - * access. + * @param Key Handle of the registry key to read from. Must be opened with read and notify access. * - * @param Name Name of the value to read + * @param Name Name of the value to read. * - * @param Timeout Timeout to wait for the value in milliseconds + * @param Timeout Timeout to wait for the value in milliseconds. * - * @param Value Pointer to string to retrieve registry value. If the value type is - * REG_EXPAND_SZ the value is expanded using ExpandEnvironmentStrings(). - * The string must be released with HeapFree(GetProcessHeap(), 0, Value) - * after use. + * @param Value Pointer to string to retrieve registry value. If the value type is REG_EXPAND_SZ the value is + * expanded using ExpandEnvironmentStrings(). If the value type is REG_MULTI_SZ, only the first + * string from the multi-string is returned. The string must be released with + * HeapFree(GetProcessHeap(), 0, Value) after use. * - * @return ERROR_SUCCESS on success; Win32 error code otherwise + * @return ERROR_SUCCESS on success; WAIT_TIMEOUT on timeout; ERROR_INVALID_DATATYPE when the registry value is a + * string; Win32 error code otherwise. */ WINTUN_STATUS RegistryQueryStringWait(_In_ HKEY Key, _In_opt_z_ const WCHAR *Name, _In_ DWORD Timeout, _Out_ WCHAR **Value) @@ -345,14 +344,14 @@ RegistryQueryStringWait(_In_ HKEY Key, _In_opt_z_ const WCHAR *Name, _In_ DWORD /** * Reads a 32-bit DWORD value from registry key. * - * @param Key Handle of the registry key to read from. Must be opened with read - * access. + * @param Key Handle of the registry key to read from. Must be opened with read access. * - * @param Name Name of the value to read + * @param Name Name of the value to read. * - * @param Value Pointer to DWORD to retrieve registry value + * @param Value Pointer to DWORD to retrieve registry value. * - * @return ERROR_SUCCESS on success; Win32 error code otherwise + * @return ERROR_SUCCESS on success; ERROR_INVALID_DATATYPE when registry value exist but not REG_DWORD type; + * ERROR_INVALID_DATA when registry value size is not 4 bytes; Win32 error code otherwise. */ WINTUN_STATUS RegistryQueryDWORD(_In_ HKEY Key, _In_opt_z_ const WCHAR *Name, _Out_ DWORD *Value) @@ -371,16 +370,16 @@ RegistryQueryDWORD(_In_ HKEY Key, _In_opt_z_ const WCHAR *Name, _Out_ DWORD *Val /** * Reads a 32-bit DWORD value from registry key. It waits for the registry value to become available. * - * @param Key Handle of the registry key to read from. Must be opened with read - * access. + * @param Key Handle of the registry key to read from. Must be opened with read access. * - * @param Name Name of the value to read + * @param Name Name of the value to read. * - * @param Timeout Timeout to wait for the value in milliseconds + * @param Timeout Timeout to wait for the value in milliseconds. * - * @param Value Pointer to DWORD to retrieve registry value + * @param Value Pointer to DWORD to retrieve registry value. * - * @return ERROR_SUCCESS on success; Win32 error code otherwise + * @return ERROR_SUCCESS on success; WAIT_TIMEOUT on timeout; ERROR_INVALID_DATATYPE when registry value exist but not + * REG_DWORD type; ERROR_INVALID_DATA when registry value size is not 4 bytes; Win32 error code otherwise. */ WINTUN_STATUS RegistryQueryDWORDWait(_In_ HKEY Key, _In_opt_z_ const WCHAR *Name, _In_ DWORD Timeout, _Out_ DWORD *Value) -- cgit v1.2.3-59-g8ed1b