Marshal Methods


.NET Framework Class Library
Marshal.DestroyStructure Method

Frees all substructures pointed to by the specified unmanaged memory block.

Namespace: System.Runtime.InteropServices
Assembly: mscorlib (in mscorlib.dll)

Syntax

Visual Basic (Declaration)
<ComVisibleAttribute(True)> _
Public Shared Sub DestroyStructure ( _
    ptr As IntPtr, _
    structuretype As Type _
)
Visual Basic (Usage)
Dim ptr As IntPtr
Dim structuretype As Type

Marshal.DestroyStructure(ptr, structuretype)
C#
[ComVisibleAttribute(true)] 
public static void DestroyStructure (
    IntPtr ptr,
    Type structuretype
)
C++
[ComVisibleAttribute(true)] 
public:
static void DestroyStructure (
    IntPtr ptr, 
    Type^ structuretype
)
J#
/** @attribute ComVisibleAttribute(true) */ 
public static void DestroyStructure (
    IntPtr ptr, 
    Type structuretype
)
JScript
ComVisibleAttribute(true) 
public static function DestroyStructure (
    ptr : IntPtr, 
    structuretype : Type
)

Parameters

ptr

A pointer to an unmanaged block of memory.

structuretype

Type of a formatted class. This provides the layout information necessary to delete the buffer in the ptr parameter.

Exceptions

Exception typeCondition

ArgumentException

structureType has an automatic layout. Use sequential or explicit instead.

Remarks

You can use this method to free reference-type fields, such as strings, of an unmanaged structure. Unlike its fields, a structure can be a value type or reference type. Value-type structures containing value-type fields (all blittable) have no references whose memory must be freed. StructureToPtr uses this method to prevent memory leaks when reusing memory occupied by a structure.

DestroyStructure calls the SysFreeString COM API method, which in turn frees an allocated string. For additional information about SysFreeString, see the MSDN Library.

In addition to DestroyStructure, the Marshal class provides two other memory-deallocation methods: Marshal.FreeCoTaskMem and Marshal.FreeHGlobal.

NoteNote

This method uses SecurityAction.LinkDemand to prevent it from being called from untrusted code; only the immediate caller is required to have SecurityPermissionAttribute.UnmanagedCode permission. If your code can be called from partially trusted code, do not pass user input to Marshal class methods without validation. For important limitations on using the LinkDemand member, see Demand vs. LinkDemand.

.NET Framework Security

Platforms

Windows 98, Windows 2000 SP4, Windows Millennium Edition, Windows Server 2003, Windows XP Media Center Edition, Windows XP Professional x64 Edition, Windows XP SP2, Windows XP Starter Edition

The .NET Framework does not support all versions of every platform. For a list of the supported versions, see System Requirements.

Version Information

.NET Framework

Supported in: 2.0, 1.1, 1.0
See Also

Tags :


Page view tracker