doc/wiki/ManPageArchiveReadAddPassphrase3.wiki

   1 ARCHIVE_READ_ADD_PASSPHRASE(3) manual page
   2 == NAME ==
   3 '''archive_read_add_passphrase''',
   4 '''archive_read_set_passphrase_callback'''
   5 - functions for reading encrypted archives
   6 == LIBRARY ==
   7 Streaming Archive Library (libarchive, -larchive)
   8 == SYNOPSIS ==
   9 '''<nowiki>#include <archive.h></nowiki>'''
  10 <br>
  11 ''int''
  12 <br>
  13 '''archive_read_add_passphrase'''(''struct archive *'', ''const char *passphrase'');
  14 <br>
  15 ''int''
  16 <br>
  17 '''archive_read_set_passphrase_callback'''(''struct archive *'', ''void *client_data'', ''archive_passphrase_callback *'');
  18 == DESCRIPTION ==
  19 <dl>
  20 <dt>'''archive_read_add_passphrase'''()</dt><dd>
  21 Register passphrases for reading an encryption archive.
  22 If
  23 ''passphrase''
  24 is
  25 NULL
  26 or empty, this function will do nothing and
  27 '''ARCHIVE_FAILED'''
  28 will be returned.
  29 Otherwise,
  30 '''ARCHIVE_OK'''
  31 will be returned.
  32 </dd><dt>'''archive_read_set_passphrase_callback'''()</dt><dd>
  33 Register callback function that will be invoked to get a passphrase
  34 for decrption after trying all passphrases registered by the
  35 '''archive_read_add_passphrase'''()
  36 function failed.
  37 </dd></dl>
  38 == SEE ALSO ==
  39 [[ManPageBsdtar1]],
  40 [[ManPageibarchive3]],
  41 [[ManPagerchiveead3]],
  42 [[ManPagerchiveeadetptions3]]