RawMemoryImport

✖
`RawMemoryImport`

[Experimental]

✖

RawMemoryImport[ptr,format]

imports raw memory from the pointer ptr with the specified format.

✖

RawMemoryImport[format]

represents an operator form of RawMemoryImport that can be applied to an expression.

Details and Options

Supported values of ptr include RawPointer expressions and ManagedObject expressions whose values are pointers.
Supported values of format include:

	"String"	null-terminated string
	{"String",len}	string of len bytes
	{"ByteArray",len}	byte array of len bytes
	{"NumericArray",len}	numeric array of len elements
	{"List",len}	list of len elements

For "NumericArray" and "List" import formats, the element type is determined by the type of the input pointer ptr.
Supported options include:
CharacterEncoding "UTF-8" character encoding for strings

Examples

open allclose all

Basic Examples (1)Summary of the most common use cases

Export a string as raw memory:

In[1]:=1

✖

https://wolfram.com/xid/0dqwiufp1iq-9pm2hc

Out[2]=2

Import the raw memory as a list:

In[3]:=3

✖

https://wolfram.com/xid/0dqwiufp1iq-hsifng

Out[3]=3

Scope (4)Survey of the scope of standard use cases

RawMemoryImport supports passing a managed pointer as its first argument:

In[1]:=1

✖

https://wolfram.com/xid/0dqwiufp1iq-mwb9iq

Out[1]=1

In[2]:=2

✖

https://wolfram.com/xid/0dqwiufp1iq-9mwcxd

Out[2]=2

It also supports passing a non-managed pointer:

In[3]:=3

✖

https://wolfram.com/xid/0dqwiufp1iq-w8odst

Out[3]=3

In[4]:=4

✖

https://wolfram.com/xid/0dqwiufp1iq-8op9ak

Out[4]=4

Export a string as raw memory:

In[1]:=1

✖

https://wolfram.com/xid/0dqwiufp1iq-43l24a

Out[1]=1

Import the raw memory as a "List":

In[2]:=2

✖

https://wolfram.com/xid/0dqwiufp1iq-gtpw22

Out[2]=2

Import the raw memory as a "ByteArray":

In[3]:=3

✖

https://wolfram.com/xid/0dqwiufp1iq-s8uimj

Out[3]=3

Import the raw memory as a "NumericArray":

In[4]:=4

✖

https://wolfram.com/xid/0dqwiufp1iq-ttwdvv

Out[4]=4

Export a string as a raw memory:

In[1]:=1

✖

https://wolfram.com/xid/0dqwiufp1iq-pxtj60

For null-terminated strings, the length does not need to be specified:

In[2]:=2

✖

https://wolfram.com/xid/0dqwiufp1iq-i4oer0

Out[2]=2

Use RawMemoryImport in operator form:

In[1]:=1

✖

https://wolfram.com/xid/0dqwiufp1iq-8n26yu

Out[1]=1

Options (1)Common values & functionality for each option

CharacterEncoding (1)

Export a string with non-ASCII characters as raw memory:

In[1]:=1

✖

https://wolfram.com/xid/0dqwiufp1iq-2htoma

Specify what CharacterEncoding should be used when importing a string:

In[3]:=3

✖

https://wolfram.com/xid/0dqwiufp1iq-ezzlqc

Out[3]=3

In[4]:=4

✖

https://wolfram.com/xid/0dqwiufp1iq-zh75gj

Out[4]=4

Properties & Relations (1)Properties of the function, and connections to other functions

RawMemoryExport is the inverse operation of RawMemoryImport:

In[1]:=1

✖

https://wolfram.com/xid/0dqwiufp1iq-x10wkb

Out[1]=1

In[2]:=2

✖

https://wolfram.com/xid/0dqwiufp1iq-i3r68f

Out[2]=2

Possible Issues (1)Common pitfalls and unexpected behavior

RawMemoryImport fails if the format is not supported:

In[1]:=1

✖

https://wolfram.com/xid/0dqwiufp1iq-drjphp

Out[1]=1

Top