sean-m
/
Vanara
mirror of https://github.com/dahall/Vanara.git
1
0
Fork 0
Code Issues Releases Wiki Activity

Updated docs and added unit tests for profileapi.h

pull/83/head
David Hall 2019-07-10 11:28:36 -06:00
parent 1996fadd69
commit 0905e01329
2 changed files with 43 additions and 15 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

35
PInvoke/Kernel32/ProfileApi.cs
View File

@ -5,42 +5,47 @@ namespace Vanara.PInvoke
public static partial class Kernel32
{
/// <summary>
/// Retrieves the current value of the performance counter, which is a high resolution (&lt;1us) time stamp that can be used for time-interval measurements.
/// Retrieves the current value of the performance counter, which is a high resolution (&lt;1us) time stamp that can be used for
/// time-interval measurements.
/// </summary>
/// <param name="lpPerformanceCount">A pointer to a variable that receives the current performance-counter value, in counts.</param>
/// <returns>
/// <para>If the function succeeds, the return value is nonzero.</para>
/// <para>
/// If the function fails, the return value is zero. To get extended error information, call <c>GetLastError</c>. On systems that run Windows XP or
/// later, the function will always succeed and will thus never return zero.
/// If the function fails, the return value is zero. To get extended error information, call GetLastError. On systems that run
/// Windows XP or later, the function will always succeed and will thus never return zero.
/// </para>
/// </returns>
// BOOL WINAPI QueryPerformanceCounter( _Out_ LARGE_INTEGER *lpPerformanceCount);
// https://msdn.microsoft.com/en-us/library/windows/desktop/ms644904(v=vs.85).aspx
/// <remarks>For more info about this function and its usage, see Acquiring high-resolution time stamps.</remarks>
// https://docs.microsoft.com/en-us/windows/win32/api/profileapi/nf-profileapi-queryperformancecounter BOOL QueryPerformanceCounter(
// LARGE_INTEGER *lpPerformanceCount );
[DllImport(Lib.Kernel32, SetLastError = true, ExactSpelling = true)]
[PInvokeData("Winbase.h", MSDNShortId = "ms644904")]
[PInvokeData("profileapi.h")]
[return: MarshalAs(UnmanagedType.Bool)]
public static extern bool QueryPerformanceCounter(out long lpPerformanceCount);
/// <summary>
/// Retrieves the frequency of the performance counter. The frequency of the performance counter is fixed at system boot and is consistent across all
/// processors. Therefore, the frequency need only be queried upon application initialization, and the result can be cached.
/// Retrieves the frequency of the performance counter. The frequency of the performance counter is fixed at system boot and is
/// consistent across all processors. Therefore, the frequency need only be queried upon application initialization, and the result
/// can be cached.
/// </summary>
/// <param name="lpFrequency">
/// A pointer to a variable that receives the current performance-counter frequency, in counts per second. If the installed hardware doesn't support a
/// high-resolution performance counter, this parameter can be zero (this will not occur on systems that run Windows XP or later).
/// A pointer to a variable that receives the current performance-counter frequency, in counts per second. If the installed hardware
/// doesn't support a high-resolution performance counter, this parameter can be zero (this will not occur on systems that run
/// Windows XP or later).
/// </param>
/// <returns>
/// <para>If the installed hardware supports a high-resolution performance counter, the return value is nonzero.</para>
/// <para>
/// If the function fails, the return value is zero. To get extended error information, call <c>GetLastError</c>. On systems that run Windows XP or
/// later, the function will always succeed and will thus never return zero.
/// If the function fails, the return value is zero. To get extended error information, call GetLastError. On systems that run
/// Windows XP or later, the function will always succeed and will thus never return zero.
/// </para>
/// </returns>
// BOOL WINAPI QueryPerformanceFrequency( _Out_ LARGE_INTEGER *lpFrequency);
// https://msdn.microsoft.com/en-us/library/windows/desktop/ms644905(v=vs.85).aspx
/// <remarks>For more info about this function and its usage, see Acquiring high-resolution time stamps.</remarks>
// https://docs.microsoft.com/en-us/windows/win32/api/profileapi/nf-profileapi-queryperformancefrequency BOOL
// QueryPerformanceFrequency( LARGE_INTEGER *lpFrequency );
[DllImport(Lib.Kernel32, SetLastError = true, ExactSpelling = true)]
[PInvokeData("Winbase.h", MSDNShortId = "ms644905")]
[PInvokeData("profileapi.h")]
[return: MarshalAs(UnmanagedType.Bool)]
public static extern bool QueryPerformanceFrequency(out long lpFrequency);
}

23
UnitTests/PInvoke/Kernel32/ProfileApiTests.cs Normal file
View File

@ -0,0 +1,23 @@
using NUnit.Framework;
using static Vanara.PInvoke.Kernel32;
namespace Vanara.PInvoke.Tests
{
[TestFixture]
public class ProfileApiTests
{
[Test]
public void QueryPerformanceCounterTest()
{
Assert.That(QueryPerformanceCounter(out var cnt), Is.True);
Assert.That(cnt, Is.GreaterThan(0));
}
[Test]
public void QueryPerformanceFrequencyTest()
{
Assert.That(QueryPerformanceFrequency(out var fr), Is.True);
Assert.That(fr, Is.GreaterThan(0));
}
}
}