|
Server : Apache/2.2.17 (Unix) mod_ssl/2.2.17 OpenSSL/0.9.8e-fips-rhel5 DAV/2 PHP/5.2.17 System : Linux localhost 2.6.18-419.el5 #1 SMP Fri Feb 24 22:47:42 UTC 2017 x86_64 User : nobody ( 99) PHP Version : 5.2.17 Disable Function : NONE Directory : /proc/21585/root/usr/share/gtk-doc/html/libgnome/ |
Upload File : |
<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=US-ASCII">
<title>gnome-url</title>
<meta name="generator" content="DocBook XSL Stylesheets V1.69.1">
<link rel="start" href="index.html" title="GNOME Library Reference Manual">
<link rel="up" href="ch01s03.html" title="Displaying help and external info">
<link rel="prev" href="libgnome-gnome-help.html" title="gnome-help">
<link rel="next" href="libgnome-gnome-score.html" title="gnome-score">
<meta name="generator" content="GTK-Doc V1.7 (XML mode)">
<link rel="stylesheet" href="style.css" type="text/css">
<link rel="chapter" href="libgnome.html" title="GNOME Library (libgnome)">
</head>
<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
<table class="navigation" id="top" width="100%" summary="Navigation header" cellpadding="2" cellspacing="2">
<tr valign="middle">
<td><a accesskey="p" href="libgnome-gnome-help.html"><img src="left.png" width="24" height="24" border="0" alt="Prev"></a></td>
<td><a accesskey="u" href="ch01s03.html"><img src="up.png" width="24" height="24" border="0" alt="Up"></a></td>
<td><a accesskey="h" href="index.html"><img src="home.png" width="24" height="24" border="0" alt="Home"></a></td>
<th width="100%" align="center">GNOME Library Reference Manual</th>
<td><a accesskey="n" href="libgnome-gnome-score.html"><img src="right.png" width="24" height="24" border="0" alt="Next"></a></td>
</tr>
<tr><td colspan="5" class="shortcuts"><nobr><a href="#id2819442" class="shortcut">Top</a>
 | 
<a href="#id2819537" class="shortcut">Description</a></nobr></td></tr>
</table>
<div class="refentry" lang="en">
<a name="libgnome-gnome-url"></a><div class="titlepage"></div>
<div class="refnamediv"><table width="100%"><tr>
<td valign="top">
<h2>
<a name="id2819442"></a><span class="refentrytitle">gnome-url</span>
</h2>
<p>gnome-url — Display urls using appropriate viewers.</p>
</td>
<td valign="top" align="right"></td>
</tr></table></div>
<div class="refsynopsisdiv">
<h2>Synopsis</h2>
<pre class="synopsis">
#include <libgnome/libgnome.h>
enum <a href="libgnome-gnome-url.html#GnomeURLError">GnomeURLError</a>;
#define <a href="libgnome-gnome-url.html#GNOME-URL-ERROR:CAPS">GNOME_URL_ERROR</a>
<a
href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gboolean"
>gboolean</a> <a href="libgnome-gnome-url.html#gnome-url-show">gnome_url_show</a> (const char *url,
<a
href="/usr/share/gtk-doc/html/glib/glib-Error-Reporting.html#GError"
>GError</a> **error);
<a
href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gboolean"
>gboolean</a> <a href="libgnome-gnome-url.html#gnome-url-show-with-env">gnome_url_show_with_env</a> (const char *url,
char **envp,
<a
href="/usr/share/gtk-doc/html/glib/glib-Error-Reporting.html#GError"
>GError</a> **error);
</pre>
</div>
<div class="refsect1" lang="en">
<a name="id2819537"></a><h2>Description</h2>
<p>
A GNOME user can configure which viewers they wish to use to view certain
protocols. Protocols can include http, ftp (where "view" might mean
"download"), ghelp, etc. This module provides a means for application to
display a url without having to worry about which viewer is going to ultimately
handle the job.
</p>
</div>
<div class="refsect1" lang="en">
<a name="id2819557"></a><h2>Details</h2>
<div class="refsect2" lang="en">
<a name="id2819567"></a><h3>
<a name="GnomeURLError"></a>enum GnomeURLError</h3>
<a class="indexterm" name="id2819580"></a><pre class="programlisting">typedef enum {
GNOME_URL_ERROR_PARSE,
GNOME_URL_ERROR_LAUNCH,
GNOME_URL_ERROR_URL,
GNOME_URL_ERROR_NO_DEFAULT,
GNOME_URL_ERROR_NOT_SUPPORTED,
GNOME_URL_ERROR_VFS,
GNOME_URL_ERROR_CANCELLED
} GnomeURLError;
</pre>
<p>
The errors that can be returned due to bad parameters being pass to
<a href="libgnome-gnome-url.html#gnome-url-show"><code class="function">gnome_url_show()</code></a>.</p>
<p>
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td>
<span class="term"><a name="GNOME-URL-ERROR-PARSE:CAPS"></a><code class="literal">GNOME_URL_ERROR_PARSE</code></span></td>
<td> The parsing of the handler failed.
</td>
</tr>
<tr>
<td>
<span class="term"><a name="GNOME-URL-ERROR-LAUNCH:CAPS"></a><code class="literal">GNOME_URL_ERROR_LAUNCH</code></span></td>
<td>
</td>
</tr>
<tr>
<td>
<span class="term"><a name="GNOME-URL-ERROR-URL:CAPS"></a><code class="literal">GNOME_URL_ERROR_URL</code></span></td>
<td>
</td>
</tr>
<tr>
<td>
<span class="term"><a name="GNOME-URL-ERROR-NO-DEFAULT:CAPS"></a><code class="literal">GNOME_URL_ERROR_NO_DEFAULT</code></span></td>
<td>
</td>
</tr>
<tr>
<td>
<span class="term"><a name="GNOME-URL-ERROR-NOT-SUPPORTED:CAPS"></a><code class="literal">GNOME_URL_ERROR_NOT_SUPPORTED</code></span></td>
<td>
</td>
</tr>
<tr>
<td>
<span class="term"><a name="GNOME-URL-ERROR-VFS:CAPS"></a><code class="literal">GNOME_URL_ERROR_VFS</code></span></td>
<td>
</td>
</tr>
<tr>
<td>
<span class="term"><a name="GNOME-URL-ERROR-CANCELLED:CAPS"></a><code class="literal">GNOME_URL_ERROR_CANCELLED</code></span></td>
<td>
</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="id2819774"></a><h3>
<a name="GNOME-URL-ERROR:CAPS"></a>GNOME_URL_ERROR</h3>
<a class="indexterm" name="id2819788"></a><pre class="programlisting">#define GNOME_URL_ERROR (gnome_url_error_quark ())
</pre>
<p>
The class (domain) of errors raised by this module.
</p>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="id2819804"></a><h3>
<a name="gnome-url-show"></a>gnome_url_show ()</h3>
<a class="indexterm" name="id2819817"></a><pre class="programlisting"><a
href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gboolean"
>gboolean</a> gnome_url_show (const char *url,
<a
href="/usr/share/gtk-doc/html/glib/glib-Error-Reporting.html#GError"
>GError</a> **error);</pre>
<p>
Once the input has been converted into a fully qualified url this function
calls gnome_vfs_url_show. Any error codes returned by gnome-vfs will be wrapped
in the error parameter. All errors comes from the <a href="libgnome-gnome-url.html#GNOME-URL-ERROR:CAPS"><code class="literal">GNOME_URL_ERROR</code></a>% domain.</p>
<p>
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td>
<span class="term"><em class="parameter"><code>url</code></em> :</span></td>
<td> The url or path to display. The path can be relative to the current working
directory or the user's home directory. This function will convert it into a fully
qualified url using the gnome_url_get_from_input function.
</td>
</tr>
<tr>
<td>
<span class="term"><em class="parameter"><code>error</code></em> :</span></td>
<td> Used to store any errors that result from trying to display the <em class="parameter"><code>url</code></em>.
</td>
</tr>
<tr>
<td>
<span class="term"><span class="emphasis"><em>Returns</em></span> :</span></td>
<td> <a
href="/usr/share/gtk-doc/html/glib/glib-Standard-Macros.html#TRUE:CAPS"
><code class="literal">TRUE</code></a> if everything went fine, <a
href="/usr/share/gtk-doc/html/glib/glib-Standard-Macros.html#FALSE:CAPS"
><code class="literal">FALSE</code></a> otherwise (in which case
<em class="parameter"><code>error</code></em> will contain the actual error).
</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="id2819948"></a><h3>
<a name="gnome-url-show-with-env"></a>gnome_url_show_with_env ()</h3>
<a class="indexterm" name="id2819964"></a><pre class="programlisting"><a
href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gboolean"
>gboolean</a> gnome_url_show_with_env (const char *url,
char **envp,
<a
href="/usr/share/gtk-doc/html/glib/glib-Error-Reporting.html#GError"
>GError</a> **error);</pre>
<p>
Like <a href="libgnome-gnome-url.html#gnome-url-show"><code class="function">gnome_url_show()</code></a>, but gnome_vfs_url_show_with_env
will be called with the given envirnoment.</p>
<p>
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td>
<span class="term"><em class="parameter"><code>url</code></em> :</span></td>
<td> The url or path to display.
</td>
</tr>
<tr>
<td>
<span class="term"><em class="parameter"><code>envp</code></em> :</span></td>
<td> child's environment, or <a
href="/usr/share/gtk-doc/html/liboil/liboil-liboiljunk.html#NULL:CAPS"
><code class="literal">NULL</code></a> to inherit parent's.
</td>
</tr>
<tr>
<td>
<span class="term"><em class="parameter"><code>error</code></em> :</span></td>
<td> Used to store any errors that result from trying to display the <em class="parameter"><code>url</code></em>.
</td>
</tr>
<tr>
<td>
<span class="term"><span class="emphasis"><em>Returns</em></span> :</span></td>
<td> <a
href="/usr/share/gtk-doc/html/glib/glib-Standard-Macros.html#TRUE:CAPS"
><code class="literal">TRUE</code></a> if everything went fine, <a
href="/usr/share/gtk-doc/html/glib/glib-Standard-Macros.html#FALSE:CAPS"
><code class="literal">FALSE</code></a> otherwise (in which case
<em class="parameter"><code>error</code></em> will contain the actual error).
</td>
</tr>
</tbody>
</table></div>
<p>Since 2.2
</p>
</div>
</div>
</div>
</body>
</html>