Documentation updates

This commit is contained in:
Jon Griffiths 2003-11-25 00:08:46 +00:00 committed by Alexandre Julliard
parent b82f98cb90
commit eff671ef0d
2 changed files with 42 additions and 17 deletions

View File

@ -166,6 +166,18 @@ static void create_registry_keys( const SYSTEM_INFO *info )
/**************************************************************************** /****************************************************************************
* QueryPerformanceCounter (KERNEL32.@) * QueryPerformanceCounter (KERNEL32.@)
*
* Get the current value of the performance counter.
*
* PARAMS
* counter [O] Destination for the current counter reading
*
* RETURNS
* Success: TRUE. counter contains the current reading
* Failure: FALSE.
*
* SEE ALSO
* See QueryPerformanceFrequency.
*/ */
BOOL WINAPI QueryPerformanceCounter(PLARGE_INTEGER counter) BOOL WINAPI QueryPerformanceCounter(PLARGE_INTEGER counter)
{ {
@ -190,6 +202,18 @@ BOOL WINAPI QueryPerformanceCounter(PLARGE_INTEGER counter)
/**************************************************************************** /****************************************************************************
* QueryPerformanceFrequency (KERNEL32.@) * QueryPerformanceFrequency (KERNEL32.@)
*
* Get the resolution of the performace counter.
*
* PARAMS
* frequency [O] Destination for the counter resolution
*
* RETURNS
* Success. TRUE. Frequency contains the resolution of the counter.
* Failure: FALSE.
*
* SEE ALSO
* See QueryPerformanceCounter.
*/ */
BOOL WINAPI QueryPerformanceFrequency(PLARGE_INTEGER frequency) BOOL WINAPI QueryPerformanceFrequency(PLARGE_INTEGER frequency)
{ {
@ -211,27 +235,25 @@ BOOL WINAPI QueryPerformanceFrequency(PLARGE_INTEGER frequency)
/*********************************************************************** /***********************************************************************
* GetSystemInfo [KERNEL32.@] * GetSystemInfo [KERNEL32.@]
* *
* Gets the current system information. * Get information about the system.
* *
* RETURNS
* Nothing.
*
* NOTES
* On the first call it creates cached values, so it doesn't have to determine * On the first call it creates cached values, so it doesn't have to determine
* them repeatedly. On Linux, the /proc/cpuinfo special file is used. * them repeatedly. On Linux, the "/proc/cpuinfo" special file is used.
* *
* It creates a registry subhierarchy, looking like: * It creates a registry subhierarchy, looking like:
* \HARDWARE\DESCRIPTION\System\CentralProcessor\<processornumber>\ * "\HARDWARE\DESCRIPTION\System\CentralProcessor\<processornumber>\Identifier (CPU x86)".
* Identifier (CPU x86)
* Note that there is a hierarchy for every processor installed, so this * Note that there is a hierarchy for every processor installed, so this
* supports multiprocessor systems. This is done like Win95 does it, I think. * supports multiprocessor systems. This is done like Win95 does it, I think.
* *
* It also creates a cached flag array for IsProcessorFeaturePresent(). * It also creates a cached flag array for IsProcessorFeaturePresent().
*
* No NULL ptr check for LPSYSTEM_INFO in Win9x.
*
* RETURNS
* nothing, really
*/ */
VOID WINAPI GetSystemInfo( VOID WINAPI GetSystemInfo(
LPSYSTEM_INFO si /* [out] system information */ LPSYSTEM_INFO si /* [out] Destination for system information, may not be NULL */)
) { {
static int cache = 0; static int cache = 0;
static SYSTEM_INFO cachedsi; static SYSTEM_INFO cachedsi;
@ -568,13 +590,16 @@ VOID WINAPI GetSystemInfo(
/*********************************************************************** /***********************************************************************
* IsProcessorFeaturePresent [KERNEL32.@] * IsProcessorFeaturePresent [KERNEL32.@]
* RETURNS: *
* TRUE if processor feature present * Determine if the cpu supports a given feature.
* FALSE otherwise *
* RETURNS
* TRUE, If the processor supports feature,
* FALSE otherwise.
*/ */
BOOL WINAPI IsProcessorFeaturePresent ( BOOL WINAPI IsProcessorFeaturePresent (
DWORD feature /* [in] feature number, see PF_ defines */ DWORD feature /* [in] Feature number, (PF_ constants from "winnt.h") */)
) { {
SYSTEM_INFO si; SYSTEM_INFO si;
GetSystemInfo (&si); /* To ensure the information is loaded and cached */ GetSystemInfo (&si); /* To ensure the information is loaded and cached */

View File

@ -727,7 +727,7 @@ GetDateTimeFormatA_InvalidParameter:
* cchOut [I] Size of lpDateStr, or 0 to calculate the resulting size * cchOut [I] Size of lpDateStr, or 0 to calculate the resulting size
* *
* NOTES * NOTES
* - If lpFormat is NULL, lpszValue will be formatted according to the format * - If lpFormat is NULL, lpDateStr will be formatted according to the format
* details returned by GetLocaleInfoA() and modified by dwFlags. * details returned by GetLocaleInfoA() and modified by dwFlags.
* - lpFormat is a string of characters and formatting tokens. Any characters * - lpFormat is a string of characters and formatting tokens. Any characters
* in the string are copied verbatim to lpDateStr, with tokens being replaced * in the string are copied verbatim to lpDateStr, with tokens being replaced