GtkSharp/doc/en/GLib/FileUtils.xml

51 lines
2 KiB
XML
Raw Normal View History

<Type Name="FileUtils" FullName="GLib.FileUtils">
<TypeSignature Language="C#" Value="public class FileUtils" Maintainer="auto" />
<AssemblyInfo>
<AssemblyName>glib-sharp</AssemblyName>
<AssemblyPublicKey>
</AssemblyPublicKey>
<AssemblyVersion>2.8.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>A simple file IO utility class</summary>
<remarks>Contains a single static method GetFileContents(string filename) which returns the contents of a text file as a string.</remarks>
</Docs>
<Base>
<BaseTypeName>System.Object</BaseTypeName>
</Base>
<Interfaces />
<Members>
<Member MemberName="GetFileContents">
<MemberSignature Language="C#" Value="public static string GetFileContents (string filename);" />
<MemberType>Method</MemberType>
<ReturnValue>
<ReturnType>System.String</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="filename" Type="System.String" />
</Parameters>
<Docs>
<summary>Returns a string containing the contents of the text file passed as the 'filename' parameter.</summary>
<param name="filename">The file GetFileContents() should retrieve its result from. An object of type <see cref="T:System.String" /></param>
<returns>Returns the contents of a text file. An object of type <see cref="T:System.String" /></returns>
<remarks>
<example>
<code lang="C#">
using System;
class Test
{
public static void Main(string[] args)
{
Console.WriteLine(GLib.FileUtils.GetFileContents(args[0]));
}
}
</code>
</example>
</remarks>
</Docs>
</Member>
</Members>
</Type>