Go to file
David Hall a24c53e20f Added Sandcastle help project 2017-11-27 23:27:26 -07:00
Core Changed project files to version 1.0.2 and to have NuGet packages only build on Release 2017-11-27 20:30:54 -07:00
HelpBuilder Added Sandcastle help project 2017-11-27 23:27:26 -07:00
PInvoke Completed documentation 2017-11-27 22:42:02 -07:00
Security Changed project files to version 1.0.2 and to have NuGet packages only build on Release 2017-11-27 20:30:54 -07:00
System Changed project files to version 1.0.2 and to have NuGet packages only build on Release 2017-11-27 20:30:54 -07:00
UI Changed project files to version 1.0.2 and to have NuGet packages only build on Release 2017-11-27 20:30:54 -07:00
UnitTests Changed project files to version 1.0.2 and to have NuGet packages only build on Release 2017-11-27 20:30:54 -07:00
docs Set theme jekyll-theme-slate 2017-11-27 11:12:46 -07:00
.gitattributes Add initial files 2017-11-27 10:03:14 -07:00
.gitignore Changed project files to version 1.0.2 and to have NuGet packages only build on Release 2017-11-27 20:30:54 -07:00
LICENSE Add initial files 2017-11-27 10:03:14 -07:00
README.md Added project layout info 2017-11-27 23:07:30 -07:00
Vanara.sln Added Sandcastle help project 2017-11-27 23:27:26 -07:00

README.md

Vanara

Vanara

In a number of projects I have needed to use native API calls. Over the years I have collected quite a few of these interop code chunks and I decided to pull them all together into a set of reusable libraries. I have tried to carve up the libraries into small enough chunks that they are easy to identify and consume. The only problem with this is that you can literally end up with over 20 dependencies on some of the higher function libraries (oh well).

I have tried to follow the concepts below in laying out the libraries.

  • 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.dll hosts all functions and supporting enumerations, constants and structures that are exported from gdi32.dll in the system directory.)
  • Any structure or macro or enumeration (no function) that is used by many libraries is put into either Vanara.Core or Vanara.PInvoke.Shared
    • (e.g. The macro HIWORD and the structure SIZE are both in Vanara.PInvoke.Shared and classes to simplfy interop calls and native memory management are in Vanara.Core.)
  • 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 Kernel32 assembly, you'll find a FileApi.cs, a WinBase.cs and a WinNT.cs file representing fileapi.h, winbase.h and winnt.h respectively.)
  • Where the direct interpretation of a structure leads to memory leaks or misuse, I have tried to simplify their use
  • Where structures are always passed by reference and where that structure needs to clean up memory allocations, I have changed the structure to class implementing IDisposable.
  • Wherever possible, all handles have been turned into SafeHandle derivatives.
  • Wherever possible, all functions that allocate memory that is to be freed by the caller use a safe memory handle.

Installation

This project's assemblies are available via NuGet.

Link Assembly Description Dependencies
NuGet Vanara.Core Shared methods, structures and constants for use throughout the Vanara assemblies. Think of it as windows.h with some useful extensions. None
NuGet Vanara.PInvoke.Shared Shared methods, structures and constants for use throughout the Vanara.PInvoke assemblies Vanara.Core
NuGet Vanara.PInvoke.AclUI Methods, structures and constants imported from AclUI.dll Vanara.PInvoke.Security
NuGet Vanara.PInvoke.ComCtl32 Methods, structures and constants imported from ComCtl32.dll Vanara.PInvoke.User32
NuGet Vanara.PInvoke.CredUI Methods, structures and constants imported from CredUI.dll Vanara.PInvoke.Security
NuGet Vanara.PInvoke.DwmApi Methods, structures and constants imported from DwmApi.dll Vanara.PInvoke.Shared
NuGet Vanara.PInvoke.Gdi32 Methods, structures and constants imported from Gdi32.dll Vanara.PInvoke.Shared
NuGet Vanara.PInvoke.Kernel32 Methods, structures and constants imported from Kernel32.dll Vanara.PInvoke.Shared
NuGet Vanara.PInvoke.NetApi32 Methods, structures and constants imported from NetApi32.dll Vanara.PInvoke.Shared
NuGet Vanara.PInvoke.NetListMgr Methods, structures and constants imported from NetListMgr.dll Vanara.PInvoke.Shared
NuGet Vanara.PInvoke.NTDSApi Methods, structures and constants imported from NTDSApi.dll Vanara.PInvoke.Shared
NuGet Vanara.PInvoke.Ole Methods, structures and constants imported from Ole32.dll, OleAut32 and PropSys.dll Vanara.PInvoke.Shared
NuGet Vanara.PInvoke.Security Methods, structures and constants imported from AdvApi32.dll, Authz.dll and Secur32.dll Vanara.PInvoke.Shared
NuGet Vanara.PInvoke.ShlwApi Methods, structures and constants imported from ShlwApi.dll Vanara.PInvoke.Shared
NuGet Vanara.PInvoke.Shell32 Methods, structures and constants imported from Shell32.dll Vanara.PInvoke.ComCtl32, Vanara.PInvoke.Ole, Vanara.PInvoke.Security
NuGet Vanara.PInvoke.TaskSchd Methods, structures and constants imported from TaskSchd.dll Vanara.PInvoke.Shared
NuGet Vanara.PInvoke.User32 Methods, structures and constants imported from User32.dll Vanara.PInvoke.Gdi32, Vanara.PInvoke.Kernel32
NuGet Vanara.PInvoke.UxTheme Methods, structures and constants imported from UxTheme.dll Vanara.PInvoke.Gdi32
NuGet Vanara.PInvoke.VirtDisk Methods, structures and constants imported from VirtDisk.dll Vanara.PInvoke.Shared
NuGet Vanara.PInvoke.WinINet Methods, structures and constants imported from WinINet.dll Vanara.PInvoke.Shared
NuGet Vanara.Security Wrapper classes for security related items in the PInvoke libraries Vanara.PInvoke.NTDSApi, Vanara.PInvoke.Security
NuGet Vanara.SystemServices Wrapper classes for system related items in the PInvoke libraries Vanara.PInvoke.Kernel32, Vanara.PInvoke.VirtDisk
NuGet Vanara.UI Wrapper classes for user interface related items in the PInvoke libraries Vanara.PInvoke.AclUI, Vanara.PInvoke.CredUI, Vanara.PInvoke.ComCtl32, Vanara.PInvoke.DwmApi, Vanara.PInvoke.NetListMgr, Vanara.PInvoke.Shell32, Vanara.PInvoke.UxTheme

Sample Code

There are numerous examples in the UnitTest folder.