Marshal.StringToCoTaskMemUni(String) Method
Definition
Important
Some information relates to prerelease product that may be substantially modified before it’s released. Microsoft makes no warranties, express or implied, with respect to the information provided here.
Copies the contents of a managed String to a block of memory allocated from the unmanaged COM task allocator.
public:
static IntPtr StringToCoTaskMemUni(System::String ^ s);[System.Security.SecurityCritical]
public static IntPtr StringToCoTaskMemUni(string s);public static IntPtr StringToCoTaskMemUni(string? s);public static IntPtr StringToCoTaskMemUni(string s);[<System.Security.SecurityCritical>]
static member StringToCoTaskMemUni : string -> nativeintstatic member StringToCoTaskMemUni : string -> nativeintPublic Shared Function StringToCoTaskMemUni (s As String) As IntPtrParameters
- s
- String
A managed string to be copied.
Returns
nativeint
An integer representing a pointer to the block of memory allocated for the string, or 0 if s is null.
- Attributes
Exceptions
The s parameter exceeds the maximum length allowed by the operating system.
There is insufficient memory available.
Remarks
StringToCoTaskMemUni is useful for custom marshaling or for use when mixing managed and unmanaged code. Because this method allocates the unmanaged memory required for a string, always free the memory by calling Marshal.FreeCoTaskMem. This method provides the opposite functionality of Marshal.PtrToStringUni. The characters of the string are copied as Unicode characters.
This API reflects the Windows definition of Unicode, which is a UTF-16 2-byte encoding. On many non-Windows platforms, the wchar_t data-type is 4-bytes, not 2-bytes. Consult your compiler to confirm if wchar_t can be used or char16_t should be used instead.
