doc/html/archive_read_add_passphrase.3.html

   1 <!-- Creator     : groff version 1.22.4 -->
   2 <!-- CreationDate: Mon Dec 30 01:41:22 2019 -->
   3 <!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN"
   4 "http://www.w3.org/TR/html4/loose.dtd">
   5 <html>
   6 <head>
   7 <meta name="generator" content="groff -Thtml, see www.gnu.org">
   8 <meta http-equiv="Content-Type" content="text/html; charset=US-ASCII">
   9 <meta name="Content-Style" content="text/css">
  10 <style type="text/css">
  11        p       { margin-top: 0; margin-bottom: 0; vertical-align: top }
  12        pre     { margin-top: 0; margin-bottom: 0; vertical-align: top }
  13        table   { margin-top: 0; margin-bottom: 0; vertical-align: top }
  14        h1      { text-align: center }
  15 </style>
  16 <title></title>
  17 </head>
  18 <body>
  19
  20 <hr>
  21
  22
  23 <p>ARCHIVE_READ_ADD_PASS... BSD Library Functions Manual
  24 ARCHIVE_READ_ADD_PASS...</p>
  25
  26 <p style="margin-top: 1em"><b>NAME</b></p>
  27
  28
  29 <p style="margin-left:6%;"><b>archive_read_add_passphrase</b>,
  30 <b>archive_read_set_passphrase_callback</b> &mdash;
  31 functions for reading encrypted archives</p>
  32
  33 <p style="margin-top: 1em"><b>LIBRARY</b></p>
  34
  35 <p style="margin-left:6%;">Streaming Archive Library
  36 (libarchive, -larchive)</p>
  37
  38 <p style="margin-top: 1em"><b>SYNOPSIS</b></p>
  39
  40 <p style="margin-left:6%;"><b>#include
  41 &lt;archive.h&gt;</b></p>
  42
  43 <p style="margin-left:6%; margin-top: 1em"><i>int</i></p>
  44
  45
  46 <p><b>archive_read_add_passphrase</b>(<i>struct&nbsp;archive&nbsp;*</i>,
  47 <i>const&nbsp;char&nbsp;*passphrase</i>);</p>
  48
  49 <p style="margin-left:6%; margin-top: 1em"><i>int</i></p>
  50
  51
  52 <p><b>archive_read_set_passphrase_callback</b>(<i>struct&nbsp;archive&nbsp;*</i>,
  53 <i>void&nbsp;*client_data</i>,
  54 <i>archive_passphrase_callback&nbsp;*</i>);</p>
  55
  56 <p style="margin-top: 1em"><b>DESCRIPTION <br>
  57 archive_read_add_passphrase</b>()</p>
  58
  59 <p style="margin-left:17%;">Register passphrases for
  60 reading an encryption archive. If <i>passphrase</i> is NULL
  61 or empty, this function will do nothing and
  62 <b>ARCHIVE_FAILED</b> will be returned. Otherwise,
  63 <b>ARCHIVE_OK</b> will be returned.</p>
  64
  65
  66 <p style="margin-top: 1em"><b>archive_read_set_passphrase_callback</b>()</p>
  67
  68 <p style="margin-left:17%;">Register a callback function
  69 that will be invoked to get a passphrase for decryption
  70 after trying all the passphrases registered by the
  71 <b>archive_read_add_passphrase</b>() function failed.</p>
  72
  73 <p style="margin-top: 1em"><b>SEE ALSO</b></p>
  74
  75 <p style="margin-left:6%;">tar(1), archive_read(3),
  76 archive_read_set_options(3), libarchive(3)</p>
  77
  78 <p style="margin-left:6%; margin-top: 1em">BSD
  79 September&nbsp;14, 2014 BSD</p>
  80 <hr>
  81 </body>
  82 </html>