~ubuntu-branches/ubuntu/natty/gnome-vfs/natty

enum <a class="link" href="gnome-vfs-2.0-gnome-vfs-directory-find-ops.html#GnomeVFSFindDirectoryKind" title="enum GnomeVFSFindDirectoryKind">GnomeVFSFindDirectoryKind</a>;

<a class="link" href="gnome-vfs-2.0-gnome-vfs-result.html#GnomeVFSResult" title="enum GnomeVFSResult">GnomeVFSResult</a> <a class="link" href="gnome-vfs-2.0-gnome-vfs-directory-find-ops.html#gnome-vfs-find-directory" title="gnome_vfs_find_directory ()">gnome_vfs_find_directory</a> (<a class="link" href="gnome-vfs-2.0-gnome-vfs-uri.html#GnomeVFSURI" title="GnomeVFSURI">GnomeVFSURI</a> *near_uri,

<a class="link" href="gnome-vfs-2.0-gnome-vfs-directory-find-ops.html#GnomeVFSFindDirectoryKind" title="enum GnomeVFSFindDirectoryKind">GnomeVFSFindDirectoryKind</a> kind,

<a class="link" href="gnome-vfs-2.0-gnome-vfs-uri.html#GnomeVFSURI" title="GnomeVFSURI">GnomeVFSURI</a> **result,

gboolean create_if_needed,

gboolean find_if_needed,

guint permissions);

</pre>

</div>

<a name="gnome-vfs-2.0-gnome-vfs-directory-find-ops.description"></a><h2>Description</h2>

<p>

</p>

</div>

<a name="gnome-vfs-2.0-gnome-vfs-directory-find-ops.details"></a><h2>Details</h2>

<a name="GnomeVFSFindDirectoryKind"></a><h3>enum GnomeVFSFindDirectoryKind</h3>

<pre class="programlisting">typedef enum {

GNOME_VFS_DIRECTORY_KIND_DESKTOP = 1000,

GNOME_VFS_DIRECTORY_KIND_TRASH = 1001

} GnomeVFSFindDirectoryKind;

</pre>

<p>

Specifies what directory <a class="link" href="gnome-vfs-2.0-gnome-vfs-directory-find-ops.html#gnome-vfs-find-directory" title="gnome_vfs_find_directory ()"><code class="function">gnome_vfs_find_directory()</code></a> or

<code class="function">gnome_vfs_find_directory_cancellable()</code> should find.</p>

<p>

</p>

<tbody>

<tr>

<td><p><a name="GNOME-VFS-DIRECTORY-KIND-DESKTOP:CAPS"></a><span class="term"><code class="literal">GNOME_VFS_DIRECTORY_KIND_DESKTOP</code></span></p></td>

<td> Desktop directory.

</td>

</tr>

<tr>

<td><p><a name="GNOME-VFS-DIRECTORY-KIND-TRASH:CAPS"></a><span class="term"><code class="literal">GNOME_VFS_DIRECTORY_KIND_TRASH</code></span></p></td>

<td> Trash directory.

</td>

</tr>

</tbody>

</table></div>

</div>

<hr>

<a name="gnome-vfs-find-directory"></a><h3>gnome_vfs_find_directory ()</h3>

<pre class="programlisting"><a class="link" href="gnome-vfs-2.0-gnome-vfs-result.html#GnomeVFSResult" title="enum GnomeVFSResult">GnomeVFSResult</a> gnome_vfs_find_directory (<a class="link" href="gnome-vfs-2.0-gnome-vfs-uri.html#GnomeVFSURI" title="GnomeVFSURI">GnomeVFSURI</a> *near_uri,

<a class="link" href="gnome-vfs-2.0-gnome-vfs-directory-find-ops.html#GnomeVFSFindDirectoryKind" title="enum GnomeVFSFindDirectoryKind">GnomeVFSFindDirectoryKind</a> kind,

100

<a class="link" href="gnome-vfs-2.0-gnome-vfs-uri.html#GnomeVFSURI" title="GnomeVFSURI">GnomeVFSURI</a> **result,

101

gboolean create_if_needed,

102

gboolean find_if_needed,

103

guint permissions);</pre>

104

<p>

105

Used to return well known directories such as Trash, Desktop, etc. from different

106

file systems.

107

</p>

108

<p>

109

There is quite a complicated logic behind finding/creating a Trash directory

110

and you need to be aware of some implications:

111

Finding the Trash the first time when using the file method may be pretty

112

expensive. A cache file is used to store the location of that Trash file

113

for next time.

114

If <em class="parameter"><code>create_if_needed</code></em> is specified without <em class="parameter"><code>find_if_needed</code></em>, you may end up

115

creating a Trash file when there already is one. Your app should start out

116

by doing a <a class="link" href="gnome-vfs-2.0-gnome-vfs-directory-find-ops.html#gnome-vfs-find-directory" title="gnome_vfs_find_directory ()"><code class="function">gnome_vfs_find_directory()</code></a> with the <em class="parameter"><code>find_if_needed</code></em> to avoid this

117

and then use the <em class="parameter"><code>create_if_needed</code></em> flag to create Trash lazily when it is

118

needed for throwing away an item on a given disk.</p>

119

<p>

120

</p>

121

122

123

<tbody>

124

<tr>

125

126

<td> find a well known directory on the same volume as <em class="parameter"><code>near_uri</code></em>.

127

</td>

128

</tr>

129

<tr>

130

131

<td> kind of well known directory.

132

</td>

133

</tr>

134

<tr>

135

<td><p><span class="term"><em class="parameter"><code>result</code></em> :</span></p></td>

136

<td> newly created uri of the directory we found.

137

</td>

138

</tr>

139

<tr>

140

<td><p><span class="term"><em class="parameter"><code>create_if_needed</code></em> :</span></p></td>

141

<td> if directory we are looking for does not exist, try to create it.

142

</td>

143

</tr>

144

<tr>

145

<td><p><span class="term"><em class="parameter"><code>find_if_needed</code></em> :</span></p></td>

146

<td> if we don't know where directory is yet, look for it.

147

</td>

148

</tr>

149

<tr>

150

<td><p><span class="term"><em class="parameter"><code>permissions</code></em> :</span></p></td>

151

<td> if creating, use these permissions.

152

</td>

153

</tr>

154

<tr>

155

<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>

156

<td> an integer representing the result of the operation.

157

</td>

158

</tr>

159

</tbody>

160

</table></div>

161

</div>

162

</div>

163

</div>

164

165

<hr>

166

Generated by GTK-Doc V1.12</div>

167

</body>

168

</html>

Older »