Export (0) Print
Expand All

Marshal.ReadInt16 Method (IntPtr, Int32)

Updated: March 2011

Reads a 16-bit signed integer at a given offset from unmanaged memory.

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

public static short ReadInt16(
	IntPtr ptr,
	int ofs
)

Parameters

ptr
Type: System.IntPtr
The base address in unmanaged memory from which to read.
ofs
Type: System.Int32
An additional byte offset, which is added to the ptr parameter before reading.

Return Value

Type: System.Int16
The 16-bit signed integer read from unmanaged memory at the given offset.

ExceptionCondition
AccessViolationException

Base address (ptr) plus offset byte (ofs) produces a null or invalid address.

ReadInt16 enables direct interaction with an unmanaged 16-bit signed 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 demonstrates how to read and write to an unmanaged array using the ReadInt16 and WriteInt16 methods.


static void ReadWriteInt16()
{
    // Allocate unmanaged memory. 
    int elementSize = 2;
    IntPtr unmanagedArray = Marshal.AllocHGlobal(10 * elementSize);

    // Set the 10 elements of the C-style unmanagedArray
    for (int i = 0; i < 10; i++)
    {
        Marshal.WriteInt16(unmanagedArray, i * elementSize, ((Int16)(i + 1)));
    }
    Console.WriteLine("Unmanaged memory written.");

    Console.WriteLine("Reading unmanaged memory:");
    // Print the 10 elements of the C-style unmanagedArray
    for (int i = 0; i < 10; i++)
    {
        Console.WriteLine(Marshal.ReadInt16(unmanagedArray, i * elementSize));
    }

    Marshal.FreeHGlobal(unmanagedArray);

    Console.WriteLine("Done. Press Enter to continue.");
    Console.ReadLine();
}


The following example demonstrates how to use the ReadInt16 method to read the value of an unmanaged short variable.



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

void main()
{
    // Create an unmanaged short pointer.
    short * myShort;
    short tmp = 42;
    // Initialize it to another value.
    myShort = &tmp;

    // Read value as a managed Int16.
    Int16 ^ myManagedVal = Marshal::ReadInt16((IntPtr) myShort, 0);

    // Display the value to the console.
    Console::WriteLine(myManagedVal);
}


.NET Framework

Supported in: 4, 3.5, 3.0, 2.0, 1.1, 1.0

.NET Framework Client Profile

Supported in: 4, 3.5 SP1

  • 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 XP SP2 x64 Edition, 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.

Date

History

Reason

March 2011

In the first example, removed some bad code, corrected the allocation size, and updated Visual Basic to use a loop variable.

Content bug fix.

Community Additions

ADD
Show:
© 2014 Microsoft