This project contains various .NET assemblies that contain P/Invoke functions, interfaces, enums and structures from Windows libraries. Each assembly is associated with one or a few tightly related libraries. For example, Shlwapi.dll has all the exported functions from shlwapi.lib; Kernel32.dll has all for both kernel32.lib and kernelbase.lib.
All assemblies are available via NuGet and provide builds against .NET 2.0, 3.5, 4.0, 4.5, Core 3.0, Core 3.1 and .NET 5.0 (new in v3.2.20) and support SourceLink. In all cases where a dependency doesn't disallow it, .NET Standard 2.0, .NET Core 2.0, and 2.1 builds are also included for use with UWP and other .NET Core and Standard projects.
This project releases new versions every few weeks after sufficient testing. New releases are cataloged, along with release notes, in the Releases section and all NuGet packages are published to nuget.org. Each GitHub push triggers an AppVeyor build. The owners thank them for the free Open-Source account! The status of that build is in the header of this page. The NuGet packages from those builds are available for test purposes on AppVeyor's project NuGet source at https://ci.appveyor.com/nuget/vanara-prerelease.
Use
- Look for the function you need in Microsoft documentation. Note which library or DLL the function is in.
- Confirm the Vanara library exists and has your function by looking at the Supported Libraries table below. Clicking on the Assembly link will take you to a drill down of that assembly's coverage. Find your function and if there is a matching implementation it will appear to the right. You can also use GitHub's project search (upper left of page) to search for your function, method or constant. Make sure to select "In this repository".
- Add the assembly to your project via NuGet.
- To use the function, you can:
- Call it directly
var bret = Vanara.PInvoke.Kernel32.GetComputerName(sb, ref sbSz); - Under C# 6.0 and later, use a static using directive and call it:
using static Vanara.PInvoke.Kernel32; var bret = GetComputerName(sb, ref sbSz); - Call it directly
- In some cases there is a corresponding helper/wrapper class in one of the Supporting Assemblies, especially for Security, System Services, Forms and Shell. Go to their library page (click on link in section) and look through the classes included in each library.
Design Concepts
- All functions that are imported from a single DLL should be placed into a single assembly that is named after the DLL.
- (e.g. The assembly
Vanara.PInvoke.Gdi32.dllhosts all functions and supporting enumerations, constants and structures that are exported fromgdi32.dllin the system directory.)
- (e.g. The assembly
- Any structure or macro or enumeration (no function) that is used by many libraries is put into either
Vanara.CoreorVanara.PInvoke.Shared.- (e.g. The macro
HIWORDand the structureSIZEare both inVanara.PInvoke.Sharedand classes to simplify interop calls and native memory management are inVanara.Core.)
- (e.g. The macro
- Inside a project, all constructs are contained in a file named after the header file (*.h) in which they are defined in the Windows API.
- (e.g. In the
Vanara.PInvoke.Kernel32project directory, you'll find a FileApi.cs, a WinBase.cs and a WinNT.cs file representing fileapi.h, winbase.h and winnt.h respectively.)
- (e.g. In the
- Where the direct interpretation of a structure or function leads to memory leaks or misuse, I have tried to simplify its use.
- Where a structure is always passed by reference and where that structure needs to clean up memory allocations, I have changed the structure to a class implementing
IDisposable. - Wherever possible, all handles have been turned into
SafeHandlederivatives named after the Windows API handle. If those handles require a call to a function to release/close/destroy, a derivedSafeHANDLEexists that performs that function on disposal.- e.g.
HTOKENis defined.SafeHTOKENbuilds upon that handle with an automated release callingCloseHandle.
- e.g.
- Wherever possible, all functions that allocate memory that is to be freed by the caller use a safe memory handle.
- All PInvoke calls are in assemblies prefixed by
Vanara.PInvoke. - If a structure is to passed into a function as a constant, that structure is marshaled using the
instatement which will pass the structure by reference without requiring therefkeyword.- Windows API:
BOOL MapDialogRect(HWND hDlg, LPRECT lpRect) - Vanara:
bool MapDialogRect(HWND hDlg, in RECT lpRect);
- Windows API:
- If there are classes or extensions that make use of the PInvoke calls, they are in wrapper assemblies prefixed by
Vanaraand then followed by a logical name for the functionality. Today, those are Core, Security, SystemServices, Windows.Forms and Windows.Shell.
Supported Libraries
Supporting Assemblies
| Assembly | NuGet Link | Description |
|---|---|---|
| Vanara.BITS |   |
.NET classes to access Background Intelligent Transfer Service (BITS) functionality. Intelligently uses most recent library functions and gracefully fails when new features are not available on older OS versions. |
| Vanara.Core |   |
This library includes shared methods, structures and constants for use throughout the Vanara assemblies. Think of it as windows.h with some useful extensions. It includes: * Extension methods for working with enumerated types (enum), FILETIME, and method and property extractions via reflection * Extension and helper methods to marshaling structures arrays and strings * SafeHandle based classes for working with memory allocated via CoTaskMem, HGlobal, or Local calls that handles packing and extracting arrays, structures and raw memory * Safe pinning of objects in memory * Memory stream based on marshaled memory |
| Vanara.PInvoke.Shared |   |
Shared methods, structures and constants for use throughout the Vanara.PInvoke assemblies. Includes: * IEnumerable helpers for COM enumerations * Custom marshaler for CoTaskMem pointers * Enhanced error results classes for HRESULT, Win32Error and NTStatus * Standard windows.h macros (e.g. HIWORD, MAKELONG, etc.) * Overlapped method wrapper * Resource ID holder * Shared structures and enums (see release notes) |
| Vanara.Security |   |
Classes for security related items derived from the Vanara PInvoke libraries. Includes extension methods for Active Directory and access control classes, methods for working with accounts, UAC, privileges, system access, impersonation and SIDs, and a full LSA wrapper. |
| Vanara.SystemServices |   |
Classes for system related items derived from the Vanara PInvoke libraries. Includes extensions for Process (privileges and elavation), FileInfo (compression info), Shared Network Drives and Devices, and ServiceController (SetStartType) that pull extended information through native API calls. |
| Vanara.VirtualDisk |   |
.NET classes to manage Windows Virtual Storage (VHD and VHDX) using P/Invoke functions from VirtDisk.dll. |
| Vanara.Windows.Forms |   |
Classes for user interface related items derived from the Vanara PInvoke libraries. Includes extensions for almost all common controls to give post Vista capabilities, WinForms controls (panel, commandlink, enhanced combo boxes, IPAddress, split button, trackbar and themed controls), shutdown/restart/lock control, buffered painting, resource files, access control editor, simplifed designer framework for Windows.Forms. |
| Vanara.Windows.Shell |   |
Classes for Windows Shell items derived from the Vanara PInvoke libraries. Includes shell items, files, icons, links, and taskbar lists. |
Quick Links
Sample Code
There are numerous examples in the UnitTest folder and in the WinClassicSamplesCS project that recreates the Windows Samples in C# using Vanara.