Marshal.ReadByte Method (IntPtr)

 
System_CAPS_noteNote

The .NET API Reference documentation has a new home. Visit the .NET API Browser on docs.microsoft.com to see the new experience.

Reads a single byte from unmanaged memory.

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

<SecurityCriticalAttribute>
Public Shared Function ReadByte (
	ptr As IntPtr
) As Byte

Parameters

ptr
Type: System.IntPtr

The address in unmanaged memory from which to read.

Return Value

Type: System.Byte

The byte read from unmanaged memory.

Exception Condition
AccessViolationException

ptr is not a recognized format.

-or-

ptr is null.

-or-

ptr is invalid.

ReadByte has an implied offset of 0. This method enables direct interaction with an unmanaged C-style byte array, eliminating the expense of copying an entire unmanaged array (using Marshal.Copy) to a separate managed array before reading its element values.

Reading from unaligned memory locations is supported.

The following example creates a block of unmanaged memory, writes a byte to the unmanaged memory, reads the byte back from unmanaged memory, and then disposes the unmanaged memory.

Imports System
Imports System.Runtime.InteropServices

Module Example
    Sub Main()
         ' Allocate 1 byte of unmanaged memory.
         Dim hGlobal As IntPtr = Marshal.AllocHGlobal(1)

         ' Create a new byte.
         Dim b As Byte = 1

         Console.WriteLine("Byte written to unmanaged memory: {0}", b)

         ' Write the byte to unmanaged memory.
         Marshal.WriteByte(hGlobal, b)

         ' Read byte from unmanaged memory.
         Dim c As Byte = Marshal.ReadByte(hGlobal)
         Console.WriteLine("Byte read from unmanaged memory: {0}", c)

         ' Free the unmanaged memory.
         Marshal.FreeHGlobal(hGlobal)
         Console.WriteLine("Unmanaged memory was disposed.")
    End Sub
End Module

The following example demonstrates how to use the ReadByte method to read the value of an unmanaged character.


using namespace System;
using namespace System::Runtime::InteropServices;



void main()
{
	// Create an unmanaged byte.
	const char * myString = "b";

	// Read the c string as a managed byte.
        Byte ^ myManagedByte = Marshal::ReadByte((IntPtr) (char *) myString);

	// Display the byte to the console.
	Console::WriteLine(myManagedByte);
}

SecurityCriticalAttribute

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

Universal Windows Platform
Available since 8
.NET Framework
Available since 1.1
Portable Class Library
Supported in: portable .NET platforms
Silverlight
Available since 2.0
Windows Phone Silverlight
Available since 7.0
Windows Phone
Available since 8.1
Return to top
Show: