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

Fixed XML comment problems

pull/83/head
David Hall 2019-08-27 14:45:38 -06:00
parent d89a9df2a5
commit f9429f6dd9
12 changed files with 19 additions and 26 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

1
PInvoke/Gdi32/WinGdi.BITMAPINFO.cs
View File

@ -3,6 +3,7 @@ using System.Runtime.InteropServices;
namespace Vanara.PInvoke
{
/// <summary>Functions and types from Gdi32.dll.</summary>
public static partial class Gdi32
{
/// <summary>The type of compression for a compressed bottom-up bitmap (top-down DIBs cannot be compressed). Used in <see cref="BITMAPINFOHEADER"/>.</summary>

2
PInvoke/Gdi32/WinGdi.Region.cs
View File

@ -825,7 +825,7 @@ namespace Vanara.PInvoke
/// <summary>Initializes a new instance of the <see cref="RGNDATA"/> class.</summary>
/// <param name="bounds">A bounding rectangle for the region in logical units.</param>
/// <param name="count">The RECT structures that make up the region.</param>
/// <param name="rects">The RECT structures that make up the region.</param>
public RGNDATA(in RECT bounds, RECT[] rects)
{
rdh.dwSize = (uint)Marshal.SizeOf(typeof(RGNDATAHEADER));

2
PInvoke/Kernel32/JobApi.cs
View File

@ -1151,7 +1151,7 @@ namespace Vanara.PInvoke
[DllImport(Lib.Kernel32, SetLastError = true, ExactSpelling = true)]
[PInvokeData("jobapi2.h", MSDNShortId = "46f7c579-e8d3-4434-a6ce-56573cd84387")]
[return: MarshalAs(UnmanagedType.Bool)]
public static extern bool SetInformationJobObject([In] HJOB hJob, JOBOBJECTINFOCLASS JobObjectInfoClass, [In] IntPtr lpJobObjectInfo, uint cbJobObjectInfoLength);
public static extern bool SetInformationJobObject([In] HJOB hJob, JOBOBJECTINFOCLASS JobObjectInformationClass, [In] IntPtr lpJobObjectInformation, uint cbJobObjectInformationLength);
/// <summary>Sets limits for a job object.</summary>
/// <param name="hJob">

6
PInvoke/Kernel32/ProcessThreadsApi.cs
View File

@ -3068,7 +3068,7 @@ namespace Vanara.PInvoke
// GetThreadDescription( HANDLE hThread, PWSTR *ppszThreadDescription );
[DllImport(Lib.Kernel32, SetLastError = false, ExactSpelling = true)]
[PInvokeData("processthreadsapi.h", MSDNShortId = "9CFF0A2D-2196-4AE0-8F77-229A8AB7A3E8")]
public static extern HRESULT GetThreadDescription(HTHREAD hThread, [MarshalAs(UnmanagedType.CustomMarshaler, MarshalTypeRef = typeof(LocalStringMarshaler))] out string threadDescription);
public static extern HRESULT GetThreadDescription(HTHREAD hThread, [MarshalAs(UnmanagedType.CustomMarshaler, MarshalTypeRef = typeof(LocalStringMarshaler))] out string ppszThreadDescription);
/// <summary>Retrieves the thread identifier of the specified thread.</summary>
/// <param name="Thread">
@ -5608,7 +5608,7 @@ namespace Vanara.PInvoke
}
/// <summary>Initializes a new instance of the <see cref="PROC_THREAD_ATTRIBUTE"/> struct.</summary>
/// <param name="Number">The attribute type.</param>
/// <param name="type">The attribute type.</param>
/// <param name="Thread">if set to <c>true</c> this is thread specific.</param>
/// <param name="Input">if set to <c>true</c> this is an input attribute.</param>
/// <param name="Additive">if set to <c>true</c> this is additive.</param>
@ -7092,7 +7092,7 @@ namespace Vanara.PInvoke
}
}
/// <summary>Provides a <see cref="SafeHandle"/> for <see cref="ProcThreadAttributeList"/> that is disposed using <see cref="DeleteProcThreadAttributeList"/>.</summary>
/// <summary>Provides a <see cref="SafeHandle"/> for a list of <see cref="PROC_THREAD_ATTRIBUTE"/> structures that is disposed using <see cref="DeleteProcThreadAttributeList"/>.</summary>
public class SafeProcThreadAttributeList : SafeHANDLE
{
private List<(PROC_THREAD_ATTRIBUTE attr, object obj, PinnedObject ptr)> values = new List<(PROC_THREAD_ATTRIBUTE attr, object obj, PinnedObject ptr)>();

12
PInvoke/Kernel32/PsApi.cs
View File

@ -31,7 +31,7 @@ namespace Vanara.PInvoke
[return: MarshalAs(UnmanagedType.Bool)]
public delegate bool EnumPageFilesProc(IntPtr pContext, in ENUM_PAGE_FILE_INFORMATION pPageFileInfo, string lpFilename);
/// <summary>Used by <see cref="EnumProcessModulesEx"/>.</summary>
/// <summary>Used by <see cref="EnumProcessModulesEx(HPROCESS, LIST_MODULES)"/>.</summary>
[PInvokeData("psapi.h", MSDNShortId = "0f982f32-31f4-47b6-85d2-d6e17aa4eeb9")]
public enum LIST_MODULES
{
@ -185,7 +185,6 @@ namespace Vanara.PInvoke
public static extern bool EnumPageFiles(EnumPageFilesProc pCallBackRoutine, IntPtr pContext);
/// <summary>Enumerates the pagefiles in the system.</summary>
/// <param name="pContext">The user-defined data passed to the callback routine.</param>
/// <returns>A list of ENUM_PAGE_FILE_INFORMATION structures with the associated filename.</returns>
[PInvokeData("psapi.h", MSDNShortId = "9289fe3c-a7d9-4acb-aeb6-a50de65db0a2")]
public static IEnumerable<(ENUM_PAGE_FILE_INFORMATION pageInfo, string filename)> EnumPageFiles()
@ -1359,20 +1358,17 @@ namespace Vanara.PInvoke
/// <summary>
/// Retrieves extended information about the pages at specific virtual addresses in the address space of the specified process.
/// </summary>
/// <param name="hProcess">
/// A handle to the process. The handle must have the <c>PROCESS_QUERY_INFORMATION</c> and <c>PROCESS_VM_READ</c> access rights. For
/// more information, see Process Security and Access Rights.
/// </param>
/// <param name="hProcess">A handle to the process. The handle must have the <c>PROCESS_QUERY_INFORMATION</c> and <c>PROCESS_VM_READ</c> access rights. For
/// more information, see Process Security and Access Rights.</param>
/// <param name="virtualAddresses">The virtual addresses.</param>
/// <returns>
/// An array of PSAPI_WORKING_SET_EX_INFORMATION structures. On input, each item in the array specifies a virtual address of
/// interest. On output, each item in the array receives information about the corresponding virtual page.
/// </returns>
/// <remarks>
/// <para>
/// Unlike the QueryWorkingSet function, which is limited to the working set of the target process, the <c>QueryWorkingSetEx</c>
/// function can be used to query addresses that are not in the process working set but are still part of the process, such as AWE
/// and large pages.
/// </para>
/// </remarks>
[PInvokeData("psapi.h", MSDNShortId = "59ae76c9-e954-4648-9c9f-787136375b02")]
public static PSAPI_WORKING_SET_EX_INFORMATION[] QueryWorkingSetEx(HPROCESS hProcess, [Optional] params IntPtr[] virtualAddresses)

2
PInvoke/Kernel32/RealtimeApiSet.cs
View File

@ -379,7 +379,7 @@ namespace Vanara.PInvoke
[DllImport(Lib.KernelBase, SetLastError = false, ExactSpelling = true)]
[PInvokeData("realtimeapiset.h", MSDNShortId = "f9cf5440-9be9-4ff9-b85c-2779b847954c")]
[return: MarshalAs(UnmanagedType.Bool)]
public static extern bool QueryUnbiasedInterruptTime(out ulong lpUnbiasedInterruptTime);
public static extern bool QueryUnbiasedInterruptTime(out ulong UnbiasedTime);
/// <summary>
/// Gets the current unbiased interrupt-time count, in a more precise form than QueryUnbiasedInterruptTime does. The unbiased

4
PInvoke/Kernel32/RtlSupportApi.cs
View File

@ -244,7 +244,7 @@ namespace Vanara.PInvoke
// TargetIp, PEXCEPTION_RECORD ExceptionRecord, PVOID ReturnValue, PCONTEXT ContextRecord, PUNWIND_HISTORY_TABLE HistoryTable );
[DllImport(Lib.Kernel32, SetLastError = false, ExactSpelling = true)]
[PInvokeData("rtlsupportapi.h", MSDNShortId = "3d2d8778-311e-4cc1-b280-4f83ab457755")]
public static extern void RtlUnwindEx([In, Optional] IntPtr TargetFrame, [In, Optional] IntPtr TargetIp, in EXCEPTION_RECORD ExceptionRecord, IntPtr ReturnValue, in CONTEXT OriginalContext, in UNWIND_HISTORY_TABLE HistoryTable);
public static extern void RtlUnwindEx([In, Optional] IntPtr TargetFrame, [In, Optional] IntPtr TargetIp, in EXCEPTION_RECORD ExceptionRecord, IntPtr ReturnValue, in CONTEXT ContextRecord, in UNWIND_HISTORY_TABLE HistoryTable);
/// <summary>Initiates an unwind of procedure call frames.</summary>
/// <param name="TargetFrame">
@ -263,7 +263,7 @@ namespace Vanara.PInvoke
// TargetIp, PEXCEPTION_RECORD ExceptionRecord, PVOID ReturnValue, PCONTEXT ContextRecord, PUNWIND_HISTORY_TABLE HistoryTable );
[DllImport(Lib.Kernel32, SetLastError = false, ExactSpelling = true)]
[PInvokeData("rtlsupportapi.h", MSDNShortId = "3d2d8778-311e-4cc1-b280-4f83ab457755")]
public static extern void RtlUnwindEx([In, Optional] IntPtr TargetFrame, [In, Optional] IntPtr TargetIp, [In, Optional] IntPtr ExceptionRecord, IntPtr ReturnValue, in CONTEXT OriginalContext, [In, Optional] IntPtr HistoryTable);
public static extern void RtlUnwindEx([In, Optional] IntPtr TargetFrame, [In, Optional] IntPtr TargetIp, [In, Optional] IntPtr ExceptionRecord, IntPtr ReturnValue, in CONTEXT ContextRecord, [In, Optional] IntPtr HistoryTable);
/*
public static extern void RtlCaptureStackBackTrace();

2
PInvoke/Kernel32/ThreadPoolLegacyApiSet.cs
View File

@ -652,7 +652,7 @@ namespace Vanara.PInvoke
/// parameter can be <see langword="null"/>.
/// </para>
/// <para>
/// If this parameter is <see cref="SafeEventHandle.Invalid"/>, the function waits for all callback functions to complete before returning.
/// If this parameter is <see cref="SafeEventHandle.InvalidHandle"/>, the function waits for all callback functions to complete before returning.
/// </para>
/// <para>
/// If this parameter is <see langword="null"/>, the function marks the timer for deletion and returns immediately. However, most

4
PInvoke/Kernel32/TimeZoneApi.cs
View File

@ -319,7 +319,7 @@ namespace Vanara.PInvoke
[DllImport(Lib.Kernel32, SetLastError = true, ExactSpelling = true)]
[PInvokeData("timezoneapi.h", MSDNShortId = "f3a87ec2-67a0-418f-af6e-6c0b5547cffb")]
[return: MarshalAs(UnmanagedType.Bool)]
public static extern bool SystemTimeToTzSpecificLocalTime(in TIME_ZONE_INFORMATION lpTimeZone, in SYSTEMTIME lpUniversalTime, [Out] out SYSTEMTIME lpLocalTime);
public static extern bool SystemTimeToTzSpecificLocalTime(in TIME_ZONE_INFORMATION lpTimeZoneInformation, in SYSTEMTIME lpUniversalTime, [Out] out SYSTEMTIME lpLocalTime);
/// <summary>Converts a time in Coordinated Universal Time (UTC) to a specified time zone's corresponding local time.</summary>
/// <param name="lpTimeZoneInformation">
@ -361,7 +361,7 @@ namespace Vanara.PInvoke
[DllImport(Lib.Kernel32, SetLastError = true, ExactSpelling = true)]
[PInvokeData("timezoneapi.h", MSDNShortId = "f3a87ec2-67a0-418f-af6e-6c0b5547cffb")]
[return: MarshalAs(UnmanagedType.Bool)]
public static extern bool SystemTimeToTzSpecificLocalTime([Optional] IntPtr lpTimeZone, in SYSTEMTIME lpUniversalTime, [Out] out SYSTEMTIME lpLocalTime);
public static extern bool SystemTimeToTzSpecificLocalTime([Optional] IntPtr lpTimeZoneInformation, in SYSTEMTIME lpUniversalTime, [Out] out SYSTEMTIME lpLocalTime);
/// <summary>
/// Converts a time in Coordinated Universal Time (UTC) with dynamic daylight saving time settings to a specified time zone's

2
PInvoke/Kernel32/WinBase.App.cs
View File

@ -1397,7 +1397,7 @@ namespace Vanara.PInvoke
/// </summary>
public COMPATIBILITY_CONTEXT_ELEMENT[] Elements;
/// <summary>Initializes a new instance of the <see cref="ACTIVATION_CONTEXT_COMPATIBILITY_INFORMATION_MGD"/> struct.</summary>
/// <summary>Initializes a new instance of the <see cref="ACTIVATION_CONTEXT_COMPATIBILITY_INFORMATION"/> struct.</summary>
/// <param name="mem">The unmanaged pointer to this info.</param>
internal ACTIVATION_CONTEXT_COMPATIBILITY_INFORMATION(IntPtr mem)
{

4
PInvoke/Kernel32/WinCon.cs
View File

@ -1069,7 +1069,7 @@ namespace Vanara.PInvoke
// LPDWORD lpMode );
[DllImport(Lib.Kernel32, SetLastError = true, ExactSpelling = true)]
[PInvokeData("ConsoleApi.h", MSDNShortId = "49adf618-196d-4490-93ca-cd177807f58e")]
public static extern bool GetConsoleMode(HFILE hConsoleInputBuffer, out CONSOLE_INPUT_MODE lpMode);
public static extern bool GetConsoleMode(HFILE hConsoleHandle, out CONSOLE_INPUT_MODE lpMode);
/// <summary>Retrieves the current input mode of a console's input buffer or the current output mode of a console screen buffer.</summary>
/// <param name="hConsoleHandle">
@ -1249,7 +1249,7 @@ namespace Vanara.PInvoke
// LPDWORD lpMode );
[DllImport(Lib.Kernel32, SetLastError = true, ExactSpelling = true)]
[PInvokeData("ConsoleApi.h", MSDNShortId = "49adf618-196d-4490-93ca-cd177807f58e")]
public static extern bool GetConsoleMode(HFILE hConsoleInputBuffer, out CONSOLE_OUTPUT_MODE lpMode);
public static extern bool GetConsoleMode(HFILE hConsoleHandle, out CONSOLE_OUTPUT_MODE lpMode);
/// <summary>Retrieves the original title for the current console window.</summary>
/// <param name="lpConsoleTitle">

4
PInvoke/Kernel32/WinNls.cs
View File

@ -3744,10 +3744,6 @@ namespace Vanara.PInvoke
/// </list>
/// </para>
/// </param>
/// <param name="lParam">
/// Application-defined value to pass to the callback function. This parameter can be used in error checking. It can also be used to
/// ensure thread safety in the callback function.
/// </param>
/// <returns>List of the language groups.</returns>
public static IEnumerable<(LGRPID LanguageGroup, string lpLanguageGroupString, string lpLanguageGroupNameString, LGRPID_FLAGS dwFlags)> EnumSystemLanguageGroups(LGRPID_FLAGS dwFlags = 0)
{