man-pages/man3/Net::DBus::Binding::Message::Error.3pm.html
2021-03-31 01:06:50 +01:00

113 lines
2.7 KiB
HTML

<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<HTML><HEAD><TITLE>Man page of Net::DBus::Binding::Message::Error</TITLE>
</HEAD><BODY>
<H1>Net::DBus::Binding::Message::Error</H1>
Section: User Contributed Perl Documentation (3pm)<BR>Updated: 2019-12-26<BR><A HREF="#index">Index</A>
<A HREF="/cgi-bin/man/man2html">Return to Main Contents</A><HR>
<A NAME="lbAB">&nbsp;</A>
<H2>NAME</H2>
Net::DBus::Binding::Message::Error - a message encoding a method call error
<A NAME="lbAC">&nbsp;</A>
<H2>SYNOPSIS</H2>
<PRE>
use Net::DBus::Binding::Message::Error;
my $error = Net::DBus::Binding::Message::Error-&gt;new(
replyto =&gt; $method_call,
name =&gt; &quot;org.example.myobject.FooException&quot;,
description =&gt; &quot;Unable to do Foo when updating bar&quot;);
$connection-&gt;send($error);
</PRE>
<A NAME="lbAD">&nbsp;</A>
<H2>DESCRIPTION</H2>
This module is part of the low-level DBus binding APIs, and
should not be used by application code. No guarantees are made
about APIs under the <TT>&quot;Net::DBus::Binding::&quot;</TT> namespace being
stable across releases.
<P>
This module provides a convenience constructor for creating
a message representing an error condition.
<A NAME="lbAE">&nbsp;</A>
<H2>METHODS</H2>
<DL COMPACT>
<DT id="1">my $error = Net::DBus::Binding::Message::Error-&gt;new( replyto =&gt; $method_call, name =&gt; $name, description =&gt; $description);<DD>
Creates a new message, representing an error which occurred during
the handling of the method call object passed in as the <TT>&quot;replyto&quot;</TT>
parameter. The <TT>&quot;name&quot;</TT> parameter is the formal name of the error
condition, while the <TT>&quot;description&quot;</TT> is a short piece of text giving
more specific information on the error.
<DT id="2">my $name = $error-&gt;get_error_name<DD>
Returns the formal name of the error, as previously passed in via
the <TT>&quot;name&quot;</TT> parameter in the constructor.
</DL>
<A NAME="lbAF">&nbsp;</A>
<H2>AUTHOR</H2>
Daniel P. Berrange.
<A NAME="lbAG">&nbsp;</A>
<H2>COPYRIGHT</H2>
Copyright (C) 2004-2009 Daniel P. Berrange
<A NAME="lbAH">&nbsp;</A>
<H2>SEE ALSO</H2>
Net::DBus::Binding::Message
<P>
<HR>
<A NAME="index">&nbsp;</A><H2>Index</H2>
<DL>
<DT id="3"><A HREF="#lbAB">NAME</A><DD>
<DT id="4"><A HREF="#lbAC">SYNOPSIS</A><DD>
<DT id="5"><A HREF="#lbAD">DESCRIPTION</A><DD>
<DT id="6"><A HREF="#lbAE">METHODS</A><DD>
<DT id="7"><A HREF="#lbAF">AUTHOR</A><DD>
<DT id="8"><A HREF="#lbAG">COPYRIGHT</A><DD>
<DT id="9"><A HREF="#lbAH">SEE ALSO</A><DD>
</DL>
<HR>
This document was created by
<A HREF="/cgi-bin/man/man2html">man2html</A>,
using the manual pages.<BR>
Time: 00:05:48 GMT, March 31, 2021
</BODY>
</HTML>