Platform Invoke Samples
This document contains the release information for the set of platform invoke samples. You will find the following sections below:<?xml:namespace prefix = o ns = "urn:schemas-microsoft-com:office:office" />
- Location of the Samples
- Building and Running the Samples
The platform invoke samples demonstrate how to call functions exported from an unmanaged library: how to declare different types, how to use available attributes to modify default behavior, how to use methods of the Marshal class when needed, and which aspects of garbage collection and threading could affect results.
Some of the samples use functions exported from Windows libraries and some use functions exported from a custom library. Here is the summary of the topics demonstrated and where are the sources located.
Renames a function for use in managed code.
Chooses how strings are marshaled; also affects the function name search criteria.
Indicates whether the name of the entry point in the unmanaged DLL should be modified to correspond to the CharSet value.
Calls functions with varargs or calls methods of exported classes.
Modifies functions that return HRESULTs.
Guarantees that the error code is saved after a function call.
Passes a string as an In parameter.
string as result
Returns a string from unmanaged code.
Passes a string as an In/Out parameter using StringBuilder.
string in structure ByVal
Passes a string in a structure and the structure is an In parameter.
string in structure ByRef (char*)
Passes a string in a structure and the structure is an In/Out parameter. Unmanaged side expects a pointer to character buffer. Size of the buffer is usually passed as another member of the structure.
string in structure ByRef (char)
Passes a string in a structure and the structure is an In/Out parameter. Unmanaged side expects embedded character buffer.
string in class ByVal (char*)
Passes a string in a class, which is always an In/Out parameter since it is a reference type. Unmanaged side expects a pointer to character buffer.
string in class ByVal (char)
Passes a string in a class, which is always an In/Out parameter since it is a reference type. Unmanaged side expects embedded character buffer.
array of strings ByVal
Passes an array of strings ByVal.
array of structures that contain strings ByVal
Passes an array of structures that contain strings ByVal.
Passes a structure as an In parameter.
Passes a structure as an In/Out parameter.
Copies a class with only integer members as an In/Out parameter like in managed case.
structure with nested structures (flattened)
Produces a class that represents a structure with nested structures on unmanaged side. Structure is flattened in one big structure on managed side.
structure with nested structures (not flattened)
Passes a structure with an embedded structure.
structure that contains pointer to another structure
Passes a structure that contains a pointer to another structure as a member.
array of structures that contain only integers ByVal
Passes an array of structures that contain only integers as the In parameter. Members of array can be changed.
array of structures that contain integers and strings ByRef
Passes an array of structures that contain integers and strings as the Out parameter. Calee allocates memory for the array.
unions with value types
Passes a union with value types (integer and double).
unions with mixed types
Passes a union with mixed types (integer and String).
array of integers ByVal
Passes an array of integers as an In parameter.
array of integers ByRef
Passes an array of integers as an In/Out parameter.
2D array of integers ByVal
Passing a matrix of integers as an In parameter.
Presents a case when HandleRef needs to be used to prevent garbage collection.
Passes a delegate to an unmanaged function that expects a function pointer.
Calls a function that has void* as a parameter.
Uses GCHandle to pass a managed object to unmanaged function that expects LPARAM.
Changes the default apartment settings when an unmanaged function calls CoInitialize.
Portions of the samples require .NET Framework and Visual C++ 6.0.
Note: The compiled DLL file is available for unmanaged portion of the sample in case you don’t have Visual Studio 6.0.
These samples are located in the Interop/pinvoke directory of the .NET Framework SDK samples directory.
These samples contain the following directory structure:
WinAPIs – platform invoke demonstrated with functions exported from Windows libraries
/CS – sources in C#
/VB – sources in VB.NET
Custom – platform invoke demonstrated with functions exported from custom library
/CS - sources in C#
/VB - sources in VB.NET
/LIB – custom library source
To run these samples, follow the instructions listed below.
1. (optional) Open the PinvokeLib.dsw file in the Custom/LIB directory with Visual Studio 6. Choose Build/Rebuild All from the menu to build library.
2. Go to the pinvoke directory and type nmake all at the prompt to build all samples.
3. Run any EXE file from a command line to see results of calls to unmanaged functions.