This documentation is archived and is not being maintained.

SafeBuffer Class

Provides a controlled memory buffer that can be used for reading and writing. Attempts to access memory outside the controlled buffer (underruns and overruns) raise exceptions.

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

public abstract class SafeBuffer : SafeHandleZeroOrMinusOneIsInvalid

The SafeBuffer type exposes the following members.

Protected methodSafeBufferCreates a new instance of the SafeBuffer class, and specifies whether the buffer handle is to be reliably released.

Public propertyByteLengthGets the size of the buffer, in bytes.
Public propertyIsClosedGets a value indicating whether the handle is closed. (Inherited from SafeHandle.)
Public propertyIsInvalidGets a value that indicates whether the handle is invalid. (Inherited from SafeHandleZeroOrMinusOneIsInvalid.)

Public methodAcquirePointerObtains a pointer from a SafeBuffer object for a block of memory.
Public methodCloseMarks the handle for releasing and freeing resources. (Inherited from SafeHandle.)
Public methodDangerousAddRefManually increments the reference counter on SafeHandle instances. (Inherited from SafeHandle.)
Public methodDangerousGetHandleReturns the value of the handle field. (Inherited from SafeHandle.)
Public methodDangerousReleaseManually decrements the reference counter on a SafeHandle instance. (Inherited from SafeHandle.)
Public methodDispose()Releases all resources used by the SafeHandle class. (Inherited from SafeHandle.)
Protected methodDispose(Boolean)Releases the unmanaged resources used by the SafeHandle class specifying whether to perform a normal dispose operation. (Inherited from SafeHandle.)
Public methodEquals(Object)Determines whether the specified Object is equal to the current Object. (Inherited from Object.)
Protected methodFinalizeFrees all resources associated with the handle. (Inherited from SafeHandle.)
Public methodGetHashCodeServes as a hash function for a particular type. (Inherited from Object.)
Public methodGetTypeGets the Type of the current instance. (Inherited from Object.)
Public methodInitialize(UInt64)Defines the allocation size of the memory region in bytes. You must call this method before you use the SafeBuffer instance.
Public methodInitialize(UInt32, UInt32)Specifies the allocation size of the memory buffer by using the specified number of elements and element size. You must call this method before you use the SafeBuffer instance.
Public methodInitialize<T>(UInt32)Defines the allocation size of the memory region by specifying the number of value types. You must call this method before you use the SafeBuffer instance.
Protected methodMemberwiseCloneCreates a shallow copy of the current Object. (Inherited from Object.)
Public methodRead<T>Reads a value type from memory at the specified offset.
Public methodReadArray<T>Reads the specified number of value types from memory starting at the offset, and writes them into an array starting at the index.
Protected methodReleaseHandleWhen overridden in a derived class, executes the code required to free the handle. (Inherited from SafeHandle.)
Public methodReleasePointerReleases a pointer that was obtained by the AcquirePointer method.
Protected methodSetHandleSets the handle to the specified pre-existing handle. (Inherited from SafeHandle.)
Public methodSetHandleAsInvalidMarks a handle as no longer used. (Inherited from SafeHandle.)
Public methodToStringReturns a string that represents the current object. (Inherited from Object.)
Public methodWrite<T>Writes a value type to memory at the given location.
Public methodWriteArray<T>Writes the specified number of value types to a memory location by reading bytes starting from the specified location in the input array.

Protected fieldhandleSpecifies the handle to be wrapped. (Inherited from SafeHandle.)

You must call the SafeBuffer.Initialize method before you use any instance of SafeBuffer. To avoid races when you store an instance of a SafeBuffer object in a static variable, you should use one of the following approaches:

  • Create a lock when publishing the SafeBuffer.

  • Create a local variable, initialize the SafeBuffer, and then assign the SafeBuffer to the static variable, for example, by using the Interlocked.CompareExchange method.


Assignments in a static class constructor are implicitly locked.

.NET Framework

Supported in: 4

.NET Framework Client Profile

Supported in: 4

  • SecurityCriticalAttribute 

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

Windows 7, Windows Vista SP1 or later, Windows XP SP3, Windows Server 2008 (Server Core not supported), Windows Server 2008 R2 (Server Core supported with SP1 or later), Windows Server 2003 SP2

The .NET Framework does not support all versions of every platform. For a list of the supported versions, see .NET Framework System Requirements.

Any public static (Shared in Visual Basic) members of this type are thread safe. Any instance members are not guaranteed to be thread safe.