tor-browser

The Tor Browser
git clone https://git.dasho.dev/tor-browser.git
Log | Files | Refs | README | LICENSE

pr_exportfilemapasstring.rst (732B)


      1 PR_ExportFileMapAsString
      2 ========================
      3 
      4 Creates a string identifying a :ref:`PRFileMap`.
      5 
      6 
      7 Syntax
      8 ------
      9 
     10 .. code::
     11 
     12   #include <prshma.h>
     13 
     14   NSPR_API( PRStatus )
     15   PR_ExportFileMapAsString(
     16     PRFileMap *fm,
     17     PRSize bufsize,
     18     char *buf
     19   );
     20 
     21 #. define PR_FILEMAP_STRING_BUFSIZE 128
     22 
     23 
     24 Parameters
     25 ~~~~~~~~~~
     26 
     27 The function has the following parameters:
     28 
     29 ``fm``
     30   A pointer to the :ref:`PRFileMap` to be represented as a string.
     31 ``bufsize``
     32   sizeof(buf)
     33 ``buf``
     34   A pointer to abuffer of length ``PR_FILEMAP_STRING_BUFSIZE``.
     35 
     36 
     37 Returns
     38 ~~~~~~~
     39 
     40 :ref:`PRStatus`
     41 
     42 
     43 Description
     44 -----------
     45 
     46 Creates an identifier, as a string, from a :ref:`PRFileMap` object
     47 previously created with :ref:`PR_OpenAnonFileMap`.