Marshal::SecureStringToGlobalAllocAnsi Method (SecureString^)

 

Copies the contents of a managed SecureString into unmanaged memory, converting into ANSI format as it copies.

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

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

Parameters

s
Type: System.Security::SecureString^

The managed object to copy.

Return Value

Type: System::IntPtr

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

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 SecureStringToGlobalAllocAnsi 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 ZeroFreeGlobalAllocAnsi method.

Notes to Callers:

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

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

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

SecurityCriticalAttribute

requires full trust for the immediate caller. This member cannot be used by partially trusted or transparent code.

.NET Framework
Available since 2.0
Return to top
Show: