GtkSharp/doc/en/Gnome.Vfs/FileInfo.xml
Mike Kestner a4a90e0797 2005-08-23 Mike Kestner <mkestner@novell.com>
* parser/gapi2xml.pl : handle foo const * fields.
	* gnome/gnome-api-2.10.raw : regen.

svn path=/trunk/gtk-sharp/; revision=48745
2005-08-23 17:02:47 +00:00

425 lines
16 KiB
XML

<Type Name="FileInfo" FullName="Gnome.Vfs.FileInfo">
<TypeSignature Language="C#" Value="public class FileInfo" 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.6.0.0</AssemblyVersion>
</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>Class containing all metadata pertaining to a <see cref="T:Gnome.Vfs.Uri" />.</summary>
<remarks>To be added</remarks>
</Docs>
<Base>
<BaseTypeName>System.Object</BaseTypeName>
</Base>
<Interfaces />
<Members>
<Member MemberName=".ctor">
<MemberSignature Language="C#" Value="public FileInfo (string uri);" />
<MemberType>Constructor</MemberType>
<ReturnValue />
<Parameters>
<Parameter Name="uri" Type="System.String" />
</Parameters>
<Docs>
<summary>Create a new FileInfo instance representing the text uri.</summary>
<param name="uri">
<see cref="T:System.String" /> representing the uri.</param>
<remarks>To be added</remarks>
</Docs>
</Member>
<Member MemberName=".ctor">
<MemberSignature Language="C#" Value="public FileInfo (string uri, Gnome.Vfs.FileInfoOptions options);" />
<MemberType>Constructor</MemberType>
<ReturnValue />
<Parameters>
<Parameter Name="uri" Type="System.String" />
<Parameter Name="options" Type="Gnome.Vfs.FileInfoOptions" />
</Parameters>
<Docs>
<summary>Create a new FileInfo instance representing the text uri with the specified <see cref="T:Gnome.Vfs.FileInfoOptions" />.</summary>
<param name="uri">
<see cref="T:System.String" /> representing the uri.</param>
<param name="options">
<see cref="T:Gnome.Vfs.FileInfoOptions" /> for the FileInfo metadata.</param>
<remarks>To be added</remarks>
</Docs>
</Member>
<Member MemberName=".ctor">
<MemberSignature Language="C#" Value="public FileInfo (Gnome.Vfs.Uri uri);" />
<MemberType>Constructor</MemberType>
<ReturnValue />
<Parameters>
<Parameter Name="uri" Type="Gnome.Vfs.Uri" />
</Parameters>
<Docs>
<summary>Create a new FileInfo instance representing <see cref="T:Gnome.Vfs.Uri" />.</summary>
<param name="uri">a <see cref="T:Gnome.Vfs.Uri" /></param>
<remarks>To be added</remarks>
</Docs>
</Member>
<Member MemberName=".ctor">
<MemberSignature Language="C#" Value="public FileInfo (Gnome.Vfs.Uri uri, Gnome.Vfs.FileInfoOptions options);" />
<MemberType>Constructor</MemberType>
<ReturnValue />
<Parameters>
<Parameter Name="uri" Type="Gnome.Vfs.Uri" />
<Parameter Name="options" Type="Gnome.Vfs.FileInfoOptions" />
</Parameters>
<Docs>
<summary>Create a new FileInfo instance representing <see cref="T:Gnome.Vfs.Uri" /> with the specified <see cref="T:Gnome.Vfs.FileInfoOptions" />.</summary>
<param name="uri">a <see cref="T:Gnome.Vfs.Uri" /></param>
<param name="options">
<see cref="T:Gnome.Vfs.FileInfoOptions" /> for the FileInfo metadata.</param>
<remarks>To be added</remarks>
</Docs>
</Member>
<Member MemberName="Name">
<MemberSignature Language="C#" Value="public string Name { get; };" />
<MemberType>Property</MemberType>
<ReturnValue>
<ReturnType>System.String</ReturnType>
</ReturnValue>
<Parameters />
<Docs>
<summary>Base name of the file (no path).</summary>
<value>a <see cref="T:System.String" /></value>
<remarks>To be added</remarks>
</Docs>
</Member>
<Member MemberName="ValidFields">
<MemberSignature Language="C#" Value="public Gnome.Vfs.FileInfoFields ValidFields { get; };" />
<MemberType>Property</MemberType>
<ReturnValue>
<ReturnType>Gnome.Vfs.FileInfoFields</ReturnType>
</ReturnValue>
<Parameters />
<Docs>
<summary>Properties which are actually valid in this class.</summary>
<value>a <see cref="T:Gnome.Vfs.FileInfoFields" /></value>
<remarks>To be added</remarks>
</Docs>
</Member>
<Member MemberName="Type">
<MemberSignature Language="C#" Value="public Gnome.Vfs.FileType Type { get; };" />
<MemberType>Property</MemberType>
<ReturnValue>
<ReturnType>Gnome.Vfs.FileType</ReturnType>
</ReturnValue>
<Parameters />
<Docs>
<summary>File type (i.e. regular, directory, block device...).</summary>
<value>a <see cref="T:Gnome.Vfs.FileType" /></value>
<remarks>To be added</remarks>
</Docs>
</Member>
<Member MemberName="Permissions">
<MemberSignature Language="C#" Value="public Gnome.Vfs.FilePermissions Permissions { get; };" />
<MemberType>Property</MemberType>
<ReturnValue>
<ReturnType>Gnome.Vfs.FilePermissions</ReturnType>
</ReturnValue>
<Parameters />
<Docs>
<summary>File permissions.</summary>
<value>a <see cref="T:Gnome.Vfs.FilePermissions" /></value>
<remarks>To be added</remarks>
</Docs>
</Member>
<Member MemberName="Flags">
<MemberSignature Language="C#" Value="public Gnome.Vfs.FileFlags Flags { get; };" />
<MemberType>Property</MemberType>
<ReturnValue>
<ReturnType>Gnome.Vfs.FileFlags</ReturnType>
</ReturnValue>
<Parameters />
<Docs>
<summary>
<see cref="T:Gnome.Vfs.FileFlags" /> for this file.</summary>
<value>a <see cref="T:Gnome.Vfs.FileFlags" /></value>
<remarks>To be added</remarks>
</Docs>
</Member>
<Member MemberName="Device">
<MemberSignature Language="C#" Value="public long Device { get; };" />
<MemberType>Property</MemberType>
<ReturnValue>
<ReturnType>System.Int64</ReturnType>
</ReturnValue>
<Parameters />
<Docs>
<summary>Device id of the file. Only valid if the <see cref="M:Gnome.Vfs.Uri.IsLocal" />.</summary>
<value>a <see cref="T:System.Int64" /></value>
<remarks>To be added</remarks>
</Docs>
</Member>
<Member MemberName="Inode">
<MemberSignature Language="C#" Value="public long Inode { get; };" />
<MemberType>Property</MemberType>
<ReturnValue>
<ReturnType>System.Int64</ReturnType>
</ReturnValue>
<Parameters />
<Docs>
<summary>Inode number of the file. Only valid if the <see cref="M:Gnome.Vfs.Uri.IsLocal" />.</summary>
<value>a <see cref="T:System.Int64" /></value>
<remarks>To be added</remarks>
</Docs>
</Member>
<Member MemberName="LinkCount">
<MemberSignature Language="C#" Value="public uint LinkCount { get; };" />
<MemberType>Property</MemberType>
<ReturnValue>
<ReturnType>System.UInt32</ReturnType>
</ReturnValue>
<Parameters />
<Docs>
<summary>Link count.</summary>
<value>a <see cref="T:System.UInt32" /></value>
<remarks>To be added</remarks>
</Docs>
</Member>
<Member MemberName="Uid">
<MemberSignature Language="C#" Value="public uint Uid { get; };" />
<MemberType>Property</MemberType>
<ReturnValue>
<ReturnType>System.UInt32</ReturnType>
</ReturnValue>
<Parameters />
<Docs>
<summary>UNIX user id.</summary>
<value>a <see cref="T:System.UInt32" /></value>
<remarks>To be added</remarks>
</Docs>
</Member>
<Member MemberName="Gid">
<MemberSignature Language="C#" Value="public uint Gid { get; };" />
<MemberType>Property</MemberType>
<ReturnValue>
<ReturnType>System.UInt32</ReturnType>
</ReturnValue>
<Parameters />
<Docs>
<summary>UNIX group id.</summary>
<value>a <see cref="T:System.UInt32" /></value>
<remarks>To be added</remarks>
</Docs>
</Member>
<Member MemberName="Size">
<MemberSignature Language="C#" Value="public long Size { get; };" />
<MemberType>Property</MemberType>
<ReturnValue>
<ReturnType>System.Int64</ReturnType>
</ReturnValue>
<Parameters />
<Docs>
<summary>Size in bytes.</summary>
<value>a <see cref="T:System.Int64" /></value>
<remarks>To be added</remarks>
</Docs>
</Member>
<Member MemberName="BlockCount">
<MemberSignature Language="C#" Value="public long BlockCount { get; };" />
<MemberType>Property</MemberType>
<ReturnValue>
<ReturnType>System.Int64</ReturnType>
</ReturnValue>
<Parameters />
<Docs>
<summary>Size measured in units of 512-byte blocks.</summary>
<value>a <see cref="T:System.Int64" /></value>
<remarks>To be added</remarks>
</Docs>
</Member>
<Member MemberName="IoBlockSize">
<MemberSignature Language="C#" Value="public uint IoBlockSize { get; };" />
<MemberType>Property</MemberType>
<ReturnValue>
<ReturnType>System.UInt32</ReturnType>
</ReturnValue>
<Parameters />
<Docs>
<summary>Optimal buffer size for reading/writing the file.</summary>
<value>a <see cref="T:System.UInt32" /></value>
<remarks>To be added</remarks>
</Docs>
</Member>
<Member MemberName="Atime">
<MemberSignature Language="C#" Value="public DateTime Atime { get; };" />
<MemberType>Property</MemberType>
<ReturnValue>
<ReturnType>System.DateTime</ReturnType>
</ReturnValue>
<Parameters />
<Docs>
<summary>Last time the file was accessed.</summary>
<value>a <see cref="T:System.DateTime" /></value>
<remarks>To be added</remarks>
</Docs>
</Member>
<Member MemberName="Mtime">
<MemberSignature Language="C#" Value="public DateTime Mtime { get; };" />
<MemberType>Property</MemberType>
<ReturnValue>
<ReturnType>System.DateTime</ReturnType>
</ReturnValue>
<Parameters />
<Docs>
<summary>Last time the file was modified.</summary>
<value>a <see cref="T:System.DateTime" /></value>
<remarks>To be added</remarks>
</Docs>
</Member>
<Member MemberName="Ctime">
<MemberSignature Language="C#" Value="public DateTime Ctime { get; };" />
<MemberType>Property</MemberType>
<ReturnValue>
<ReturnType>System.DateTime</ReturnType>
</ReturnValue>
<Parameters />
<Docs>
<summary>Last time the file was changed.</summary>
<value>a <see cref="T:System.DateTime" /></value>
<remarks>To be added</remarks>
</Docs>
</Member>
<Member MemberName="SymlinkName">
<MemberSignature Language="C#" Value="public string SymlinkName { get; };" />
<MemberType>Property</MemberType>
<ReturnValue>
<ReturnType>System.String</ReturnType>
</ReturnValue>
<Parameters />
<Docs>
<summary>If <see cref="M:Gnome.Vfs.FileInfo.IsSymlink" />, this specifies the file the link points to.</summary>
<value>a <see cref="T:System.String" /></value>
<remarks>To be added</remarks>
</Docs>
</Member>
<Member MemberName="MimeType">
<MemberSignature Language="C#" Value="public string MimeType { get; };" />
<MemberType>Property</MemberType>
<ReturnValue>
<ReturnType>System.String</ReturnType>
</ReturnValue>
<Parameters />
<Docs>
<summary>MIME type. Only valid if the FileInfo was created with <see cref="M:Gnome.Vfs.FileInfoOptions.GetMimeType" />.</summary>
<value>
<see cref="T:System.String" /> representation of the MIME type.</value>
<remarks>To be added</remarks>
</Docs>
</Member>
<Member MemberName="IsSymlink">
<MemberSignature Language="C#" Value="public bool IsSymlink { get; };" />
<MemberType>Property</MemberType>
<ReturnValue>
<ReturnType>System.Boolean</ReturnType>
</ReturnValue>
<Parameters />
<Docs>
<summary>Indicates whether the file is a symlink.</summary>
<value>a <see cref="T:System.Boolean" /></value>
<remarks>To be added</remarks>
</Docs>
</Member>
<Member MemberName="IsLocal">
<MemberSignature Language="C#" Value="public bool IsLocal { get; };" />
<MemberType>Property</MemberType>
<ReturnValue>
<ReturnType>System.Boolean</ReturnType>
</ReturnValue>
<Parameters />
<Docs>
<summary>Indicates whether the <see cref="T:Gnome.Vfs.Uri" /> represents a file on the local filesystem.</summary>
<value>a <see cref="T:System.Boolean" /></value>
<remarks>To be added</remarks>
</Docs>
</Member>
<Member MemberName="HasSuid">
<MemberSignature Language="C#" Value="public bool HasSuid { get; };" />
<MemberType>Property</MemberType>
<ReturnValue>
<ReturnType>System.Boolean</ReturnType>
</ReturnValue>
<Parameters />
<Docs>
<summary>Indicates whether the <see cref="M:Gnome.Vfs.FileInfo.Uid" /> property is set.</summary>
<value>a <see cref="T:System.Boolean" /></value>
<remarks>To be added</remarks>
</Docs>
</Member>
<Member MemberName="HasSgid">
<MemberSignature Language="C#" Value="public bool HasSgid { get; };" />
<MemberType>Property</MemberType>
<ReturnValue>
<ReturnType>System.Boolean</ReturnType>
</ReturnValue>
<Parameters />
<Docs>
<summary>Indicates whether the <see cref="M:Gnome.Vfs.FileInfo.Gid" /> property is set.</summary>
<value>a <see cref="T:System.Boolean" /></value>
<remarks>To be added</remarks>
</Docs>
</Member>
<Member MemberName="IsSticky">
<MemberSignature Language="C#" Value="public bool IsSticky { get; };" />
<MemberType>Property</MemberType>
<ReturnValue>
<ReturnType>System.Boolean</ReturnType>
</ReturnValue>
<Parameters />
<Docs>
<summary>Indicates whether the sticky bit is set.</summary>
<value>a <see cref="T:System.Boolean" /></value>
<remarks>To be added</remarks>
</Docs>
</Member>
<Member MemberName=".ctor">
<MemberSignature Language="C#" Value="public FileInfo ();" />
<MemberType>Constructor</MemberType>
<Parameters />
<Docs>
<summary>To be added.</summary>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName=".ctor">
<MemberSignature Language="C#" Value="public FileInfo (IntPtr handle);" />
<MemberType>Constructor</MemberType>
<Parameters>
<Parameter Name="handle" Type="System.IntPtr" />
</Parameters>
<Docs>
<param name="handle">To be added.</param>
<summary>To be added.</summary>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="Clear">
<MemberSignature Language="C#" Value="public void Clear ();" />
<MemberType>Method</MemberType>
<ReturnValue>
<ReturnType>System.Void</ReturnType>
</ReturnValue>
<Parameters />
<Docs>
<summary>To be added.</summary>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="Handle">
<MemberSignature Language="C#" Value="public IntPtr Handle { get; };" />
<MemberType>Property</MemberType>
<ReturnValue>
<ReturnType>System.IntPtr</ReturnType>
</ReturnValue>
<Docs>
<summary>To be added.</summary>
<value>To be added.</value>
<remarks>To be added.</remarks>
</Docs>
</Member>
</Members>
</Type>