This documentation is archived and is not being maintained.

Marshal.StringToCoTaskMemAuto Method

Copies the contents of a managed String to a block of memory allocated from the unmanaged COM task allocator.

[Visual Basic]
Public Shared Function StringToCoTaskMemAuto( _
   ByVal s As String _
) As IntPtr
[C#]
public static IntPtr StringToCoTaskMemAuto(
 string s
);
[C++]
public: static IntPtr StringToCoTaskMemAuto(
 String* s
);
[JScript]
public static function StringToCoTaskMemAuto(
   s : String
) : IntPtr;

Parameters

s
A managed string to be copied.

Return Value

The allocated memory block, or 0 if a null reference (Nothing in Visual Basic) string was supplied.

Exceptions

Exception Type Condition
OutOfMemoryException There is insufficient memory available.

Remarks

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

The characters of the string are copied as either ANSI or Unicode characters, depending on the operating system where the code is executing. On Windows 98, the characters are copied as ANSI characters. On Windows NT 4.0, Windows 2000, Windows XP, and the Windows Server 2003 family, the characters are copied as Unicode characters.

Note   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.

Requirements

Platforms: Windows 98, Windows NT 4.0, Windows Millennium Edition, Windows 2000, Windows XP Home Edition, Windows XP Professional, Windows Server 2003 family

.NET Framework Security: 

See Also

Marshal Class | Marshal Members | System.Runtime.InteropServices Namespace | PtrToStringAuto

Show: