Was this page helpful?
Your feedback about this content is important. Let us know what you think.
Additional feedback?
1500 characters remaining
MSDN Library

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
Assemblies:   mscorlib (in mscorlib.dll)
  System.Runtime.InteropServices (in System.Runtime.InteropServices.dll)

public abstract class SafeBuffer : SafeHandleZeroOrMinusOneIsInvalid

The SafeBuffer type exposes the following members.

  NameDescription
Protected methodSupported by Portable Class LibrarySafeBufferCreates a new instance of the SafeBuffer class, and specifies whether the buffer handle is to be reliably released.
Top

  NameDescription
Public propertySupported by Portable Class LibraryByteLengthGets the size of the buffer, in bytes.
Public propertySupported by Portable Class LibraryIsClosedGets 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.)
Top

  NameDescription
Public methodSupported by Portable Class LibraryAcquirePointerObtains a pointer from a SafeBuffer object for a block of memory.
Public methodCloseMarks the handle for releasing and freeing resources. (Inherited from SafeHandle.)
Public methodSupported by Portable Class LibraryDangerousAddRefManually increments the reference counter on SafeHandle instances. (Inherited from SafeHandle.)
Public methodSupported by Portable Class LibraryDangerousGetHandleReturns the value of the handle field. (Inherited from SafeHandle.)
Public methodSupported by Portable Class LibraryDangerousReleaseManually decrements the reference counter on a SafeHandle instance. (Inherited from SafeHandle.)
Public methodSupported by Portable Class LibraryDispose()Releases all resources used by the SafeHandle class. (Inherited from SafeHandle.)
Protected methodSupported by Portable Class LibraryDispose(Boolean)Releases the unmanaged resources used by the SafeHandle class specifying whether to perform a normal dispose operation. (Inherited from SafeHandle.)
Public methodSupported by Portable Class LibraryEquals(Object)Determines whether the specified object is equal to the current object. (Inherited from Object.)
Protected methodSupported by Portable Class LibraryFinalizeFrees all resources associated with the handle. (Inherited from SafeHandle.)
Public methodSupported by Portable Class LibraryGetHashCodeServes as the default hash function. (Inherited from Object.)
Public methodSupported by Portable Class LibraryGetTypeGets the Type of the current instance. (Inherited from Object.)
Public methodSupported by Portable Class LibraryInitialize(UInt64)Defines the allocation size of the memory region in bytes. You must call this method before you use the SafeBuffer instance.
Public methodSupported by Portable Class LibraryInitialize(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 methodSupported by Portable Class LibraryInitialize<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 methodSupported by Portable Class LibraryMemberwiseCloneCreates a shallow copy of the current Object. (Inherited from Object.)
Public methodSupported by Portable Class LibraryRead<T>Reads a value type from memory at the specified offset.
Public methodSupported by Portable Class LibraryReadArray<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 methodSupported by Portable Class LibraryReleaseHandleWhen overridden in a derived class, executes the code required to free the handle. (Inherited from SafeHandle.)
Public methodSupported by Portable Class LibraryReleasePointerReleases a pointer that was obtained by the AcquirePointer method.
Protected methodSupported by Portable Class LibrarySetHandleSets the handle to the specified pre-existing handle. (Inherited from SafeHandle.)
Public methodSupported by Portable Class LibrarySetHandleAsInvalidMarks a handle as no longer used. (Inherited from SafeHandle.)
Public methodSupported by Portable Class LibraryToStringReturns a string that represents the current object. (Inherited from Object.)
Public methodSupported by Portable Class LibraryWrite<T>Writes a value type to memory at the given location.
Public methodSupported by Portable Class LibraryWriteArray<T>Writes the specified number of value types to a memory location by reading bytes starting from the specified location in the input array.
Top

  NameDescription
Protected fieldSupported by Portable Class LibraryhandleSpecifies the handle to be wrapped. (Inherited from SafeHandle.)
Top

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.

NoteNote

Assignments in a static class constructor are implicitly locked.

.NET Framework

Supported in: 4.6, 4.5, 4

.NET Framework Client Profile

Supported in: 4

.NET for Windows Phone apps

Obsolete (compiler warning) in Windows Phone 8.1

Portable Class Library

Supported in: Portable Class Library

  • SecurityCriticalAttribute 

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

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