.. highlightlang:: us

.. _mem_dump:

mem_dump
========

.. index:: mem_dump

.. us.tag  mem_dump ENGLISH mem New500 Changed590

:ref:`mem_dump` prints a string as a memory block into the command window.

.. function::  n = mem_dump(ssString)
    n = mem_dump(ssString, count)
    n = mem_dump(ssString, count, offset)
    n = mem_dump(ssString, count, offset, bStringReturn)

.. us.return

**Return Value**

*n* is the string length. If *bStringReturn* is TRUE (1) the function 
returns a string value.

.. us.params

**Parameters**

.. uparam:: ssString

   *ssString* is a string that may contain NULL characters.

.. uparam:: offset

   *offset* is the start position in *ssString*. Default value is 0.

.. uparam:: bStringReturn

   If *bStringReturn* is TRUE (1) the function returns a string value.
   Default value is FALSE (0).

.. us.example

**Example**

::

   * mem_dump("Hello")
   00000000  48 00 65 00 6c 00 6c 00-6f 00                    H.e.l.l.-o
      10.0000 
   * mem_dump("Hello\x00Hello")
   00000000  48 00 65 00 6c 00 6c 00-6f 00 00 00 48 00 65 00  H.e.l.l.-o...H.e.
   00000010  6c 00 6c 00 6f 00                                l.l.o.
      22.0000 

.. us.history

**History**

.. list-table::
   :header-rows: 1

   * - Version
     - Description
   * - 5.9
     - New parameter *bStringReturn*.
   * - 5.0
     - New.

.. seealso::
   :ref:`overview-strings`,
   :ref:`mem_alloc`

:sub:`id-1714994`