WOLFRAM

Wolfram Language & System Documentation Center
Wolfram Language Home Page »

RawMemoryExport

Unsupported in Public Cloud[Experimental]

✖

exports a raw memory representation of expr.

✖
RawMemoryExport[expr,type]

uses the specified element type when returning an array.

Details and Options

  • RawMemoryExport returns a managed RawPointer object.
  • type can be omitted if expr is a string, ByteArray or NumericArray.
  • Possible element types and their corresponding C types include:
  • "UnsignedInteger8"uint8_tunsigned 8-bit integer
    "Integer8"int8_tsigned 8-bit integer
    "UnsignedInteger16"uint16_tunsigned 16-bit integer
    "Integer16"int16_tsigned 16-bit integer
    "UnsignedInteger32"uint32_tunsigned 32-bit integer
    "Integer32"int32_tsigned 32-bit integer
    "UnsignedInteger64"uint64_tunsigned 64-bit integer
    "Integer64"int64_tsigned 64-bit integer
    "CUnsignedChar"unsigned charC-compatible unsigned char
    "CSignedChar"signed charC-compatible signed char
    "CUnsignedShort"unsigned shortC-compatible unsigned short
    "CShort"shortC-compatible short
    "CUnsignedInt"unsigned intC-compatible unsigned int
    "CInt"intC-compatible int
    "CUnsignedLong"unsigned longC-compatible unsigned long
    "CLong"longC-compatible long
    "CSizeT"size_tC-compatible size_t
    "CFloat"floatC-compatible float
    "CDouble"doubleC-compatible double
    "OpaqueRawPointer"void*opaque pointer
    "RawPointer"::[t]t*typed pointer
    {ty1,ty2,…}struct {ty1 f1; ty2 f2; …}struct or product type
    "Void"voidno output (only in output types)
  • If expr is a ByteArray or a NumericArray, only integral and real types are allowed as the element type.
  • The following options are supported:
  • CharacterEncoding "UTF-8"character encoding

Examples

open allclose all

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

Export a raw memory representation of an integer:

In[1]:=1
✖
https://wolfram.com/xid/0dqwiufp086-p4s54e
Out[1]=1

Read the contents of the pointer:

In[2]:=2
✖
https://wolfram.com/xid/0dqwiufp086-779qjo
Out[2]=2

Export a raw memory representation of a string:

In[1]:=1
✖
https://wolfram.com/xid/0dqwiufp086-uv72gz
Out[1]=1

Import the contents of the raw memory:

In[2]:=2
✖
https://wolfram.com/xid/0dqwiufp086-e7lfgh
Out[2]=2

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

Use the second argument of RawMemoryExport to specify the element type of the exported raw memory:

In[1]:=1
✖
https://wolfram.com/xid/0dqwiufp086-zvs2o7
Out[2]=2
In[3]:=3
✖
https://wolfram.com/xid/0dqwiufp086-s8hw68
Out[4]=4

The element type can be omitted if the exported expression is a string, a ByteArray or a NumericArray:

In[1]:=1
✖
https://wolfram.com/xid/0dqwiufp086-lmysyz
Out[1]=1
In[2]:=2
✖
https://wolfram.com/xid/0dqwiufp086-cf4cg6
Out[2]=2
In[3]:=3
✖
https://wolfram.com/xid/0dqwiufp086-snhjcr
Out[3]=3

The raw memory is null-terminated when a string is exported:

In[1]:=1
✖
https://wolfram.com/xid/0dqwiufp086-2dvnn
Out[1]=1

Options  (1)Common values & functionality for each option

CharacterEncoding  (1)

Specify what CharacterEncoding should be used when exporting a string:

In[1]:=1
✖
https://wolfram.com/xid/0dqwiufp086-2htoma

Compare the contents of the pointers:

In[4]:=4
✖
https://wolfram.com/xid/0dqwiufp086-zh75gj
Out[4]=4
In[5]:=5
✖
https://wolfram.com/xid/0dqwiufp086-gvdilv
Out[5]=5

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

By default, RawMemoryExport returns a RawPointer wrapped in ManagedObject:

In[1]:=1
✖
https://wolfram.com/xid/0dqwiufp086-pnx687
Out[1]=1

Use UnmanageObject to unmanage the pointer:

In[2]:=2
✖
https://wolfram.com/xid/0dqwiufp086-4zay7p
Out[2]=2

RawMemoryImport is the inverse operation of RawMemoryExport:

In[1]:=1
✖
https://wolfram.com/xid/0dqwiufp086-x10wkb
Out[1]=1
In[2]:=2
✖
https://wolfram.com/xid/0dqwiufp086-i3r68f
Out[2]=2

Use ForeignFunctionLoad to load a function that computes the sum of the elements of a raw memory:

In[1]:=1
✖
https://wolfram.com/xid/0dqwiufp086-ngv0o5
Out[1]=1

Export a list as a raw memory of "CLong" objects:

In[2]:=2
✖
https://wolfram.com/xid/0dqwiufp086-g1rwc0
Out[2]=2

Call the function by passing the buffer and its length:

In[3]:=3
✖
https://wolfram.com/xid/0dqwiufp086-2in6km
Out[3]=3

Possible Issues  (5)Common pitfalls and unexpected behavior

Strings can only be exported as a raw memory of "UnsignedInteger8" objects:

In[1]:=1
✖
https://wolfram.com/xid/0dqwiufp086-2cxujy
Out[1]=1

The element type of the raw memory cannot be automatically determined if the inputted expression is a list:

In[1]:=1
✖
https://wolfram.com/xid/0dqwiufp086-68pajx
Out[1]=1

Specify the target element type:

In[2]:=2
✖
https://wolfram.com/xid/0dqwiufp086-0rkglw
Out[2]=2

RawMemoryExport will return $Failed if the element type is not supported:

In[1]:=1
✖
https://wolfram.com/xid/0dqwiufp086-0o9mhd
Out[1]=1

RawMemoryExport will return $Failed if an element does not match the specified element type:

In[1]:=1
✖
https://wolfram.com/xid/0dqwiufp086-3zrzfe
Out[1]=1

If the exported expression is a ByteArray or a NumericArray, the element type can only be integral and real types:

In[1]:=1
✖
https://wolfram.com/xid/0dqwiufp086-ru60x1
Out[1]=1
Wolfram Research (2023), RawMemoryExport, Wolfram Language function, https://reference.wolfram.com/language/ref/RawMemoryExport.html.
✖
Wolfram Research (2023), RawMemoryExport, Wolfram Language function, https://reference.wolfram.com/language/ref/RawMemoryExport.html.

Text

Wolfram Research (2023), RawMemoryExport, Wolfram Language function, https://reference.wolfram.com/language/ref/RawMemoryExport.html.

✖
Wolfram Research (2023), RawMemoryExport, Wolfram Language function, https://reference.wolfram.com/language/ref/RawMemoryExport.html.

CMS

Wolfram Language. 2023. "RawMemoryExport." Wolfram Language & System Documentation Center. Wolfram Research. https://reference.wolfram.com/language/ref/RawMemoryExport.html.

✖
Wolfram Language. 2023. "RawMemoryExport." Wolfram Language & System Documentation Center. Wolfram Research. https://reference.wolfram.com/language/ref/RawMemoryExport.html.

APA

Wolfram Language. (2023). RawMemoryExport. Wolfram Language & System Documentation Center. Retrieved from https://reference.wolfram.com/language/ref/RawMemoryExport.html

✖
Wolfram Language. (2023). RawMemoryExport. Wolfram Language & System Documentation Center. Retrieved from https://reference.wolfram.com/language/ref/RawMemoryExport.html

BibTeX

@misc{reference.wolfram_2025_rawmemoryexport, author="Wolfram Research", title="{RawMemoryExport}", year="2023", howpublished="\url{https://reference.wolfram.com/language/ref/RawMemoryExport.html}", note=[Accessed: 19-June-2025 ]}

✖
@misc{reference.wolfram_2025_rawmemoryexport, author="Wolfram Research", title="{RawMemoryExport}", year="2023", howpublished="\url{https://reference.wolfram.com/language/ref/RawMemoryExport.html}", note=[Accessed: 19-June-2025 ]}

BibLaTeX

@online{reference.wolfram_2025_rawmemoryexport, organization={Wolfram Research}, title={RawMemoryExport}, year={2023}, url={https://reference.wolfram.com/language/ref/RawMemoryExport.html}, note=[Accessed: 19-June-2025 ]}

✖
@online{reference.wolfram_2025_rawmemoryexport, organization={Wolfram Research}, title={RawMemoryExport}, year={2023}, url={https://reference.wolfram.com/language/ref/RawMemoryExport.html}, note=[Accessed: 19-June-2025 ]}