SecureStringMarshal.SecureStringToCoTaskMemUnicode(SecureString) Method

Definition

Namespace:

System.Security

Assembly:

System.Runtime.InteropServices.dll

Source:

SecureStringMarshal.cs

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

public:
 static IntPtr SecureStringToCoTaskMemUnicode(System::Security::SecureString ^ s);

public static IntPtr SecureStringToCoTaskMemUnicode (System.Security.SecureString s);

static member SecureStringToCoTaskMemUnicode : System.Security.SecureString -> nativeint

Public Shared Function SecureStringToCoTaskMemUnicode (s As SecureString) As IntPtr

Parameters

s

SecureString

The managed object to copy.

Returns

IntPtr

nativeint

The address, in unmanaged memory, where the s parameter was copied to, or 0 if a null object was supplied.

Exceptions

ArgumentNullException

The s parameter is null.

OutOfMemoryException

There is insufficient memory available.

Remarks

The SecureStringToCoTaskMemUnicode method 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 the ZeroFreeCoTaskMemUnicode method. The characters of the string are copied as Unicode characters.