Marshal::SecureStringToCoTaskMemUnicode Method (SecureString^)

.NET Framework (current version)

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

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

Syntax

C++

public:
[SecurityCriticalAttribute]
static IntPtr SecureStringToCoTaskMemUnicode(
	SecureString^ s
)

Parameters

s: Type: System.Security::SecureString^
The managed object to copy.

Return Value

Type: System::IntPtr

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

Exceptions

Exception	Condition
ArgumentNullException	The s parameter is null.
NotSupportedException	The current computer is not running Windows 2000 Service Pack 3 or later.
OutOfMemoryException	There is insufficient memory available.

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.

Notes to Callers:

This method is supported only on computers running Windows 2000 Service Pack 3 or later.

Examples

The following example uses the SecureStringToCoTaskMemUnicode method to marshal and decrypt the contents of a SecureString object to a block of unmanaged memory. It then uses the ZeroFreeCoTaskMemUnicode method to zero out and dispose the unmanaged block.

C++

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