File: guestfs-erlang.pod

package info (click to toggle)
libguestfs 1%3A1.18.1-1%2Bdeb7u3
  • links: PTS, VCS
  • area: main
  • in suites: wheezy
  • size: 49,156 kB
  • sloc: ansic: 282,408; ml: 22,707; sh: 16,121; perl: 5,946; java: 5,047; cs: 4,329; makefile: 3,191; haskell: 2,564; erlang: 1,510; python: 1,502; xml: 509; ruby: 217; pascal: 142; cpp: 11
file content (125 lines) | stat: -rw-r--r-- 3,850 bytes parent folder | download
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
=encoding utf8

=head1 名前

guestfs-erlang - Erlang から libguestfs を使用する方法

=head1 書式

 {ok, G} = guestfs:create(),
 ok = guestfs:add_drive_opts(G, Disk,
                             [{format, "raw"}, {readonly, true}]),
 ok = guestfs:launch(G),
 [Device] = guestfs:list_devices(G),
 ok = guestfs:close(G).

=head1 説明

This manual page documents how to call libguestfs from the Erlang
programming language.  This page just documents the differences from the C
API and gives some examples.  If you are not familiar with using libguestfs,
you also need to read L<guestfs(3)>.

=head2 OPENING AND CLOSING THE HANDLE

The Erlang bindings are implemented using an external program called
C<erl-guestfs>.  This program must be on the current PATH, or else you
should specify the full path to the program:

 {ok, G} = guestfs:create().

 {ok, G} = guestfs:create("/path/to/erl-guestfs").

C<G> is the libguestfs handle which you should pass to other functions.

ハンドルを閉じるには:

 ok = guestfs:close(G).

=head2 FUNCTIONS WITH OPTIONAL ARGUMENTS

For functions that take optional arguments, the first arguments are the
non-optional ones.  The last argument is a list of tuples supplying the
remaining optional arguments.

 ok = guestfs:add_drive_opts(G, Disk,
                             [{format, "raw"}, {readonly, true}]).

最後の引数が空の一覧ならば、それを省略できます:

 ok = guestfs:add_drive_opts(G, Disk).

=head2 返り値およびエラー

On success, most functions return a C<Result> term (which could be a list,
string, tuple etc.).  If there is nothing for the function to return, then
the atom C<ok> is returned.

エラーが発生すると、以下の組のどれかが表示されます:

=over 4

=item C<{error, Msg, Errno}>

これは関数からの通常のエラーを意味します。

C<Msg> はエラーメッセージ(文字列)です。C<Errno> は Unix エラー(整数)です。

C<Errno> は 0 の可能性があります。 L<guestfs(3)/guestfs_last_errno> 参照。

=item C<{unknown, Function}>

This indicates that the function you called is not known.  Generally this
means you are mixing C<erl-guestfs> from another version of libguestfs,
which you should not do.

C<Function> は未知の関数の名前です。

=item C<{unknownarg, Arg}>

This indicates that you called a function with optional arguments, with an
unknown argument name.

C<Arg> is the name of the unknown argument.

=back

=head1 例 1: ディスクイメージの作成

@EXAMPLE1@

=head1 例 2: 仮想マシンのディスクイメージの検査

@EXAMPLE2@

=head1 関連項目

L<guestfs(3)>, L<guestfs-examples(3)>, L<guestfs-java(3)>,
L<guestfs-ocaml(3)>, L<guestfs-perl(3)>, L<guestfs-python(3)>,
L<guestfs-recipes(1)>, L<guestfs-ruby(3)>, L<http://www.erlang.org/>.
L<http://libguestfs.org/>。

=head1 著者

Richard W.M. Jones (C<rjones at redhat dot com>)

=head1 COPYRIGHT

Copyright (C) 2011 Red Hat Inc. L<http://libguestfs.org/>

このマニュアルページにある例は、なんら制限なく自由にコピー、修正、配布できます。

This library is free software; you can redistribute it and/or modify it
under the terms of the GNU Lesser General Public License as published by the
Free Software Foundation; either version 2 of the License, or (at your
option) any later version.

This library is distributed in the hope that it will be useful, but WITHOUT
ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
FITNESS FOR A PARTICULAR PURPOSE.  See the GNU Lesser General Public License
for more details.

You should have received a copy of the GNU Lesser General Public License
along with this library; if not, write to the Free Software Foundation,
Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA