Marshal Methods


.NET Framework Class Library
Marshal.StringToHGlobalAnsi Method

Copies the contents of a managed String into unmanaged memory, converting into ANSI format as it copies.

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

Syntax

Visual Basic (Declaration)
Public Shared Function StringToHGlobalAnsi ( _
    s As String _
) As IntPtr
Visual Basic (Usage)
Dim s As String
Dim returnValue As IntPtr

returnValue = Marshal.StringToHGlobalAnsi(s)
C#
public static IntPtr StringToHGlobalAnsi (
    string s
)
C++
public:
static IntPtr StringToHGlobalAnsi (
    String^ s
)
J#
public static IntPtr StringToHGlobalAnsi (
    String s
)
JScript
public static function StringToHGlobalAnsi (
    s : String
) : IntPtr

Parameters

s

A managed string to be copied.

Return Value

The address, in unmanaged memory, to where s was copied, or 0 if a null string was supplied.
Exceptions

Exception typeCondition

OutOfMemoryException

There is insufficient memory available.

ArgumentOutOfRangeException

The s parameter exceeds the maximum length allowed by the operating system.

Remarks

StringToHGlobalAnsi is useful for custom marshaling or when mixing managed and unmanaged code. Since this method allocates the unmanaged memory required for a string, always free the memory by calling FreeHGlobal. StringToHGlobalAnsi provides the opposite functionality of Marshal.PtrToStringAnsi.

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.

Example

The following code example demonstrates how to convert the contents of a managed String class to unmanaged memory and then dispose of the unmanaged memory when done.

.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