Export (0) Print
Expand All

Marshal.StringToHGlobalAnsi Method

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

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

static member StringToHGlobalAnsi : 
        s:string -> IntPtr

Parameters

s
Type: System.String

A managed string to be copied.

Return Value

Type: System.IntPtr
The address, in unmanaged memory, to where s was copied, or 0 if s is a null reference (Nothing in Visual Basic).

ExceptionCondition
OutOfMemoryException

There is insufficient memory available.

ArgumentOutOfRangeException

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

StringToHGlobalAnsi is useful for custom marshaling or when mixing managed and unmanaged code. Because 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.

This method copies embedded null characters, and includes a terminating null character.

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

No code example is currently available or this language may not be supported.

.NET Framework

Supported in: 4.6, 4.5, 4, 3.5, 3.0, 2.0, 1.1

.NET Framework Client Profile

Supported in: 4, 3.5 SP1

Portable Class Library

Supported in: Portable Class Library

Supported in: Windows Phone 8.1

  • SecurityCriticalAttribute 

    requires full trust for the immediate caller. This member cannot be used by partially trusted or transparent code.

Show:
© 2015 Microsoft