Skip to content

W
wine-cw
Commit 4c1fa161 authored by Jon Griffiths's avatar Jon Griffiths Committed by Alexandre Julliard
Browse files
Options

Documentation updates.

parent 082e0bfe
Expand all Hide whitespace changes
Inline Side-by-side
Showing with 446 additions and 70 deletions
dlls/advapi32/security.c
View file @ 4c1fa161
......@@ -817,7 +817,7 @@ LookupPrivilegeValueW( LPCWSTR lpSystemName, LPCWSTR lpName, PLUID lpLuid )
* PARAMS
* lpSystemName [I] Name of the system
* lpName [I] Name of the privilege
* pLuid [O] Destination for the resulting LUD
* pLuid [O] Destination for the resulting LUID
*
* RETURNS
* Success: TRUE. pLuid contains the requested LUID.
......
dlls/gdi/wing.c
View file @ 4c1fa161
......@@ -29,6 +29,19 @@
WINE_DEFAULT_DEBUG_CHANNEL(wing);
/*************************************************************************
* WING {WING}
*
* The Windows Game dll provides a number of functions designed to allow
* programmers to bypass Gdi and write directly to video memory. The intention
* was to bolster the use of Windows as a gaming platform and remove the
* need for Dos based games using 32 bit Dos extenders.
*
* This initial approach could not compete with the performance of Dos games
* (such as Doom and Warcraft) at the time, and so this dll was eventually
* superceeded by DirectX. It should not be used by new applications, and is
* provided only for compatability with older Windows programs.
*/
typedef enum WING_DITHER_TYPE
{
......@@ -50,6 +63,15 @@ typedef enum WING_DITHER_TYPE
/***********************************************************************
* WinGCreateDC (WING.1001)
*
* Create a new WinG device context.
*
* PARAMS
* None.
*
* RETURNS
* Success: A handle to the created device context.
* Failure: A NULL handle.
*/
HDC16 WINAPI WinGCreateDC16(void)
{
......@@ -59,6 +81,15 @@ HDC16 WINAPI WinGCreateDC16(void)
/***********************************************************************
* WinGRecommendDIBFormat (WING.1002)
*
* Get the recommended format of bitmaps for the current display.
*
* PARAMS
* bmpi [O] Destination for format information
*
* RETURNS
* Success: TRUE. bmpi is filled with the best (fastest) bitmap format
* Failure: FALSE, if bmpi is NULL.
*/
BOOL16 WINAPI WinGRecommendDIBFormat16(BITMAPINFO *bmpi)
{
......@@ -85,6 +116,17 @@ BOOL16 WINAPI WinGRecommendDIBFormat16(BITMAPINFO *bmpi)
/***********************************************************************
* WinGCreateBitmap (WING.1003)
*
* Create a new WinG bitmap.
*
* PARAMS
* hdc [I] WinG device context
* bmpi [I] Information about the bitmap
* bits [I] Location of the bitmap image data
*
* RETURNS
* Success: A handle to the created bitmap.
* Failure: A NULL handle.
*/
HBITMAP16 WINAPI WinGCreateBitmap16(HDC16 hdc, BITMAPINFO *bmpi,
SEGPTR *bits)
......@@ -116,6 +158,17 @@ SEGPTR WINAPI WinGGetDIBPointer16(HBITMAP16 hWinGBitmap, BITMAPINFO* bmpi)
/***********************************************************************
* WinGSetDIBColorTable (WING.1006)
*
* Set all or part of the color table for a WinG device context.
*
* PARAMS
* hdc [I] WinG device context
* start [I] Start color
* num [I] Number of entries to set
* colors [I] Array of color data
*
* RETURNS
* The number of entries set.
*/
UINT16 WINAPI WinGSetDIBColorTable16(HDC16 hdc, UINT16 start, UINT16 num,
RGBQUAD *colors)
......@@ -126,6 +179,17 @@ UINT16 WINAPI WinGSetDIBColorTable16(HDC16 hdc, UINT16 start, UINT16 num,
/***********************************************************************
* WinGGetDIBColorTable (WING.1005)
*
* Get all or part of the color table for a WinG device context.
*
* PARAMS
* hdc [I] WinG device context
* start [I] Start color
* num [I] Number of entries to set
* colors [O] Destination for the array of color data
*
* RETURNS
* The number of entries retrieved.
*/
UINT16 WINAPI WinGGetDIBColorTable16(HDC16 hdc, UINT16 start, UINT16 num,
RGBQUAD *colors)
......@@ -136,6 +200,15 @@ UINT16 WINAPI WinGGetDIBColorTable16(HDC16 hdc, UINT16 start, UINT16 num,
/***********************************************************************
* WinGCreateHalfTonePalette (WING.1007)
*
* Create a half tone palette.
*
* PARAMS
* None.
*
* RETURNS
* Success: A handle to the created palette.
* Failure: A NULL handle.
*/
HPALETTE16 WINAPI WinGCreateHalfTonePalette16(void)
{
......@@ -148,6 +221,17 @@ HPALETTE16 WINAPI WinGCreateHalfTonePalette16(void)
/***********************************************************************
* WinGCreateHalfToneBrush (WING.1008)
*
* Create a half tone brush for a WinG device context.
*
* PARAMS
* winDC [I] WinG device context
* col [I] Color
* type [I] Desired dithering type.
*
* RETURNS
* Success: A handle to the created brush.
* Failure: A NULL handle.
*/
HBRUSH16 WINAPI WinGCreateHalfToneBrush16(HDC16 winDC, COLORREF col,
WING_DITHER_TYPE type)
......@@ -158,6 +242,8 @@ HBRUSH16 WINAPI WinGCreateHalfToneBrush16(HDC16 winDC, COLORREF col,
/***********************************************************************
* WinGStretchBlt (WING.1009)
*
* See StretchBlt16.
*/
BOOL16 WINAPI WinGStretchBlt16(HDC16 destDC, INT16 xDest, INT16 yDest,
INT16 widDest, INT16 heiDest,
......@@ -175,6 +261,8 @@ BOOL16 WINAPI WinGStretchBlt16(HDC16 destDC, INT16 xDest, INT16 yDest,
/***********************************************************************
* WinGBitBlt (WING.1010)
*
* See BitBlt16.
*/
BOOL16 WINAPI WinGBitBlt16(HDC16 destDC, INT16 xDest, INT16 yDest,
INT16 widDest, INT16 heiDest, HDC16 srcDC,
......
dlls/kernel/atom.c
View file @ 4c1fa161
......@@ -387,6 +387,15 @@ UINT16 WINAPI GetAtomName16( ATOM atom, LPSTR buffer, INT16 count )
/***********************************************************************
* InitAtomTable (KERNEL32.@)
*
* Initialise the global atom table.
*
* PARAMS
* entries [I] The number of entries to reserve in the table.
*
* RETURNS
* Success: TRUE.
* Failure: FALSE.
*/
BOOL WINAPI InitAtomTable( DWORD entries )
{
......@@ -430,14 +439,14 @@ static ATOM ATOM_AddAtomA( LPCSTR str, BOOL local )
/***********************************************************************
* GlobalAddAtomA (KERNEL32.@)
*
* Adds a character string to the global atom table and returns a unique
* value identifying the string.
* Add a character string to the global atom table and return a unique
* value identifying it.
*
* RETURNS
* Atom: Success
* 0: Failure
* Success: The atom allocated to str.
* Failure: 0.
*/
ATOM WINAPI GlobalAddAtomA( LPCSTR str /* [in] Pointer to string to add */ )
ATOM WINAPI GlobalAddAtomA( LPCSTR str /* [in] String to add */ )
{
return ATOM_AddAtomA( str, FALSE );
}
......@@ -445,14 +454,15 @@ ATOM WINAPI GlobalAddAtomA( LPCSTR str /* [in] Pointer to string to add */ )
/***********************************************************************
* AddAtomA (KERNEL32.@)
* Adds a string to the atom table and returns the atom identifying the
* string.
*
* Add a character string to the global atom table and return a unique
* value identifying it.
*
* RETURNS
* Atom: Success
* 0: Failure
* Success: The atom allocated to str.
* Failure: 0.
*/
ATOM WINAPI AddAtomA( LPCSTR str /* [in] Pointer to string to add */ )
ATOM WINAPI AddAtomA( LPCSTR str /* [in] String to add */ )
{
return ATOM_AddAtomA( str, TRUE );
}
......@@ -484,6 +494,8 @@ static ATOM ATOM_AddAtomW( LPCWSTR str, BOOL local )
/***********************************************************************
* GlobalAddAtomW (KERNEL32.@)
*
* Unicode version of GlobalAddAtomA.
*/
ATOM WINAPI GlobalAddAtomW( LPCWSTR str )
{
......@@ -493,6 +505,8 @@ ATOM WINAPI GlobalAddAtomW( LPCWSTR str )
/***********************************************************************
* AddAtomW (KERNEL32.@)
*
* Unicode version of AddAtomA.
*/
ATOM WINAPI AddAtomW( LPCWSTR str )
{
......@@ -519,12 +533,13 @@ static ATOM ATOM_DeleteAtom( ATOM atom, BOOL local)
/***********************************************************************
* GlobalDeleteAtom (KERNEL32.@)
* Decrements the reference count of a string atom. If the count is
*
* Decrement the reference count of a string atom. If the count is
* zero, the string associated with the atom is removed from the table.
*
* RETURNS
* 0: Success
* Atom: Failure
* Success: 0.
* Failure: atom.
*/
ATOM WINAPI GlobalDeleteAtom( ATOM atom /* [in] Atom to delete */ )
{
......@@ -534,12 +549,13 @@ ATOM WINAPI GlobalDeleteAtom( ATOM atom /* [in] Atom to delete */ )
/***********************************************************************
* DeleteAtom (KERNEL32.@)
* Decrements the reference count of a string atom. If count becomes
*
* Decrement the reference count of a string atom. If the count becomes
* zero, the string associated with the atom is removed from the table.
*
* RETURNS
* 0: Success
* Atom: Failure
* Success: 0.
* Failure: atom
*/
ATOM WINAPI DeleteAtom( ATOM atom /* [in] Atom to delete */ )
{
......@@ -576,12 +592,11 @@ static ATOM ATOM_FindAtomA( LPCSTR str, BOOL local )
/***********************************************************************
* GlobalFindAtomA (KERNEL32.@)
*
* Searches the atom table for the string and returns the atom
* associated with it.
* Get the atom associated with a string.
*
* RETURNS
* Atom: Success
* 0: Failure
* Success: The associated atom.
* Failure: 0.
*/
ATOM WINAPI GlobalFindAtomA( LPCSTR str /* [in] Pointer to string to search for */ )
{
......@@ -590,12 +605,12 @@ ATOM WINAPI GlobalFindAtomA( LPCSTR str /* [in] Pointer to string to search for
/***********************************************************************
* FindAtomA (KERNEL32.@)
* Searches the local atom table for the string and returns the atom
* associated with that string.
*
* Get the atom associated with a string.
*
* RETURNS
* Atom: Success
* 0: Failure
* Success: The associated atom.
* Failure: 0.
*/
ATOM WINAPI FindAtomA( LPCSTR str /* [in] Pointer to string to find */ )
{
......@@ -629,6 +644,8 @@ static ATOM ATOM_FindAtomW( LPCWSTR str, BOOL local )
/***********************************************************************
* GlobalFindAtomW (KERNEL32.@)
*
* Unicode version of GlobalFindAtomA.
*/
ATOM WINAPI GlobalFindAtomW( LPCWSTR str )
{
......@@ -638,6 +655,8 @@ ATOM WINAPI GlobalFindAtomW( LPCWSTR str )
/***********************************************************************
* FindAtomW (KERNEL32.@)
*
* Unicode version of FindAtomA.
*/
ATOM WINAPI FindAtomW( LPCWSTR str )
{
......@@ -701,11 +720,11 @@ static UINT ATOM_GetAtomNameA( ATOM atom, LPSTR buffer, INT count, BOOL local )
/***********************************************************************
* GlobalGetAtomNameA (KERNEL32.@)
*
* Retrieves a copy of the string associated with an atom.
* Get a copy of the string associated with an atom.
*
* RETURNS
* Length of string in characters: Success
* 0: Failure
* Success: The length of the returned string in characters.
* Failure: 0.
*/
UINT WINAPI GlobalGetAtomNameA(
ATOM atom, /* [in] Atom identifier */
......@@ -718,11 +737,12 @@ UINT WINAPI GlobalGetAtomNameA(
/***********************************************************************
* GetAtomNameA (KERNEL32.@)
* Retrieves a copy of the string associated with the atom.
*
* Get a copy of the string associated with an atom.
*
* RETURNS
* Length of string: Success
* 0: Failure
* Success: The length of the returned string in characters.
* Failure: 0.
*/
UINT WINAPI GetAtomNameA(
ATOM atom, /* [in] Atom */
......@@ -782,6 +802,8 @@ static UINT ATOM_GetAtomNameW( ATOM atom, LPWSTR buffer, INT count, BOOL local )
/***********************************************************************
* GlobalGetAtomNameW (KERNEL32.@)
*
* Unicode version of GlobalGetAtomNameA.
*/
UINT WINAPI GlobalGetAtomNameW( ATOM atom, LPWSTR buffer, INT count )
{
......@@ -791,6 +813,8 @@ UINT WINAPI GlobalGetAtomNameW( ATOM atom, LPWSTR buffer, INT count )
/***********************************************************************
* GetAtomNameW (KERNEL32.@)
*
* Unicode version of GetAtomNameA.
*/
UINT WINAPI GetAtomNameW( ATOM atom, LPWSTR buffer, INT count )
{
......
dlls/ntdll/large_int.c
View file @ 4c1fa161
......@@ -39,6 +39,15 @@
/******************************************************************************
* RtlLargeIntegerAdd (NTDLL.@)
*
* Add two 64 bit integers.
*
* PARAMS
* a [I] Initial number.
* b [I] Number to add to a.
*
* RETURNS
* The sum of a and b.
*/
LONGLONG WINAPI RtlLargeIntegerAdd( LONGLONG a, LONGLONG b )
{
......@@ -48,6 +57,15 @@ LONGLONG WINAPI RtlLargeIntegerAdd( LONGLONG a, LONGLONG b )
/******************************************************************************
* RtlLargeIntegerSubtract (NTDLL.@)
*
* Subtract two 64 bit integers.
*
* PARAMS
* a [I] Initial number.
* b [I] Number to subtract from a.
*
* RETURNS
* The difference of a and b.
*/
LONGLONG WINAPI RtlLargeIntegerSubtract( LONGLONG a, LONGLONG b )
{
......@@ -57,6 +75,14 @@ LONGLONG WINAPI RtlLargeIntegerSubtract( LONGLONG a, LONGLONG b )
/******************************************************************************
* RtlLargeIntegerNegate (NTDLL.@)
*
* Negate a 64 bit integer.
*
* PARAMS
* a [I] Initial number.
*
* RETURNS
* The value of a negated.
*/
LONGLONG WINAPI RtlLargeIntegerNegate( LONGLONG a )
{
......@@ -66,6 +92,15 @@ LONGLONG WINAPI RtlLargeIntegerNegate( LONGLONG a )
/******************************************************************************
* RtlLargeIntegerShiftLeft (NTDLL.@)
*
* Perform a shift left on a 64 bit integer.
*
* PARAMS
* a [I] Initial number.
* count [I] Number of bits to shift by
*
* RETURNS
* The value of a following the shift.
*/
LONGLONG WINAPI RtlLargeIntegerShiftLeft( LONGLONG a, INT count )
{
......@@ -75,6 +110,15 @@ LONGLONG WINAPI RtlLargeIntegerShiftLeft( LONGLONG a, INT count )
/******************************************************************************
* RtlLargeIntegerShiftRight (NTDLL.@)
*
* Perform a shift right on a 64 bit integer.
*
* PARAMS
* a [I] Initial number.
* count [I] Number of bits to shift by
*
* RETURNS
* The value of a following the shift.
*/
LONGLONG WINAPI RtlLargeIntegerShiftRight( LONGLONG a, INT count )
{
......@@ -84,6 +128,15 @@ LONGLONG WINAPI RtlLargeIntegerShiftRight( LONGLONG a, INT count )
/******************************************************************************
* RtlLargeIntegerArithmeticShift (NTDLL.@)
*
* Perform an arithmetic shift right on a 64 bit integer.
*
* PARAMS
* a [I] Initial number.
* count [I] Number of bits to shift by
*
* RETURNS
* The value of a following the shift.
*/
LONGLONG WINAPI RtlLargeIntegerArithmeticShift( LONGLONG a, INT count )
{
......@@ -95,7 +148,18 @@ LONGLONG WINAPI RtlLargeIntegerArithmeticShift( LONGLONG a, INT count )
/******************************************************************************
* RtlLargeIntegerDivide (NTDLL.@)
*
* FIXME: should it be signed division instead?
* Divide one 64 bit unsigned integer by another, with remainder.
*
* PARAMS
* a [I] Initial number.
* b [I] Number to divide a by
* rem [O] Destination for remainder
*
* RETURNS
* The dividend of a and b. If rem is non-NULL it is set to the remainder.
*
* FIXME
* Should it be signed division instead?
*/
ULONGLONG WINAPI RtlLargeIntegerDivide( ULONGLONG a, ULONGLONG b, ULONGLONG *rem )
{
......@@ -107,6 +171,14 @@ ULONGLONG WINAPI RtlLargeIntegerDivide( ULONGLONG a, ULONGLONG b, ULONGLONG *rem
/******************************************************************************
* RtlConvertLongToLargeInteger (NTDLL.@)
*
* Convert a 32 bit integer into 64 bits.
*
* PARAMS
* a [I] Number to convert
*
* RETURNS
* a.
*/
LONGLONG WINAPI RtlConvertLongToLargeInteger( LONG a )
{
......@@ -116,6 +188,14 @@ LONGLONG WINAPI RtlConvertLongToLargeInteger( LONG a )
/******************************************************************************
* RtlConvertUlongToLargeInteger (NTDLL.@)
*
* Convert a 32 bit unsigned integer into 64 bits.
*
* PARAMS
* a [I] Number to convert
*
* RETURNS
* a.
*/
ULONGLONG WINAPI RtlConvertUlongToLargeInteger( ULONG a )
{
......@@ -125,6 +205,15 @@ ULONGLONG WINAPI RtlConvertUlongToLargeInteger( ULONG a )
/******************************************************************************
* RtlEnlargedIntegerMultiply (NTDLL.@)
*
* Multiply two integers giving a 64 bit integer result.
*
* PARAMS
* a [I] Initial number.
* b [I] Number to multiply a by.
*
* RETURNS
* The product of a and b.
*/
LONGLONG WINAPI RtlEnlargedIntegerMultiply( INT a, INT b )
{
......@@ -134,6 +223,15 @@ LONGLONG WINAPI RtlEnlargedIntegerMultiply( INT a, INT b )
/******************************************************************************
* RtlEnlargedUnsignedMultiply (NTDLL.@)
*
* Multiply two unsigned integers giving a 64 bit unsigned integer result.
*
* PARAMS
* a [I] Initial number.
* b [I] Number to multiply a by.
*
* RETURNS
* The product of a and b.
*/
ULONGLONG WINAPI RtlEnlargedUnsignedMultiply( UINT a, UINT b )
{
......@@ -143,6 +241,16 @@ ULONGLONG WINAPI RtlEnlargedUnsignedMultiply( UINT a, UINT b )
/******************************************************************************
* RtlEnlargedUnsignedDivide (NTDLL.@)
*
* Divide one 64 bit unsigned integer by a 32 bit unsigned integer, with remainder.
*
* PARAMS
* a [I] Initial number.
* b [I] Number to divide a by
* remptr [O] Destination for remainder
*
* RETURNS
* The dividend of a and b. If remptr is non-NULL it is set to the remainder.
*/
UINT WINAPI RtlEnlargedUnsignedDivide( ULONGLONG a, UINT b, UINT *remptr )
{
......@@ -167,6 +275,16 @@ UINT WINAPI RtlEnlargedUnsignedDivide( ULONGLONG a, UINT b, UINT *remptr )
/******************************************************************************
* RtlExtendedLargeIntegerDivide (NTDLL.@)
*
* Divide one 64 bit integer by a 32 bit integer, with remainder.
*
* PARAMS
* a [I] Initial number.
* b [I] Number to divide a by
* rem [O] Destination for remainder
*
* RETURNS
* The dividend of a and b. If rem is non-NULL it is set to the remainder.
*/
LONGLONG WINAPI RtlExtendedLargeIntegerDivide( LONGLONG a, INT b, INT *rem )
{
......@@ -178,6 +296,15 @@ LONGLONG WINAPI RtlExtendedLargeIntegerDivide( LONGLONG a, INT b, INT *rem )
/******************************************************************************
* RtlExtendedIntegerMultiply (NTDLL.@)
*
* Multiply one 64 bit integer by another 32 bit integer.
*
* PARAMS
* a [I] Initial number.
* b [I] Number to multiply a by.
*
* RETURNS
* The product of a and b.
*/
LONGLONG WINAPI RtlExtendedIntegerMultiply( LONGLONG a, INT b )
{
......@@ -269,7 +396,7 @@ LONGLONG WINAPI RtlExtendedMagicDivide(
* DIFFERENCES
* - Accept base 0 as 10 instead of crashing as native function does.
* - The native function does produce garbage or STATUS_BUFFER_OVERFLOW for
* base 2, 8 and 16 when the value is larger than 0xFFFFFFFF.
* base 2, 8 and 16 when the value is larger than 0xFFFFFFFF.
*/
NTSTATUS WINAPI RtlLargeIntegerToChar(
const ULONGLONG *value_ptr, /* [I] Pointer to the value to be converted */
......@@ -383,6 +510,15 @@ NTSTATUS WINAPI RtlInt64ToUnicodeString(
/******************************************************************************
* _alldiv (NTDLL.@)
*
* Divide two 64 bit unsigned integers.
*
* PARAMS
* a [I] Initial number.
* b [I] Number to multiply a by.
*
* RETURNS
* The dividend of a and b.
*/
LONGLONG WINAPI _alldiv( LONGLONG a, LONGLONG b )
{
......@@ -392,6 +528,15 @@ LONGLONG WINAPI _alldiv( LONGLONG a, LONGLONG b )
/******************************************************************************
* _allmul (NTDLL.@)
*
* Multiply two 64 bit integers.
*
* PARAMS
* a [I] Initial number.
* b [I] Number to multiply a by.
*
* RETURNS
* The product of a and b.
*/
LONGLONG WINAPI _allmul( LONGLONG a, LONGLONG b )
{
......@@ -401,6 +546,15 @@ LONGLONG WINAPI _allmul( LONGLONG a, LONGLONG b )
/******************************************************************************
* _allrem (NTDLL.@)
*
* Calculate the remainder after dividing two 64 bit integers.
*
* PARAMS
* a [I] Initial number.
* b [I] Number to divide a by.
*
* RETURNS
* The remainder of a divided by b.
*/
LONGLONG WINAPI _allrem( LONGLONG a, LONGLONG b )
{
......@@ -410,6 +564,15 @@ LONGLONG WINAPI _allrem( LONGLONG a, LONGLONG b )
/******************************************************************************
* _aulldiv (NTDLL.@)
*
* Divide two 64 bit unsigned integers.
*
* PARAMS
* a [I] Initial number.
* b [I] Number to multiply a by.
*
* RETURNS
* The dividend of a and b.
*/
ULONGLONG WINAPI _aulldiv( ULONGLONG a, ULONGLONG b )
{
......@@ -419,6 +582,15 @@ ULONGLONG WINAPI _aulldiv( ULONGLONG a, ULONGLONG b )
/******************************************************************************
* _aullrem (NTDLL.@)
*
* Calculate the remainder after dividing two 64 bit unsigned integers.
*
* PARAMS
* a [I] Initial number.
* b [I] Number to divide a by.
*
* RETURNS
* The remainder of a divided by b.
*/
ULONGLONG WINAPI _aullrem( ULONGLONG a, ULONGLONG b )
{
......
dlls/shlwapi/string.c
View file @ 4c1fa161
......@@ -1745,7 +1745,7 @@ static HRESULT WINAPI _SHStrDupAA(LPCSTR src, LPSTR * dest)
}
/*************************************************************************
* SHStrDupA
* SHStrDupA [SHLWAPI.@]
*
* Return a Unicode copy of a string, in memory allocated by CoTaskMemAlloc().
*
......@@ -1812,7 +1812,7 @@ static HRESULT WINAPI _SHStrDupAW(LPCWSTR src, LPSTR * dest)
}
/*************************************************************************
* SHStrDupW
* SHStrDupW [SHLWAPI.@]
*
* See SHStrDupA.
*/
......
Markdown is supported
0% or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment