GtkSharp/doc/en/Gnome.Vfs/Vfs.xml

<Type Name="Vfs" FullName="Gnome.Vfs.Vfs">
  <TypeSignature Language="C#" Value="public class Vfs" Maintainer="auto" />
  <AssemblyInfo>
    <AssemblyName>gnome-vfs-sharp</AssemblyName>
    <AssemblyPublicKey>[00 24 00 00 04 80 00 00 94 00 00 00 06 02 00 00 00 24 00 00 52 53 41 31 00 04 00 00 01 00 01 00 71 EB 6C 55 75 52 9C BF 72 44 F7 A6 EA 05 62 84 F9 EA E0 3B CF F2 CC 13 2C 9C 49 0A B3 09 EA B0 B5 6B CE 44 9D F5 03 D9 C0 A8 1E 52 05 85 CD BE 70 E2 FB 90 43 4B AC 04 FA 62 22 A8 00 98 B7 A1 A7 B3 AF 99 1A 41 23 24 BB 43 25 F6 B8 65 BB 64 EB F6 D1 C2 06 D5 73 2D DF BC 70 A7 38 9E E5 3E 0C 24 6E 32 79 74 1A D0 05 03 E4 98 42 E1 9B F3 7B 19 8B 40 21 26 CB 36 89 C2 EA 64 96 A4 7C B4]</AssemblyPublicKey>
    <AssemblyVersion>2.0.0.0</AssemblyVersion>
    <AssemblyCulture>neutral</AssemblyCulture>
    <Attributes />
  </AssemblyInfo>
  <ThreadSafetyStatement>Gtk# is thread aware, but not thread safe; See the <link location="node:gtk-sharp/programming/threads">Gtk# Thread Programming</link> for details.</ThreadSafetyStatement>
  <Docs>
    <summary>Common VFS tasks, including initialization &amp; shutdown of the GNOME Virtual File System.</summary>
    <remarks>To be added</remarks>
  </Docs>
  <Base>
    <BaseTypeName>System.Object</BaseTypeName>
  </Base>
  <Interfaces />
  <Attributes />
  <Members>
    <Member MemberName="Initialize">
      <MemberSignature Language="C#" Value="public static bool Initialize ();" />
      <MemberType>Method</MemberType>
      <ReturnValue>
        <ReturnType>System.Boolean</ReturnType>
      </ReturnValue>
      <Parameters />
      <Docs>
        <summary>If Gnome.Vfs is not already initialized, initialize it. This must be called prior to performing any other Gnome.Vfs operations, and may be called multiple times without error.</summary>
        <returns>true if Gnome.Vfs was succesfully initialized or was already initialized.</returns>
        <remarks>To be added</remarks>
      </Docs>
    </Member>
    <Member MemberName="Move">
      <MemberSignature Language="C#" Value="public static Gnome.Vfs.Result Move (string source, string dest, bool force_replace);" />
      <MemberType>Method</MemberType>
      <ReturnValue>
        <ReturnType>Gnome.Vfs.Result</ReturnType>
      </ReturnValue>
      <Parameters>
        <Parameter Name="source" Type="System.String" />
        <Parameter Name="dest" Type="System.String" />
        <Parameter Name="force_replace" Type="System.Boolean" />
      </Parameters>
      <Docs>
        <summary>Move a file from source to dest.  This will only work if source and dest are on the same file system.  Otherwise, it is necessary to use the more general <see cref="M:Gnome.Vfs.Xfer.XferUri" /> function.</summary>
        <param name="source">source <see cref="T:Gnome.Vfs.Uri" />.</param>
        <param name="dest">destination <see cref="T:Gnome.Vfs.Uri" />.</param>
        <param name="force_replace">If true, move target to new_uri even if there is already a file at new_uri. If there is a file, it will be discarded.</param>
        <returns>a <see cref="T:Gnome.Vfs.Result" /></returns>
        <remarks>To be added</remarks>
      </Docs>
    </Member>
    <Member MemberName="ResultToString">
      <MemberSignature Language="C#" Value="public static string ResultToString (Gnome.Vfs.Result result);" />
      <MemberType>Method</MemberType>
      <ReturnValue>
        <ReturnType>System.String</ReturnType>
      </ReturnValue>
      <Parameters>
        <Parameter Name="result" Type="Gnome.Vfs.Result" />
      </Parameters>
      <Docs>
        <summary>Returns a string representation of <see cref="T:Gnome.Vfs.Result" />, useful for debugging purposes, but probably not appropriate for passing to the user.</summary>
        <param name="result">a <see cref="T:Gnome.Vfs.Result" /> value.</param>
        <returns>a <see cref="T:System.String" /></returns>
        <remarks>To be added</remarks>
      </Docs>
    </Member>
    <Member MemberName="ThrowException">
      <MemberSignature Language="C#" Value="public static void ThrowException (Gnome.Vfs.Result result);" />
      <MemberType>Method</MemberType>
      <ReturnValue>
        <ReturnType>System.Void</ReturnType>
      </ReturnValue>
      <Parameters>
        <Parameter Name="result" Type="Gnome.Vfs.Result" />
      </Parameters>
      <Docs>
        <summary>Throws a <see cref="T:Gnome.Vfs.VfsException" /> with the appropriate description if the <see cref="T:Gnome.Vfs.Result" /> is not <see cref="M:Gnome.Vfs.Result.Ok" />.</summary>
        <param name="result">a <see cref="T:System.Int32" /></param>
        <remarks>To be added</remarks>
      </Docs>
    </Member>
    <Member MemberName="ThrowException">
      <MemberSignature Language="C#" Value="public static void ThrowException (Gnome.Vfs.Uri uri, Gnome.Vfs.Result result);" />
      <MemberType>Method</MemberType>
      <ReturnValue>
        <ReturnType>System.Void</ReturnType>
      </ReturnValue>
      <Parameters>
        <Parameter Name="uri" Type="Gnome.Vfs.Uri" />
        <Parameter Name="result" Type="Gnome.Vfs.Result" />
      </Parameters>
      <Docs>
        <summary>Throws a <see cref="T:System.Exception" /> with the appropriate description if the <see cref="T:Gnome.Vfs.Result" /> is not <see cref="M:Gnome.Vfs.Result.Ok" />.</summary>
        <param name="uri">
          <see cref="T:Gnome.Vfs.Uri" /> to which the <see cref="T:Gnome.Vfs.Result" /> pertains.</param>
        <param name="result">
          <see cref="T:Gnome.Vfs.Result" /> return value.</param>
        <remarks>Throws a <see cref="T:System.IO.FileNotFoundException" /> if <see cref="M:Gnome.Vfs.Result.ErrorNotFound" /> is passed. Otherwise a <see cref="T:Gnome.Vfs.VfsException" /> is thrown.</remarks>
      </Docs>
    </Member>
    <Member MemberName="ThrowException">
      <MemberSignature Language="C#" Value="public static void ThrowException (string uri, Gnome.Vfs.Result result);" />
      <MemberType>Method</MemberType>
      <ReturnValue>
        <ReturnType>System.Void</ReturnType>
      </ReturnValue>
      <Parameters>
        <Parameter Name="uri" Type="System.String" />
        <Parameter Name="result" Type="Gnome.Vfs.Result" />
      </Parameters>
      <Docs>
        <summary>Throws a <see cref="T:System.Exception" /> with the appropriate description if the <see cref="T:Gnome.Vfs.Result" /> is not <see cref="M:Gnome.Vfs.Result.Ok" />.</summary>
        <param name="uri">
          <see cref="T:System.String" /> representing the <see cref="T:Gnome.Vfs.Uri" /> in question.</param>
        <param name="result">
          <see cref="T:Gnome.Vfs.Result" /> return value.</param>
        <remarks>Throws a <see cref="T:System.IO.FileNotFoundException" /> if <see cref="M:Gnome.Vfs.Result.ErrorNotFound" /> is passed. Otherwise a <see cref="T:Gnome.Vfs.VfsException" /> is thrown.</remarks>
      </Docs>
    </Member>
    <Member MemberName="Initialized">
      <MemberSignature Language="C#" Value="public static bool Initialized { get; };" />
      <MemberType>Property</MemberType>
      <ReturnValue>
        <ReturnType>System.Boolean</ReturnType>
      </ReturnValue>
      <Parameters />
      <Docs>
        <summary>Returns whether Gnome.Vfs has already been initialized.</summary>
        <returns>a <see cref="T:System.Boolean" /></returns>
        <remarks>Gnome.Vfs must be initialized prior to using any methods or operations.</remarks>
      </Docs>
    </Member>
    <Member MemberName="Shutdown">
      <MemberSignature Language="C#" Value="public static void Shutdown ();" />
      <MemberType>Method</MemberType>
      <ReturnValue>
        <ReturnType>System.Void</ReturnType>
      </ReturnValue>
      <Parameters />
      <Docs>
        <summary>Cease all active Gnome.Vfs operations and unload the Mime database from memory.</summary>
        <remarks>To be added</remarks>
      </Docs>
    </Member>
    <Member MemberName="FormatFileSizeForDisplay">
      <MemberSignature Language="C#" Value="public static string FormatFileSizeForDisplay (long size);" />
      <MemberType>Method</MemberType>
      <ReturnValue>
        <ReturnType>System.String</ReturnType>
      </ReturnValue>
      <Parameters>
        <Parameter Name="size" Type="System.Int64" />
      </Parameters>
      <Docs>
        <summary>Formats the file size parameter in a way that is easy for the user to read. Gives the size in bytes, kilobytes, megabytes or gigabytes, choosing whatever is appropriate.</summary>
        <param name="size">a <see cref="T:System.Int64" /></param>
        <returns>a <see cref="T:System.String" /></returns>
        <remarks>To be added</remarks>
      </Docs>
    </Member>
  </Members>
</Type>