← Back to branch summary

~ubuntu-branches/ubuntu/trusty/libimobiledevice/trusty-proposed

« back to all changes in this revision

Viewing changes to docs/html/include_2libimobiledevice_2mobile__image__mounter_8h.html

  • Committer: Bazaar Package Importer
  • Author(s): Julien Lavergne
  • Date: 2011-02-13 23:48:06 UTC
  • mfrom: (6.1.2 experimental)
  • Revision ID: james.westby@ubuntu.com-20110213234806-troqpz4p4w2ooka1
Tags: 1.0.4-2
Upload to unstable.

Show diffs side-by-side

added added

removed removed

Lines of Context:
docs/html/include_2libimobiledevice_2mobile__image__mounter_8h.html
1
 
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
2
 
<html><head><meta http-equiv="Content-Type" content="text/html;charset=UTF-8">
 
1
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
 
2
<html xmlns="http://www.w3.org/1999/xhtml">
 
3
<head>
 
4
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
3
5
<title>libimobiledevice: libimobiledevice/mobile_image_mounter.h File Reference</title>
4
 
<link href="tabs.css" rel="stylesheet" type="text/css">
5
 
<link href="doxygen.css" rel="stylesheet" type="text/css">
6
 
</head><body>
7
 
<!-- Generated by Doxygen 1.5.9 -->
 
6
<link href="tabs.css" rel="stylesheet" type="text/css"/>
 
7
<link href="doxygen.css" rel="stylesheet" type="text/css"/>
 
8
</head>
 
9
<body>
 
10
<!-- Generated by Doxygen 1.6.3 -->
8
11
<div class="navigation" id="top">
9
12
  <div class="tabs">
10
13
    <ul>
21
24
  </div>
22
25
</div>
23
26
<div class="contents">
24
 
<h1>libimobiledevice/mobile_image_mounter.h File Reference</h1>Implementation of the mobile image mounter service.  
25
 
<a href="#_details">More...</a>
26
 
<p>
 
27
<h1>libimobiledevice/mobile_image_mounter.h File Reference</h1>
 
28
<p>Implementation of the mobile image mounter service.  
 
29
<a href="#_details">More...</a></p>
27
30
<table border="0" cellpadding="0" cellspacing="0">
28
 
<tr><td></td></tr>
29
 
<tr><td colspan="2"><br><h2>Typedefs</h2></td></tr>
30
 
<tr><td class="memItemLeft" nowrap align="right" valign="top">typedef int16_t&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="include_2libimobiledevice_2mobile__image__mounter_8h.html#e0b7c39de39769f44bba8dd94e9b03a8">mobile_image_mounter_error_t</a></td></tr>
31
 
 
32
 
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Represents an error code.  <a href="#e0b7c39de39769f44bba8dd94e9b03a8"></a><br></td></tr>
33
 
<tr><td class="memItemLeft" nowrap align="right" valign="top">typedef <br class="typebreak">
34
 
mobile_image_mounter_client_private *&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="include_2libimobiledevice_2mobile__image__mounter_8h.html#e7690ee36890c0c64933107e86c1ab0f">mobile_image_mounter_client_t</a></td></tr>
35
 
 
36
 
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">The client handle.  <a href="#e7690ee36890c0c64933107e86c1ab0f"></a><br></td></tr>
37
 
<tr><td colspan="2"><br><h2>Functions</h2></td></tr>
38
 
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="el" href="include_2libimobiledevice_2mobile__image__mounter_8h.html#e0b7c39de39769f44bba8dd94e9b03a8">mobile_image_mounter_error_t</a>&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="include_2libimobiledevice_2mobile__image__mounter_8h.html#44b66755d06202d4b592227106529ce4">mobile_image_mounter_new</a> (<a class="el" href="libimobiledevice_8h.html#e5bc0e9aa2f3b5023755f5e1c5039a60">idevice_t</a> device, uint16_t port, <a class="el" href="include_2libimobiledevice_2mobile__image__mounter_8h.html#e7690ee36890c0c64933107e86c1ab0f">mobile_image_mounter_client_t</a> *client)</td></tr>
39
 
 
40
 
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Connects to the mobile_image_mounter service on the specified device.  <a href="#44b66755d06202d4b592227106529ce4"></a><br></td></tr>
41
 
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="el" href="include_2libimobiledevice_2mobile__image__mounter_8h.html#e0b7c39de39769f44bba8dd94e9b03a8">mobile_image_mounter_error_t</a>&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="include_2libimobiledevice_2mobile__image__mounter_8h.html#840a19c567f46f66f1731babb8c608d1">mobile_image_mounter_free</a> (<a class="el" href="include_2libimobiledevice_2mobile__image__mounter_8h.html#e7690ee36890c0c64933107e86c1ab0f">mobile_image_mounter_client_t</a> client)</td></tr>
42
 
 
43
 
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Disconnects a mobile_image_mounter client from the device and frees up the mobile_image_mounter client data.  <a href="#840a19c567f46f66f1731babb8c608d1"></a><br></td></tr>
44
 
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="el" href="include_2libimobiledevice_2mobile__image__mounter_8h.html#e0b7c39de39769f44bba8dd94e9b03a8">mobile_image_mounter_error_t</a>&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="include_2libimobiledevice_2mobile__image__mounter_8h.html#36eaa679c99ce97b4d4101691cee5fc3">mobile_image_mounter_lookup_image</a> (<a class="el" href="include_2libimobiledevice_2mobile__image__mounter_8h.html#e7690ee36890c0c64933107e86c1ab0f">mobile_image_mounter_client_t</a> client, const char *image_type, plist_t *result)</td></tr>
45
 
 
46
 
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Tells if the image of ImageType is already mounted.  <a href="#36eaa679c99ce97b4d4101691cee5fc3"></a><br></td></tr>
47
 
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="el" href="include_2libimobiledevice_2mobile__image__mounter_8h.html#e0b7c39de39769f44bba8dd94e9b03a8">mobile_image_mounter_error_t</a>&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="include_2libimobiledevice_2mobile__image__mounter_8h.html#8b2d5a1a5aca62984095f5a5731ea9cb">mobile_image_mounter_mount_image</a> (<a class="el" href="include_2libimobiledevice_2mobile__image__mounter_8h.html#e7690ee36890c0c64933107e86c1ab0f">mobile_image_mounter_client_t</a> client, const char *image_path, const char *image_signature, uint16_t signature_length, const char *image_type, plist_t *result)</td></tr>
48
 
 
49
 
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Mounts an image on the device.  <a href="#8b2d5a1a5aca62984095f5a5731ea9cb"></a><br></td></tr>
50
 
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="el" href="include_2libimobiledevice_2mobile__image__mounter_8h.html#e0b7c39de39769f44bba8dd94e9b03a8">mobile_image_mounter_error_t</a>&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="include_2libimobiledevice_2mobile__image__mounter_8h.html#0b171083275b80170677f4e7c2b6200a">mobile_image_mounter_hangup</a> (<a class="el" href="include_2libimobiledevice_2mobile__image__mounter_8h.html#e7690ee36890c0c64933107e86c1ab0f">mobile_image_mounter_client_t</a> client)</td></tr>
51
 
 
52
 
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Hangs up the connection to the mobile_image_mounter service.  <a href="#0b171083275b80170677f4e7c2b6200a"></a><br></td></tr>
53
 
<tr><td colspan="2"><br><h2>Error Codes</h2></td></tr>
54
 
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="009f8723f2cc02a019de2b15d750abe6"></a><!-- doxytag: member="include/libimobiledevice/mobile_image_mounter.h::MOBILE_IMAGE_MOUNTER_E_SUCCESS" ref="009f8723f2cc02a019de2b15d750abe6" args="" -->
 
31
<tr><td colspan="2"><h2>Typedefs</h2></td></tr>
 
32
<tr><td class="memItemLeft" align="right" valign="top">typedef int16_t&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="include_2libimobiledevice_2mobile__image__mounter_8h.html#ae0b7c39de39769f44bba8dd94e9b03a8">mobile_image_mounter_error_t</a></td></tr>
 
33
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Represents an error code.  <a href="#ae0b7c39de39769f44bba8dd94e9b03a8"></a><br/></td></tr>
 
34
<tr><td class="memItemLeft" align="right" valign="top">typedef <br class="typebreak"/>
 
35
<a class="el" href="structmobile__image__mounter__client__private.html">mobile_image_mounter_client_private</a> *&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="include_2libimobiledevice_2mobile__image__mounter_8h.html#ae7690ee36890c0c64933107e86c1ab0f">mobile_image_mounter_client_t</a></td></tr>
 
36
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">The client handle.  <a href="#ae7690ee36890c0c64933107e86c1ab0f"></a><br/></td></tr>
 
37
<tr><td colspan="2"><h2>Functions</h2></td></tr>
 
38
<tr><td class="memItemLeft" align="right" valign="top"><a class="el" href="include_2libimobiledevice_2mobile__image__mounter_8h.html#ae0b7c39de39769f44bba8dd94e9b03a8">mobile_image_mounter_error_t</a>&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="include_2libimobiledevice_2mobile__image__mounter_8h.html#a44b66755d06202d4b592227106529ce4">mobile_image_mounter_new</a> (<a class="el" href="structidevice__private.html">idevice_t</a> device, uint16_t port, <a class="el" href="structmobile__image__mounter__client__private.html">mobile_image_mounter_client_t</a> *client)</td></tr>
 
39
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Connects to the mobile_image_mounter service on the specified device.  <a href="#a44b66755d06202d4b592227106529ce4"></a><br/></td></tr>
 
40
<tr><td class="memItemLeft" align="right" valign="top"><a class="el" href="include_2libimobiledevice_2mobile__image__mounter_8h.html#ae0b7c39de39769f44bba8dd94e9b03a8">mobile_image_mounter_error_t</a>&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="include_2libimobiledevice_2mobile__image__mounter_8h.html#a840a19c567f46f66f1731babb8c608d1">mobile_image_mounter_free</a> (<a class="el" href="structmobile__image__mounter__client__private.html">mobile_image_mounter_client_t</a> client)</td></tr>
 
41
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Disconnects a mobile_image_mounter client from the device and frees up the mobile_image_mounter client data.  <a href="#a840a19c567f46f66f1731babb8c608d1"></a><br/></td></tr>
 
42
<tr><td class="memItemLeft" align="right" valign="top"><a class="el" href="include_2libimobiledevice_2mobile__image__mounter_8h.html#ae0b7c39de39769f44bba8dd94e9b03a8">mobile_image_mounter_error_t</a>&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="include_2libimobiledevice_2mobile__image__mounter_8h.html#a36eaa679c99ce97b4d4101691cee5fc3">mobile_image_mounter_lookup_image</a> (<a class="el" href="structmobile__image__mounter__client__private.html">mobile_image_mounter_client_t</a> client, const char *image_type, plist_t *result)</td></tr>
 
43
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Tells if the image of ImageType is already mounted.  <a href="#a36eaa679c99ce97b4d4101691cee5fc3"></a><br/></td></tr>
 
44
<tr><td class="memItemLeft" align="right" valign="top"><a class="el" href="include_2libimobiledevice_2mobile__image__mounter_8h.html#ae0b7c39de39769f44bba8dd94e9b03a8">mobile_image_mounter_error_t</a>&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="include_2libimobiledevice_2mobile__image__mounter_8h.html#a8b2d5a1a5aca62984095f5a5731ea9cb">mobile_image_mounter_mount_image</a> (<a class="el" href="structmobile__image__mounter__client__private.html">mobile_image_mounter_client_t</a> client, const char *image_path, const char *image_signature, uint16_t signature_length, const char *image_type, plist_t *result)</td></tr>
 
45
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Mounts an image on the device.  <a href="#a8b2d5a1a5aca62984095f5a5731ea9cb"></a><br/></td></tr>
 
46
<tr><td class="memItemLeft" align="right" valign="top"><a class="el" href="include_2libimobiledevice_2mobile__image__mounter_8h.html#ae0b7c39de39769f44bba8dd94e9b03a8">mobile_image_mounter_error_t</a>&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="include_2libimobiledevice_2mobile__image__mounter_8h.html#a0b171083275b80170677f4e7c2b6200a">mobile_image_mounter_hangup</a> (<a class="el" href="structmobile__image__mounter__client__private.html">mobile_image_mounter_client_t</a> client)</td></tr>
 
47
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Hangs up the connection to the mobile_image_mounter service.  <a href="#a0b171083275b80170677f4e7c2b6200a"></a><br/></td></tr>
 
48
<tr><td colspan="2"><h2>Error Codes</h2></td></tr>
 
49
<tr><td colspan="2"><p><a class="anchor" id="amgrp5c244138ac975df1b1cec1afc71a6c9a"></a> </p>
 
50
<br/><br/></td></tr>
 
51
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a009f8723f2cc02a019de2b15d750abe6"></a><!-- doxytag: member="include/libimobiledevice/mobile_image_mounter.h::MOBILE_IMAGE_MOUNTER_E_SUCCESS" ref="a009f8723f2cc02a019de2b15d750abe6" args="" -->
55
52
#define&nbsp;</td><td class="memItemRight" valign="bottom"><b>MOBILE_IMAGE_MOUNTER_E_SUCCESS</b>&nbsp;&nbsp;&nbsp;0</td></tr>
56
 
 
57
 
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="217d6ea66fbb8d8759a0e7cb50244072"></a><!-- doxytag: member="include/libimobiledevice/mobile_image_mounter.h::MOBILE_IMAGE_MOUNTER_E_INVALID_ARG" ref="217d6ea66fbb8d8759a0e7cb50244072" args="" -->
 
53
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a217d6ea66fbb8d8759a0e7cb50244072"></a><!-- doxytag: member="include/libimobiledevice/mobile_image_mounter.h::MOBILE_IMAGE_MOUNTER_E_INVALID_ARG" ref="a217d6ea66fbb8d8759a0e7cb50244072" args="" -->
58
54
#define&nbsp;</td><td class="memItemRight" valign="bottom"><b>MOBILE_IMAGE_MOUNTER_E_INVALID_ARG</b>&nbsp;&nbsp;&nbsp;-1</td></tr>
59
 
 
60
 
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="d4f2241cb27ea2fbd00fe255945c5b33"></a><!-- doxytag: member="include/libimobiledevice/mobile_image_mounter.h::MOBILE_IMAGE_MOUNTER_E_PLIST_ERROR" ref="d4f2241cb27ea2fbd00fe255945c5b33" args="" -->
 
55
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ad4f2241cb27ea2fbd00fe255945c5b33"></a><!-- doxytag: member="include/libimobiledevice/mobile_image_mounter.h::MOBILE_IMAGE_MOUNTER_E_PLIST_ERROR" ref="ad4f2241cb27ea2fbd00fe255945c5b33" args="" -->
61
56
#define&nbsp;</td><td class="memItemRight" valign="bottom"><b>MOBILE_IMAGE_MOUNTER_E_PLIST_ERROR</b>&nbsp;&nbsp;&nbsp;-2</td></tr>
62
 
 
63
 
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="d35bff9a902ebb2fdc5d97f1a61dc3c5"></a><!-- doxytag: member="include/libimobiledevice/mobile_image_mounter.h::MOBILE_IMAGE_MOUNTER_E_CONN_FAILED" ref="d35bff9a902ebb2fdc5d97f1a61dc3c5" args="" -->
 
57
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ad35bff9a902ebb2fdc5d97f1a61dc3c5"></a><!-- doxytag: member="include/libimobiledevice/mobile_image_mounter.h::MOBILE_IMAGE_MOUNTER_E_CONN_FAILED" ref="ad35bff9a902ebb2fdc5d97f1a61dc3c5" args="" -->
64
58
#define&nbsp;</td><td class="memItemRight" valign="bottom"><b>MOBILE_IMAGE_MOUNTER_E_CONN_FAILED</b>&nbsp;&nbsp;&nbsp;-3</td></tr>
65
 
 
66
 
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="81d6dc3bb4330021394173d6b5166623"></a><!-- doxytag: member="include/libimobiledevice/mobile_image_mounter.h::MOBILE_IMAGE_MOUNTER_E_UNKNOWN_ERROR" ref="81d6dc3bb4330021394173d6b5166623" args="" -->
 
59
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a81d6dc3bb4330021394173d6b5166623"></a><!-- doxytag: member="include/libimobiledevice/mobile_image_mounter.h::MOBILE_IMAGE_MOUNTER_E_UNKNOWN_ERROR" ref="a81d6dc3bb4330021394173d6b5166623" args="" -->
67
60
#define&nbsp;</td><td class="memItemRight" valign="bottom"><b>MOBILE_IMAGE_MOUNTER_E_UNKNOWN_ERROR</b>&nbsp;&nbsp;&nbsp;-256</td></tr>
68
 
 
69
61
</table>
70
 
<hr><h2>Detailed Description</h2>
71
 
Implementation of the mobile image mounter service. 
72
 
<p>
73
 
<hr><h2>Typedef Documentation</h2>
74
 
<a class="anchor" name="e7690ee36890c0c64933107e86c1ab0f"></a><!-- doxytag: member="mobile_image_mounter.h::mobile_image_mounter_client_t" ref="e7690ee36890c0c64933107e86c1ab0f" args="" -->
75
 
<div class="memitem">
76
 
<div class="memproto">
77
 
      <table class="memname">
78
 
        <tr>
79
 
          <td class="memname">typedef mobile_image_mounter_client_private* <a class="el" href="include_2libimobiledevice_2mobile__image__mounter_8h.html#e7690ee36890c0c64933107e86c1ab0f">mobile_image_mounter_client_t</a>          </td>
80
 
        </tr>
81
 
      </table>
82
 
</div>
83
 
<div class="memdoc">
84
 
 
85
 
<p>
86
 
The client handle. 
87
 
<p>
88
 
 
89
 
</div>
90
 
</div><p>
91
 
<a class="anchor" name="e0b7c39de39769f44bba8dd94e9b03a8"></a><!-- doxytag: member="mobile_image_mounter.h::mobile_image_mounter_error_t" ref="e0b7c39de39769f44bba8dd94e9b03a8" args="" -->
92
 
<div class="memitem">
93
 
<div class="memproto">
94
 
      <table class="memname">
95
 
        <tr>
96
 
          <td class="memname">typedef int16_t <a class="el" href="include_2libimobiledevice_2mobile__image__mounter_8h.html#e0b7c39de39769f44bba8dd94e9b03a8">mobile_image_mounter_error_t</a>          </td>
97
 
        </tr>
98
 
      </table>
99
 
</div>
100
 
<div class="memdoc">
101
 
 
102
 
<p>
103
 
Represents an error code. 
104
 
<p>
105
 
 
106
 
</div>
107
 
</div><p>
108
 
<hr><h2>Function Documentation</h2>
109
 
<a class="anchor" name="840a19c567f46f66f1731babb8c608d1"></a><!-- doxytag: member="mobile_image_mounter.h::mobile_image_mounter_free" ref="840a19c567f46f66f1731babb8c608d1" args="(mobile_image_mounter_client_t client)" -->
110
 
<div class="memitem">
111
 
<div class="memproto">
112
 
      <table class="memname">
113
 
        <tr>
114
 
          <td class="memname"><a class="el" href="include_2libimobiledevice_2mobile__image__mounter_8h.html#e0b7c39de39769f44bba8dd94e9b03a8">mobile_image_mounter_error_t</a> mobile_image_mounter_free           </td>
 
62
<hr/><a name="_details"></a><h2>Detailed Description</h2>
 
63
<p>Implementation of the mobile image mounter service. </p>
 
64
<hr/><h2>Typedef Documentation</h2>
 
65
<a class="anchor" id="ae7690ee36890c0c64933107e86c1ab0f"></a><!-- doxytag: member="mobile_image_mounter.h::mobile_image_mounter_client_t" ref="ae7690ee36890c0c64933107e86c1ab0f" args="" -->
 
66
<div class="memitem">
 
67
<div class="memproto">
 
68
      <table class="memname">
 
69
        <tr>
 
70
          <td class="memname">typedef <a class="el" href="structmobile__image__mounter__client__private.html">mobile_image_mounter_client_private</a>* <a class="el" href="structmobile__image__mounter__client__private.html">mobile_image_mounter_client_t</a></td>
 
71
        </tr>
 
72
      </table>
 
73
</div>
 
74
<div class="memdoc">
 
75
 
 
76
<p>The client handle. </p>
 
77
 
 
78
</div>
 
79
</div>
 
80
<a class="anchor" id="ae0b7c39de39769f44bba8dd94e9b03a8"></a><!-- doxytag: member="mobile_image_mounter.h::mobile_image_mounter_error_t" ref="ae0b7c39de39769f44bba8dd94e9b03a8" args="" -->
 
81
<div class="memitem">
 
82
<div class="memproto">
 
83
      <table class="memname">
 
84
        <tr>
 
85
          <td class="memname">typedef int16_t <a class="el" href="include_2libimobiledevice_2mobile__image__mounter_8h.html#ae0b7c39de39769f44bba8dd94e9b03a8">mobile_image_mounter_error_t</a></td>
 
86
        </tr>
 
87
      </table>
 
88
</div>
 
89
<div class="memdoc">
 
90
 
 
91
<p>Represents an error code. </p>
 
92
 
 
93
</div>
 
94
</div>
 
95
<hr/><h2>Function Documentation</h2>
 
96
<a class="anchor" id="a840a19c567f46f66f1731babb8c608d1"></a><!-- doxytag: member="mobile_image_mounter.h::mobile_image_mounter_free" ref="a840a19c567f46f66f1731babb8c608d1" args="(mobile_image_mounter_client_t client)" -->
 
97
<div class="memitem">
 
98
<div class="memproto">
 
99
      <table class="memname">
 
100
        <tr>
 
101
          <td class="memname"><a class="el" href="include_2libimobiledevice_2mobile__image__mounter_8h.html#ae0b7c39de39769f44bba8dd94e9b03a8">mobile_image_mounter_error_t</a> mobile_image_mounter_free </td>
115
102
          <td>(</td>
116
 
          <td class="paramtype"><a class="el" href="include_2libimobiledevice_2mobile__image__mounter_8h.html#e7690ee36890c0c64933107e86c1ab0f">mobile_image_mounter_client_t</a>&nbsp;</td>
117
 
          <td class="paramname"> <em>client</em>          </td>
 
103
          <td class="paramtype"><a class="el" href="structmobile__image__mounter__client__private.html">mobile_image_mounter_client_t</a>&nbsp;</td>
 
104
          <td class="paramname"> <em>client</em></td>
118
105
          <td>&nbsp;)&nbsp;</td>
119
106
          <td></td>
120
107
        </tr>
122
109
</div>
123
110
<div class="memdoc">
124
111
 
125
 
<p>
126
 
Disconnects a mobile_image_mounter client from the device and frees up the mobile_image_mounter client data. 
127
 
<p>
128
 
<dl compact><dt><b>Parameters:</b></dt><dd>
 
112
<p>Disconnects a mobile_image_mounter client from the device and frees up the mobile_image_mounter client data. </p>
 
113
<dl><dt><b>Parameters:</b></dt><dd>
129
114
  <table border="0" cellspacing="2" cellpadding="0">
130
115
    <tr><td valign="top"></td><td valign="top"><em>client</em>&nbsp;</td><td>The mobile_image_mounter client to disconnect and free.</td></tr>
131
116
  </table>
 
117
  </dd>
132
118
</dl>
133
 
<dl class="return" compact><dt><b>Returns:</b></dt><dd>MOBILE_IMAGE_MOUNTER_E_SUCCESS on success, or MOBILE_IMAGE_MOUNTER_E_INVALID_ARG if client is NULL. </dd></dl>
 
119
<dl class="return"><dt><b>Returns:</b></dt><dd>MOBILE_IMAGE_MOUNTER_E_SUCCESS on success, or MOBILE_IMAGE_MOUNTER_E_INVALID_ARG if client is NULL. </dd></dl>
134
120
 
135
121
</div>
136
 
</div><p>
137
 
<a class="anchor" name="0b171083275b80170677f4e7c2b6200a"></a><!-- doxytag: member="mobile_image_mounter.h::mobile_image_mounter_hangup" ref="0b171083275b80170677f4e7c2b6200a" args="(mobile_image_mounter_client_t client)" -->
 
122
</div>
 
123
<a class="anchor" id="a0b171083275b80170677f4e7c2b6200a"></a><!-- doxytag: member="mobile_image_mounter.h::mobile_image_mounter_hangup" ref="a0b171083275b80170677f4e7c2b6200a" args="(mobile_image_mounter_client_t client)" -->
138
124
<div class="memitem">
139
125
<div class="memproto">
140
126
      <table class="memname">
141
127
        <tr>
142
 
          <td class="memname"><a class="el" href="include_2libimobiledevice_2mobile__image__mounter_8h.html#e0b7c39de39769f44bba8dd94e9b03a8">mobile_image_mounter_error_t</a> mobile_image_mounter_hangup           </td>
 
128
          <td class="memname"><a class="el" href="include_2libimobiledevice_2mobile__image__mounter_8h.html#ae0b7c39de39769f44bba8dd94e9b03a8">mobile_image_mounter_error_t</a> mobile_image_mounter_hangup </td>
143
129
          <td>(</td>
144
 
          <td class="paramtype"><a class="el" href="include_2libimobiledevice_2mobile__image__mounter_8h.html#e7690ee36890c0c64933107e86c1ab0f">mobile_image_mounter_client_t</a>&nbsp;</td>
145
 
          <td class="paramname"> <em>client</em>          </td>
 
130
          <td class="paramtype"><a class="el" href="structmobile__image__mounter__client__private.html">mobile_image_mounter_client_t</a>&nbsp;</td>
 
131
          <td class="paramname"> <em>client</em></td>
146
132
          <td>&nbsp;)&nbsp;</td>
147
133
          <td></td>
148
134
        </tr>
150
136
</div>
151
137
<div class="memdoc">
152
138
 
153
 
<p>
154
 
Hangs up the connection to the mobile_image_mounter service. 
155
 
<p>
156
 
This functions has to be called before freeing up a mobile_image_mounter instance. If not, errors appear in the device's syslog.<p>
157
 
<dl compact><dt><b>Parameters:</b></dt><dd>
 
139
<p>Hangs up the connection to the mobile_image_mounter service. </p>
 
140
<p>This functions has to be called before freeing up a mobile_image_mounter instance. If not, errors appear in the device's syslog.</p>
 
141
<dl><dt><b>Parameters:</b></dt><dd>
158
142
  <table border="0" cellspacing="2" cellpadding="0">
159
143
    <tr><td valign="top"></td><td valign="top"><em>client</em>&nbsp;</td><td>The client to hang up</td></tr>
160
144
  </table>
 
145
  </dd>
161
146
</dl>
162
 
<dl class="return" compact><dt><b>Returns:</b></dt><dd>MOBILE_IMAGE_MOUNTER_E_SUCCESS on success, MOBILE_IMAGE_MOUNTER_E_INVALID_ARG if client is invalid, or another error code otherwise. </dd></dl>
 
147
<dl class="return"><dt><b>Returns:</b></dt><dd>MOBILE_IMAGE_MOUNTER_E_SUCCESS on success, MOBILE_IMAGE_MOUNTER_E_INVALID_ARG if client is invalid, or another error code otherwise. </dd></dl>
163
148
 
164
149
</div>
165
 
</div><p>
166
 
<a class="anchor" name="36eaa679c99ce97b4d4101691cee5fc3"></a><!-- doxytag: member="mobile_image_mounter.h::mobile_image_mounter_lookup_image" ref="36eaa679c99ce97b4d4101691cee5fc3" args="(mobile_image_mounter_client_t client, const char *image_type, plist_t *result)" -->
 
150
</div>
 
151
<a class="anchor" id="a36eaa679c99ce97b4d4101691cee5fc3"></a><!-- doxytag: member="mobile_image_mounter.h::mobile_image_mounter_lookup_image" ref="a36eaa679c99ce97b4d4101691cee5fc3" args="(mobile_image_mounter_client_t client, const char *image_type, plist_t *result)" -->
167
152
<div class="memitem">
168
153
<div class="memproto">
169
154
      <table class="memname">
170
155
        <tr>
171
 
          <td class="memname"><a class="el" href="include_2libimobiledevice_2mobile__image__mounter_8h.html#e0b7c39de39769f44bba8dd94e9b03a8">mobile_image_mounter_error_t</a> mobile_image_mounter_lookup_image           </td>
 
156
          <td class="memname"><a class="el" href="include_2libimobiledevice_2mobile__image__mounter_8h.html#ae0b7c39de39769f44bba8dd94e9b03a8">mobile_image_mounter_error_t</a> mobile_image_mounter_lookup_image </td>
172
157
          <td>(</td>
173
 
          <td class="paramtype"><a class="el" href="include_2libimobiledevice_2mobile__image__mounter_8h.html#e7690ee36890c0c64933107e86c1ab0f">mobile_image_mounter_client_t</a>&nbsp;</td>
 
158
          <td class="paramtype"><a class="el" href="structmobile__image__mounter__client__private.html">mobile_image_mounter_client_t</a>&nbsp;</td>
174
159
          <td class="paramname"> <em>client</em>, </td>
175
160
        </tr>
176
161
        <tr>
194
179
</div>
195
180
<div class="memdoc">
196
181
 
197
 
<p>
198
 
Tells if the image of ImageType is already mounted. 
199
 
<p>
200
 
<dl compact><dt><b>Parameters:</b></dt><dd>
 
182
<p>Tells if the image of ImageType is already mounted. </p>
 
183
<dl><dt><b>Parameters:</b></dt><dd>
201
184
  <table border="0" cellspacing="2" cellpadding="0">
202
185
    <tr><td valign="top"></td><td valign="top"><em>client</em>&nbsp;</td><td>The client use </td></tr>
203
186
    <tr><td valign="top"></td><td valign="top"><em>image_type</em>&nbsp;</td><td>The type of the image to look up </td></tr>
204
187
    <tr><td valign="top"></td><td valign="top"><em>result</em>&nbsp;</td><td>Pointer to a plist that will receive the result of the operation.</td></tr>
205
188
  </table>
 
189
  </dd>
206
190
</dl>
207
 
<dl class="note" compact><dt><b>Note:</b></dt><dd>This function may return MOBILE_IMAGE_MOUNTER_E_SUCCESS even if the operation has failed. Check the resulting plist for further information.</dd></dl>
208
 
<dl class="return" compact><dt><b>Returns:</b></dt><dd>MOBILE_IMAGE_MOUNTER_E_SUCCESS on success, or an error code on error </dd></dl>
 
191
<dl class="note"><dt><b>Note:</b></dt><dd>This function may return MOBILE_IMAGE_MOUNTER_E_SUCCESS even if the operation has failed. Check the resulting plist for further information.</dd></dl>
 
192
<dl class="return"><dt><b>Returns:</b></dt><dd>MOBILE_IMAGE_MOUNTER_E_SUCCESS on success, or an error code on error </dd></dl>
209
193
 
210
194
</div>
211
 
</div><p>
212
 
<a class="anchor" name="8b2d5a1a5aca62984095f5a5731ea9cb"></a><!-- doxytag: member="mobile_image_mounter.h::mobile_image_mounter_mount_image" ref="8b2d5a1a5aca62984095f5a5731ea9cb" args="(mobile_image_mounter_client_t client, const char *image_path, const char *image_signature, uint16_t signature_length, const char *image_type, plist_t *result)" -->
 
195
</div>
 
196
<a class="anchor" id="a8b2d5a1a5aca62984095f5a5731ea9cb"></a><!-- doxytag: member="mobile_image_mounter.h::mobile_image_mounter_mount_image" ref="a8b2d5a1a5aca62984095f5a5731ea9cb" args="(mobile_image_mounter_client_t client, const char *image_path, const char *image_signature, uint16_t signature_length, const char *image_type, plist_t *result)" -->
213
197
<div class="memitem">
214
198
<div class="memproto">
215
199
      <table class="memname">
216
200
        <tr>
217
 
          <td class="memname"><a class="el" href="include_2libimobiledevice_2mobile__image__mounter_8h.html#e0b7c39de39769f44bba8dd94e9b03a8">mobile_image_mounter_error_t</a> mobile_image_mounter_mount_image           </td>
 
201
          <td class="memname"><a class="el" href="include_2libimobiledevice_2mobile__image__mounter_8h.html#ae0b7c39de39769f44bba8dd94e9b03a8">mobile_image_mounter_error_t</a> mobile_image_mounter_mount_image </td>
218
202
          <td>(</td>
219
 
          <td class="paramtype"><a class="el" href="include_2libimobiledevice_2mobile__image__mounter_8h.html#e7690ee36890c0c64933107e86c1ab0f">mobile_image_mounter_client_t</a>&nbsp;</td>
 
203
          <td class="paramtype"><a class="el" href="structmobile__image__mounter__client__private.html">mobile_image_mounter_client_t</a>&nbsp;</td>
220
204
          <td class="paramname"> <em>client</em>, </td>
221
205
        </tr>
222
206
        <tr>
258
242
</div>
259
243
<div class="memdoc">
260
244
 
261
 
<p>
262
 
Mounts an image on the device. 
263
 
<p>
264
 
<dl compact><dt><b>Parameters:</b></dt><dd>
 
245
<p>Mounts an image on the device. </p>
 
246
<dl><dt><b>Parameters:</b></dt><dd>
265
247
  <table border="0" cellspacing="2" cellpadding="0">
266
248
    <tr><td valign="top"></td><td valign="top"><em>client</em>&nbsp;</td><td>The connected mobile_image_mounter client. </td></tr>
267
249
    <tr><td valign="top"></td><td valign="top"><em>image_path</em>&nbsp;</td><td>The absolute path of the image to mount. The image must be present before calling this function. </td></tr>
270
252
    <tr><td valign="top"></td><td valign="top"><em>image_type</em>&nbsp;</td><td>Type of image to mount </td></tr>
271
253
    <tr><td valign="top"></td><td valign="top"><em>result</em>&nbsp;</td><td>Pointer to a plist that will receive the result of the operation.</td></tr>
272
254
  </table>
 
255
  </dd>
273
256
</dl>
274
 
<dl class="note" compact><dt><b>Note:</b></dt><dd>This function may return MOBILE_IMAGE_MOUNTER_E_SUCCESS even if the operation has failed. Check the resulting plist for further information. Note that there is no unmounting function. The mount persists until the device is rebooted.</dd></dl>
275
 
<dl class="return" compact><dt><b>Returns:</b></dt><dd>MOBILE_IMAGE_MOUNTER_E_SUCCESS on success, MOBILE_IMAGE_MOUNTER_E_INVALID_ARG if on ore more parameters are invalid, or another error code otherwise. </dd></dl>
 
257
<dl class="note"><dt><b>Note:</b></dt><dd>This function may return MOBILE_IMAGE_MOUNTER_E_SUCCESS even if the operation has failed. Check the resulting plist for further information. Note that there is no unmounting function. The mount persists until the device is rebooted.</dd></dl>
 
258
<dl class="return"><dt><b>Returns:</b></dt><dd>MOBILE_IMAGE_MOUNTER_E_SUCCESS on success, MOBILE_IMAGE_MOUNTER_E_INVALID_ARG if on ore more parameters are invalid, or another error code otherwise. </dd></dl>
276
259
 
277
260
</div>
278
 
</div><p>
279
 
<a class="anchor" name="44b66755d06202d4b592227106529ce4"></a><!-- doxytag: member="mobile_image_mounter.h::mobile_image_mounter_new" ref="44b66755d06202d4b592227106529ce4" args="(idevice_t device, uint16_t port, mobile_image_mounter_client_t *client)" -->
 
261
</div>
 
262
<a class="anchor" id="a44b66755d06202d4b592227106529ce4"></a><!-- doxytag: member="mobile_image_mounter.h::mobile_image_mounter_new" ref="a44b66755d06202d4b592227106529ce4" args="(idevice_t device, uint16_t port, mobile_image_mounter_client_t *client)" -->
280
263
<div class="memitem">
281
264
<div class="memproto">
282
265
      <table class="memname">
283
266
        <tr>
284
 
          <td class="memname"><a class="el" href="include_2libimobiledevice_2mobile__image__mounter_8h.html#e0b7c39de39769f44bba8dd94e9b03a8">mobile_image_mounter_error_t</a> mobile_image_mounter_new           </td>
 
267
          <td class="memname"><a class="el" href="include_2libimobiledevice_2mobile__image__mounter_8h.html#ae0b7c39de39769f44bba8dd94e9b03a8">mobile_image_mounter_error_t</a> mobile_image_mounter_new </td>
285
268
          <td>(</td>
286
 
          <td class="paramtype"><a class="el" href="libimobiledevice_8h.html#e5bc0e9aa2f3b5023755f5e1c5039a60">idevice_t</a>&nbsp;</td>
 
269
          <td class="paramtype"><a class="el" href="structidevice__private.html">idevice_t</a>&nbsp;</td>
287
270
          <td class="paramname"> <em>device</em>, </td>
288
271
        </tr>
289
272
        <tr>
295
278
        <tr>
296
279
          <td class="paramkey"></td>
297
280
          <td></td>
298
 
          <td class="paramtype"><a class="el" href="include_2libimobiledevice_2mobile__image__mounter_8h.html#e7690ee36890c0c64933107e86c1ab0f">mobile_image_mounter_client_t</a> *&nbsp;</td>
 
281
          <td class="paramtype"><a class="el" href="structmobile__image__mounter__client__private.html">mobile_image_mounter_client_t</a> *&nbsp;</td>
299
282
          <td class="paramname"> <em>client</em></td><td>&nbsp;</td>
300
283
        </tr>
301
284
        <tr>
307
290
</div>
308
291
<div class="memdoc">
309
292
 
310
 
<p>
311
 
Connects to the mobile_image_mounter service on the specified device. 
312
 
<p>
313
 
<dl compact><dt><b>Parameters:</b></dt><dd>
 
293
<p>Connects to the mobile_image_mounter service on the specified device. </p>
 
294
<dl><dt><b>Parameters:</b></dt><dd>
314
295
  <table border="0" cellspacing="2" cellpadding="0">
315
296
    <tr><td valign="top"></td><td valign="top"><em>device</em>&nbsp;</td><td>The device to connect to. </td></tr>
316
297
    <tr><td valign="top"></td><td valign="top"><em>port</em>&nbsp;</td><td>Destination port (usually given by lockdownd_start_service). </td></tr>
317
298
    <tr><td valign="top"></td><td valign="top"><em>client</em>&nbsp;</td><td>Pointer that will be set to a newly allocated mobile_image_mounter_client_t upon successful return.</td></tr>
318
299
  </table>
 
300
  </dd>
319
301
</dl>
320
 
<dl class="return" compact><dt><b>Returns:</b></dt><dd>MOBILE_IMAGE_MOUNTER_E_SUCCESS on success, MOBILE_IMAGE_MOUNTER_E_INVALID_ARG if device is NULL, or MOBILE_IMAGE_MOUNTER_E_CONN_FAILED if the connection to the device could not be established. </dd></dl>
 
302
<dl class="return"><dt><b>Returns:</b></dt><dd>MOBILE_IMAGE_MOUNTER_E_SUCCESS on success, MOBILE_IMAGE_MOUNTER_E_INVALID_ARG if device is NULL, or MOBILE_IMAGE_MOUNTER_E_CONN_FAILED if the connection to the device could not be established. </dd></dl>
321
303
 
322
304
</div>
323
 
</div><p>
324
 
</div>
325
 
<hr size="1"><address style="text-align: right;"><small><a href="http://www.doxygen.org/index.html">
326
 
<img src="doxygen.png" alt="doxygen" align="middle" border="0"></a> </small></address>
 
305
</div>
 
306
</div>
 
307
<hr class="footer"/><address style="text-align: right;"><small>Generated on Sat Nov 27 19:58:07 2010 for libimobiledevice by&nbsp;
 
308
<a href="http://www.doxygen.org/index.html">
 
309
<img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.6.3 </small></address>
327
310
</body>
328
311
</html>