doc/tmpl/gnome-vfs-uri.sgml

   1 <!-- ##### SECTION Title ##### -->
   2 GnomeVFSURI
   3
   4 <!-- ##### SECTION Short_Description ##### -->
   5
   6 Functions for manipulating URIs
   7
   8 <!-- ##### SECTION Long_Description ##### -->
   9 <para>
  10
  11 </para>
  12
  13 <!-- ##### SECTION See_Also ##### -->
  14 <para>
  15
  16 </para>
  17
  18 <!-- ##### TYPEDEF GnomeVFSToplevelURI ##### -->
  19 <para>
  20
  21 </para>
  22
  23
  24 <!-- ##### ENUM GnomeVFSURIHideOptions ##### -->
  25 <para>
  26
  27 </para>
  28
  29 @GNOME_VFS_URI_HIDE_NONE:
  30 @GNOME_VFS_URI_HIDE_USER_NAME:
  31 @GNOME_VFS_URI_HIDE_PASSWORD:
  32 @GNOME_VFS_URI_HIDE_HOST_NAME:
  33 @GNOME_VFS_URI_HIDE_HOST_PORT:
  34 @GNOME_VFS_URI_HIDE_TOPLEVEL_METHOD:
  35 @GNOME_VFS_URI_HIDE_FRAGMENT_IDENTIFIER:
  36
  37 <!-- ##### MACRO GNOME_VFS_URI_MAGIC_CHR ##### -->
  38 <para>
  39
  40 </para>
  41
  42
  43
  44 <!-- ##### MACRO GNOME_VFS_URI_MAGIC_STR ##### -->
  45 <para>
  46
  47 </para>
  48
  49
  50
  51 <!-- ##### MACRO GNOME_VFS_URI_PATH_CHR ##### -->
  52 <para>
  53
  54 </para>
  55
  56
  57
  58 <!-- ##### MACRO GNOME_VFS_URI_PATH_STR ##### -->
  59 <para>
  60
  61 </para>
  62
  63
  64
  65 <!-- ##### FUNCTION gnome_vfs_uri_new ##### -->
  66 <para>
  67
  68 </para>
  69
  70 @text_uri:
  71 @Returns:
  72
  73
  74 <!-- ##### FUNCTION gnome_vfs_uri_resolve_relative ##### -->
  75 <para>
  76
  77 </para>
  78
  79 @base:
  80 @relative_reference:
  81 @Returns:
  82
  83
  84 <!-- ##### FUNCTION gnome_vfs_uri_ref ##### -->
  85 <para>
  86
  87 </para>
  88
  89 @uri:
  90 @Returns:
  91
  92
  93 <!-- ##### FUNCTION gnome_vfs_uri_unref ##### -->
  94 <para>
  95
  96 </para>
  97
  98 @uri:
  99
 100
 101 <!-- ##### FUNCTION gnome_vfs_uri_append_string ##### -->
 102 <para>
 103
 104 </para>
 105
 106 @uri:
 107 @uri_fragment:
 108 @Returns:
 109
 110
 111 <!-- ##### FUNCTION gnome_vfs_uri_append_path ##### -->
 112 <para>
 113
 114 </para>
 115
 116 @uri:
 117 @path:
 118 @Returns:
 119
 120
 121 <!-- ##### FUNCTION gnome_vfs_uri_append_file_name ##### -->
 122 <para>
 123
 124 </para>
 125
 126 @uri:
 127 @filename:
 128 @Returns:
 129
 130
 131 <!-- ##### FUNCTION gnome_vfs_uri_to_string ##### -->
 132 <para>
 133
 134 </para>
 135
 136 @uri:
 137 @hide_options:
 138 @Returns:
 139
 140
 141 <!-- ##### FUNCTION gnome_vfs_uri_dup ##### -->
 142 <para>
 143
 144 </para>
 145
 146 @uri:
 147 @Returns:
 148
 149
 150 <!-- ##### FUNCTION gnome_vfs_uri_is_local ##### -->
 151 <para>
 152
 153 </para>
 154
 155 @uri:
 156 @Returns:
 157
 158
 159 <!-- ##### FUNCTION gnome_vfs_uri_has_parent ##### -->
 160 <para>
 161
 162 </para>
 163
 164 @uri:
 165 @Returns:
 166
 167
 168 <!-- ##### FUNCTION gnome_vfs_uri_get_parent ##### -->
 169 <para>
 170
 171 </para>
 172
 173 @uri:
 174 @Returns:
 175
 176
 177 <!-- ##### FUNCTION gnome_vfs_uri_get_toplevel ##### -->
 178 <para>
 179
 180 </para>
 181
 182 @uri:
 183 @Returns:
 184
 185
 186 <!-- ##### FUNCTION gnome_vfs_uri_get_host_name ##### -->
 187 <para>
 188
 189 </para>
 190
 191 @uri:
 192 @Returns:
 193
 194
 195 <!-- ##### FUNCTION gnome_vfs_uri_get_scheme ##### -->
 196 <para>
 197
 198 </para>
 199
 200 @uri:
 201 @Returns:
 202
 203
 204 <!-- ##### FUNCTION gnome_vfs_uri_get_host_port ##### -->
 205 <para>
 206
 207 </para>
 208
 209 @uri:
 210 @Returns:
 211
 212
 213 <!-- ##### FUNCTION gnome_vfs_uri_get_user_name ##### -->
 214 <para>
 215
 216 </para>
 217
 218 @uri:
 219 @Returns:
 220
 221
 222 <!-- ##### FUNCTION gnome_vfs_uri_get_password ##### -->
 223 <para>
 224
 225 </para>
 226
 227 @uri:
 228 @Returns:
 229
 230
 231 <!-- ##### FUNCTION gnome_vfs_uri_set_host_name ##### -->
 232 <para>
 233
 234 </para>
 235
 236 @uri:
 237 @host_name:
 238
 239
 240 <!-- ##### FUNCTION gnome_vfs_uri_set_host_port ##### -->
 241 <para>
 242
 243 </para>
 244
 245 @uri:
 246 @host_port:
 247
 248
 249 <!-- ##### FUNCTION gnome_vfs_uri_set_user_name ##### -->
 250 <para>
 251
 252 </para>
 253
 254 @uri:
 255 @user_name:
 256
 257
 258 <!-- ##### FUNCTION gnome_vfs_uri_set_password ##### -->
 259 <para>
 260
 261 </para>
 262
 263 @uri:
 264 @password:
 265
 266
 267 <!-- ##### FUNCTION gnome_vfs_uri_equal ##### -->
 268 <para>
 269
 270 </para>
 271
 272 @a:
 273 @b:
 274 @Returns:
 275
 276
 277 <!-- ##### FUNCTION gnome_vfs_uri_is_parent ##### -->
 278 <para>
 279
 280 </para>
 281
 282 @possible_parent:
 283 @possible_child:
 284 @recursive:
 285 @Returns:
 286
 287
 288 <!-- ##### FUNCTION gnome_vfs_uri_get_path ##### -->
 289 <para>
 290
 291 </para>
 292
 293 @uri:
 294 @Returns:
 295
 296
 297 <!-- ##### FUNCTION gnome_vfs_uri_get_fragment_identifier ##### -->
 298 <para>
 299
 300 </para>
 301
 302 @uri:
 303 @Returns:
 304
 305
 306 <!-- ##### FUNCTION gnome_vfs_uri_extract_dirname ##### -->
 307 <para>
 308
 309 </para>
 310
 311 @uri:
 312 @Returns:
 313
 314
 315 <!-- ##### FUNCTION gnome_vfs_uri_extract_short_name ##### -->
 316 <para>
 317
 318 </para>
 319
 320 @uri:
 321 @Returns:
 322
 323
 324 <!-- ##### FUNCTION gnome_vfs_uri_extract_short_path_name ##### -->
 325 <para>
 326
 327 </para>
 328
 329 @uri:
 330 @Returns:
 331
 332
 333 <!-- ##### FUNCTION gnome_vfs_uri_hequal ##### -->
 334 <para>
 335
 336 </para>
 337
 338 @a:
 339 @b:
 340 @Returns:
 341
 342
 343 <!-- ##### FUNCTION gnome_vfs_uri_hash ##### -->
 344 <para>
 345
 346 </para>
 347
 348 @p:
 349 @Returns:
 350
 351
 352 <!-- ##### FUNCTION gnome_vfs_uri_list_parse ##### -->
 353 <para>
 354
 355 </para>
 356
 357 @uri_list:
 358 @Returns:
 359
 360
 361 <!-- ##### FUNCTION gnome_vfs_uri_list_ref ##### -->
 362 <para>
 363
 364 </para>
 365
 366 @list:
 367 @Returns:
 368
 369
 370 <!-- ##### FUNCTION gnome_vfs_uri_list_unref ##### -->
 371 <para>
 372
 373 </para>
 374
 375 @list:
 376 @Returns:
 377
 378
 379 <!-- ##### FUNCTION gnome_vfs_uri_list_copy ##### -->
 380 <para>
 381
 382 </para>
 383
 384 @list:
 385 @Returns:
 386
 387
 388 <!-- ##### FUNCTION gnome_vfs_uri_list_free ##### -->
 389 <para>
 390
 391 </para>
 392
 393 @list:
 394
 395
 396 <!-- ##### FUNCTION gnome_vfs_uri_make_full_from_relative ##### -->
 397 <para>
 398
 399 </para>
 400
 401 @base_uri:
 402 @relative_uri:
 403 @Returns:
 404
 405