Marshal::StructureToPtr<T> Method (T, IntPtr, Boolean)
[Supported in the .NET Framework 4.5.1 and later versions]
Marshals data from a managed object of a specified type to an unmanaged block of memory.
Assemblies: System.Runtime.InteropServices (in System.Runtime.InteropServices.dll)
mscorlib (in mscorlib.dll)
public: generic<typename T> static void StructureToPtr( T structure, IntPtr ptr, bool fDeleteOld )
The type of the managed object.
A managed object that holds the data to be marshaled. The object must be a structure or an instance of a formatted class.
- Type: System::IntPtr
A pointer to an unmanaged block of memory, which must be allocated before this method is called.
structure is a reference type that is not a formatted class.
copies the contents of structure to the pre-allocated block of memory that the ptr parameter points to. If structure contains reference types that marshal to COM interface pointers (interfaces, classes without layout, and System::Object), the managed objects are kept alive with reference counts. All other reference types (for example, strings and arrays) are marshaled to copies. To release these managed or unmanaged objects, you must call the DestroyStructure<T>(IntPtr) method before you free the memory block.
If you use the method to copy a different instance to the memory block at a later time, specify true for fDeleteOld to remove reference counts for reference types in the previous instance. Otherwise, the managed reference types and unmanaged copies are effectively leaked.
The overall pattern for using is as follows:
On the first call to the StructureToPtr method after a memory block has been allocated, fDeleteOld must be false, because there are no contents to clear.
Specify true for fDeleteOld only if the block contains valid data.
If you copy a different instance to the memory block, and the object contains reference types, fDeleteOld must be true to free reference types in the old contents.
If the object contains reference types, you must call the DestroyStructure method before you free the memory block.
requires full trust for the immediate caller. This member cannot be used by partially trusted or transparent code.