This topic has not yet been rated - Rate this topic

Marshal.StringToCoTaskMemAuto Method

.NET Framework 2.0

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

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

public static IntPtr StringToCoTaskMemAuto (
	string s
)

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

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.

.NET Framework Security

SecurityPermission for permission to call unmanaged code. Associated enumeration: UnmanagedCode Security action: LinkDemand

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

Reference

Marshal Class
Marshal Members
System.Runtime.InteropServices Namespace
PtrToStringAuto

Did you find this helpful? Yes No

Not accurate

Not enough depth

Need more code examples

(1500 characters remaining)

Community Additions

ADD