Skip to content

Commit

Permalink
Updated project documentation for 3.0.1 release
Browse files Browse the repository at this point in the history
  • Loading branch information
dahall committed Sep 20, 2019
1 parent b309f90 commit 9ecdcee
Show file tree
Hide file tree
Showing 6 changed files with 153 additions and 94 deletions.
2 changes: 2 additions & 0 deletions PInvoke/Shared/AssemblyReport.md
Original file line number Diff line number Diff line change
Expand Up @@ -29,6 +29,7 @@ Enum | Description | Values
[Vanara.PInvoke.STGM](https://github.com/dahall/Vanara/search?l=C%23&q=STGM) | The STGM constants are flags that indicate conditions for creating and deleting the object and access modes for the object. The STGM constants are included in the IStorage, IStream, and IPropertySetStorage interfaces and in the StgCreateDocfile, StgCreateStorageEx, StgCreateDocfileOnILockBytes, StgOpenStorage, and StgOpenStorageEx functions. <para> These elements are often combined using an OR operator. They are interpreted in groups as listed in the following table. It is not valid to use more than one element from a single group. | STGM_DIRECT, STGM_FAILIFTHERE, STGM_READ, STGM_WRITE, STGM_READWRITE, STGM_SHARE_EXCLUSIVE, STGM_SHARE_DENY_WRITE, STGM_SHARE_DENY_READ, STGM_SHARE_DENY_NONE, STGM_CREATE, STGM_TRANSACTED, STGM_CONVERT, STGM_PRIORITY, STGM_NOSCRATCH, STGM_NOSNAPSHOT, STGM_DIRECT_SWMR, STGM_DELETEONRELEASE, STGM_SIMPLE
[Vanara.PInvoke.SystemColorIndex](https://github.com/dahall/Vanara/search?l=C%23&q=SystemColorIndex) | Color index used to get a system color from <c>GetSysColor</c>. | COLOR_SCROLLBAR, COLOR_BACKGROUND, COLOR_DESKTOP, COLOR_ACTIVECAPTION, COLOR_INACTIVECAPTION, COLOR_MENU, COLOR_WINDOW, COLOR_WINDOWFRAME, COLOR_MENUTEXT, COLOR_WINDOWTEXT, COLOR_CAPTIONTEXT, COLOR_ACTIVEBORDER, COLOR_INACTIVEBORDER, COLOR_APPWORKSPACE, COLOR_HIGHLIGHT, COLOR_HIGHLIGHTTEXT, COLOR_BTNFACE, COLOR_3DFACE, COLOR_BTNSHADOW, COLOR_3DSHADOW, COLOR_GRAYTEXT, COLOR_BTNTEXT, COLOR_INACTIVECAPTIONTEXT, COLOR_3DHILIGHT, COLOR_BTNHILIGHT, COLOR_BTNHIGHLIGHT, COLOR_3DHIGHLIGHT, COLOR_3DDKSHADOW, COLOR_3DLIGHT, COLOR_INFOTEXT, COLOR_INFOBK, COLOR_HOTLIGHT, COLOR_GRADIENTACTIVECAPTION, COLOR_GRADIENTINACTIVECAPTION, COLOR_MENUHILIGHT, COLOR_MENUBAR
[Vanara.PInvoke.SystemShutDownReason](https://github.com/dahall/Vanara/search?l=C%23&q=SystemShutDownReason) | Flags used in the ExitWindowsEx, InitiateShutdown and InitiateSystemShutdownEx functions. | SHTDN_REASON_MAJOR_OTHER, SHTDN_REASON_MINOR_OTHER, SHTDN_REASON_MAJOR_NONE, SHTDN_REASON_MINOR_MAINTENANCE, SHTDN_REASON_MINOR_INSTALLATION, SHTDN_REASON_MINOR_UPGRADE, SHTDN_REASON_MINOR_RECONFIG, SHTDN_REASON_MINOR_HUNG, SHTDN_REASON_MINOR_UNSTABLE, SHTDN_REASON_MINOR_DISK, SHTDN_REASON_MINOR_PROCESSOR, SHTDN_REASON_MINOR_NETWORKCARD, SHTDN_REASON_MINOR_POWER_SUPPLY, SHTDN_REASON_MINOR_CORDUNPLUGGED, SHTDN_REASON_MINOR_ENVIRONMENT, SHTDN_REASON_MINOR_HARDWARE_DRIVER, SHTDN_REASON_MINOR_OTHERDRIVER, SHTDN_REASON_MINOR_BLUESCREEN, SHTDN_REASON_MINOR_SERVICEPACK, SHTDN_REASON_MINOR_HOTFIX, SHTDN_REASON_MINOR_SECURITYFIX, SHTDN_REASON_MINOR_SECURITY, SHTDN_REASON_MINOR_NETWORK_CONNECTIVITY, SHTDN_REASON_MINOR_WMI, SHTDN_REASON_MINOR_SERVICEPACK_UNINSTALL, SHTDN_REASON_MINOR_HOTFIX_UNINSTALL, SHTDN_REASON_MINOR_SECURITYFIX_UNINSTALL, SHTDN_REASON_MINOR_MMC, SHTDN_REASON_MINOR_SYSTEMRESTORE, SHTDN_REASON_MINOR_TERMSRV, SHTDN_REASON_MINOR_DC_PROMOTION, SHTDN_REASON_MINOR_DC_DEMOTION, SHTDN_REASON_MINOR_NONE, SHTDN_REASON_UNKNOWN, SHTDN_REASON_MAJOR_HARDWARE, SHTDN_REASON_MAJOR_OPERATINGSYSTEM, SHTDN_REASON_MAJOR_SOFTWARE, SHTDN_REASON_MAJOR_APPLICATION, SHTDN_REASON_MAJOR_SYSTEM, SHTDN_REASON_MAJOR_POWER, SHTDN_REASON_MAJOR_LEGACY_API, SHTDN_REASON_FLAG_COMMENT_REQUIRED, SHTDN_REASON_FLAG_DIRTY_PROBLEM_ID_REQUIRED, SHTDN_REASON_FLAG_CLEAN_UI, SHTDN_REASON_FLAG_DIRTY_UI, SHTDN_REASON_FLAG_MOBILE_UI_RESERVED, SHTDN_REASON_FLAG_USER_DEFINED, SHTDN_REASON_FLAG_PLANNED, SHTDN_REASON_LEGACY_API
[Vanara.PInvoke.URLZONE](https://github.com/dahall/Vanara/search?l=C%23&q=URLZONE) | Contains all the predefined zones used by Windows Internet Explorer. | URLZONE_PREDEFINED_MIN, URLZONE_LOCAL_MACHINE, URLZONE_INTRANET, URLZONE_TRUSTED, URLZONE_INTERNET, URLZONE_UNTRUSTED, URLZONE_PREDEFINED_MAX, URLZONE_USER_MIN, URLZONE_USER_MAX, URLZONE_INVALID
[Vanara.PInvoke.WIN32_WINNT](https://github.com/dahall/Vanara/search?l=C%23&q=WIN32_WINNT) | _WIN32_WINNT version constants | _WIN32_WINNT_NT4, _WIN32_WINNT_WIN2K, _WIN32_WINNT_WINXP, _WIN32_WINNT_WS03, _WIN32_WINNT_WIN6, _WIN32_WINNT_VISTA, _WIN32_WINNT_WS08, _WIN32_WINNT_LONGHORN, _WIN32_WINNT_WIN7, _WIN32_WINNT_WIN8, _WIN32_WINNT_WINBLUE, _WIN32_WINNT_WINTHRESHOLD, _WIN32_WINNT_WIN10
### Structures
Struct | Description
Expand Down Expand Up @@ -147,5 +148,6 @@ Class | Description
[Vanara.PInvoke.FunctionHelper.SBFunc<T>](https://github.com/dahall/Vanara/search?l=C%23&q=SBFunc<T>) | Delegate that takes and StringBuilder and initial size and returns a result.
[Vanara.PInvoke.SECURITY_ATTRIBUTES](https://github.com/dahall/Vanara/search?l=C%23&q=SECURITY_ATTRIBUTES) | The SECURITY_ATTRIBUTES structure contains the security descriptor for an object and specifies whether the handle retrieved by specifying this structure is inheritable. This structure provides security settings for objects created by various functions, such as CreateFile, CreatePipe, CreateProcess, RegCreateKeyEx, or RegSaveKeyEx.
[Vanara.PInvoke.FunctionHelper.SizeFunc<T>](https://github.com/dahall/Vanara/search?l=C%23&q=SizeFunc<T>) | Gets a size and returns an error.
[Vanara.InteropServices.StringPtrArrayMarshaler](https://github.com/dahall/Vanara/search?l=C%23&q=StringPtrArrayMarshaler) | Marshals an array of strings to an array of pointers to strings with a NULL pointer at the end of the array.
[Vanara.PInvoke.StructHelper](https://github.com/dahall/Vanara/search?l=C%23&q=StructHelper) | Helper methods for structures.
[Vanara.Collections.IEnumFromNext<T>.TryGetNext](https://github.com/dahall/Vanara/search?l=C%23&q=TryGetNext) | Delegate that gets the next value in an enumeration and returns true or returns false to indicate there are no more items in the enumeration.
4 changes: 2 additions & 2 deletions PInvoke/Shared/Vanara.PInvoke.Shared.csproj
Original file line number Diff line number Diff line change
Expand Up @@ -32,13 +32,13 @@
<PackageReleaseNotes>Currently implements:

Classes
IErrorProvider, IGraphicsObjectHandle, IHandle, IKernelHandle, ISecurityObject, IShellHandle, ISyncHandle, IUserHandle, AssociateAttribute, ComTryGetNext, CoTaskMemStringMarshaler, FunctionHelper, IEnumFromCom&lt;T&gt;, IEnumFromIndexer&lt;T&gt;, IEnumFromNext&lt;T&gt;, Lib, Macros, NullTermStringArrayMarshaler, OverlappedAsync, OverlappedAsyncResult, PInvokeClientExtensions, PInvokeDataAttribute, PRECT, PtrFunc&lt;T&gt;, RegistryTypeExt, SafeElementArray&lt;T&gt;, SafeHANDLE, SafeNativeArray&lt;T&gt;, SafeNativeArrayBase&lt;T&gt;, SafeNativeLinkedList&lt;T&gt;, SafeResourceId, SBFunc&lt;T&gt;, SECURITY_ATTRIBUTES, SizeFunc&lt;T&gt;, StructHelper, TryGetNext
IErrorProvider, IGraphicsObjectHandle, IHandle, IKernelHandle, ISecurityObject, IShellHandle, ISyncHandle, IUserHandle, AssociateAttribute, ComTryGetNext, CoTaskMemStringMarshaler, FunctionHelper, IEnumFromCom&lt;T&gt;, IEnumFromIndexer&lt;T&gt;, IEnumFromNext&lt;T&gt;, Lib, Macros, NullTermStringArrayMarshaler, OverlappedAsync, OverlappedAsyncResult, PInvokeClientExtensions, PInvokeDataAttribute, PRECT, PtrFunc&lt;T&gt;, RegistryTypeExt, SafeElementArray&lt;T&gt;, SafeHANDLE, SafeNativeArray&lt;T&gt;, SafeNativeArrayBase&lt;T&gt;, SafeNativeLinkedList&lt;T&gt;, SafeResourceId, SBFunc&lt;T&gt;, SECURITY_ATTRIBUTES, SizeFunc&lt;T&gt;, StringPtrArrayMarshaler, StructHelper, TryGetNext

Structures
ACCESS_MASK, BusNumber, CLIPFORMAT, CM_FULL_RESOURCE_DESCRIPTOR, CM_PARTIAL_RESOURCE_DESCRIPTOR, CM_PARTIAL_RESOURCE_LIST, CM_RESOURCE_LIST, COLORREF, Connection, DevicePrivate, DeviceSpecificData, Dma, DmaV3, Generic, HACCEL, HANDLE, HBITMAP, HBRUSH, HCURSOR, HDC, HDESK, HDPA, HDROP, HDSA, HDWP, HENHMETAFILE, HFILE, HFONT, HGDIOBJ, HICON, HIMAGELIST, HINSTANCE, HKEY, HMENU, HMETAFILE, HMONITOR, HPALETTE, HPEN, HPROCESS, HPROPSHEET, HPROPSHEETPAGE, HRESULT, HRGN, HTASK, HTHEME, HTHREAD, HTHUMBNAIL, HTOKEN, HWINSTA, HWND, Interrupt, LCID, LOGFONT, Memory40, Memory48, Memory64, MessageInterruptRaw, MSG, NTStatus, OBJECT_TYPE_LIST, PACE, PACL, POINTS, PRECT, PSECURITY_DESCRIPTOR, PSID, RECT, ResourceId, SECURITY_ATTRIBUTES, SIZE, SYSTEMTIME, union, WIN32_FIND_DATA, Win32Error

Enumerations
CM_RESOURCE, CM_SHARE_DISPOSITION, CmResourceType, DrawTextFlags, FacilityCode, FacilityCode, FileFlagsAndAttributes, FontFamily, FontPitch, INTERFACE_TYPE, LogFontCharSet, LogFontClippingPrecision, LogFontOutputPrecision, LogFontOutputQuality, NTDDI, ObjectTypeListLevel, PInvokeClient, ProcessorArchitecture, REG_VALUE_TYPE, ResourceType, SECURITY_INFORMATION, SeverityLevel, SeverityLevel, ShowWindowCommand, STGM, SystemColorIndex, SystemShutDownReason, WIN32_WINNT
CM_RESOURCE, CM_SHARE_DISPOSITION, CmResourceType, DrawTextFlags, FacilityCode, FacilityCode, FileFlagsAndAttributes, FontFamily, FontPitch, INTERFACE_TYPE, LogFontCharSet, LogFontClippingPrecision, LogFontOutputPrecision, LogFontOutputQuality, NTDDI, ObjectTypeListLevel, PInvokeClient, ProcessorArchitecture, REG_VALUE_TYPE, ResourceType, SECURITY_INFORMATION, SeverityLevel, SeverityLevel, ShowWindowCommand, STGM, SystemColorIndex, SystemShutDownReason, URLZONE, WIN32_WINNT

</PackageReleaseNotes>
<LangVersion>latest</LangVersion>
Expand Down
2 changes: 1 addition & 1 deletion PInvoke/User32/CorrelationReport.md
Original file line number Diff line number Diff line change
Expand Up @@ -354,7 +354,7 @@ Native Method | Header | Managed Method
[LoadMenu](http://msdn2.microsoft.com/en-us/library/loadmenu.htm) | winuser.h | [Vanara.PInvoke.User32.LoadMenu](https://github.com/dahall/Vanara/search?l=C%23&q=LoadMenu)
[LoadMenuIndirect](http://msdn2.microsoft.com/en-us/library/loadmenuindirect.htm) | winuser.h | [Vanara.PInvoke.User32.LoadMenuIndirect](https://github.com/dahall/Vanara/search?l=C%23&q=LoadMenuIndirect)
[LoadString](http://msdn2.microsoft.com/en-us/library/ms647486) | WinUser.h | [Vanara.PInvoke.User32.LoadString](https://github.com/dahall/Vanara/search?l=C%23&q=LoadString)
[LockSetForegroundWindow](http://msdn2.microsoft.com/en-us/library/locksetforegroundwindow) | winuser.h | [Vanara.PInvoke.User32.LockSetForegroundWindow](https://github.com/dahall/Vanara/search?l=C%23&q=LockSetForegroundWindow)
[LockSetForegroundWindow](https://www.google.com/search?num=5&q=LockSetForegroundWindow+site%3Amicrosoft.com) | winuser.h | [Vanara.PInvoke.User32.LockSetForegroundWindow](https://github.com/dahall/Vanara/search?l=C%23&q=LockSetForegroundWindow)
[LockWindowUpdate](http://msdn2.microsoft.com/en-us/library/00ec40c7-8ab2-40db-a9bb-48e18d66bf1a) | winuser.h | [Vanara.PInvoke.User32.LockWindowUpdate](https://github.com/dahall/Vanara/search?l=C%23&q=LockWindowUpdate)
[LockWorkStation](https://www.google.com/search?num=5&q=LockWorkStation+site%3Amicrosoft.com) | Winuser.h | [Vanara.PInvoke.User32.LockWorkStation](https://github.com/dahall/Vanara/search?l=C%23&q=LockWorkStation)
[LogicalToPhysicalPoint](http://msdn2.microsoft.com/en-us/library/logicaltophysicalpoint) | winuser.h | [Vanara.PInvoke.User32.LogicalToPhysicalPoint](https://github.com/dahall/Vanara/search?l=C%23&q=LogicalToPhysicalPoint)
Expand Down
Loading

0 comments on commit 9ecdcee

Please sign in to comment.