SecureStringMarshal.SecureStringToGlobalAllocAnsi(SecureString) Method

Definition

Namespace:

System.Security

Assembly:

System.Runtime.InteropServices.dll

Source:

SecureStringMarshal.cs

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

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

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

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

Public Shared Function SecureStringToGlobalAllocAnsi (s As SecureString) As IntPtr

Parameters

s

SecureString

The managed object to copy.

Returns

IntPtr

nativeint

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

Exceptions

ArgumentNullException

The s parameter is null.

OutOfMemoryException

There is insufficient memory available.

Remarks

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.