mirror of
https://github.com/OrchardCMS/Orchard.git
synced 2026-02-09 09:16:41 +08:00
Adding some documentation for IAppDataFolder
This commit is contained in:
@@ -15,9 +15,39 @@ namespace Orchard.FileSystems.AppData {
|
||||
string Combine(params string[] paths);
|
||||
|
||||
bool FileExists(string path);
|
||||
|
||||
/// <summary>
|
||||
/// Creates or overwrites the file in the specified path with the specified content.
|
||||
/// </summary>
|
||||
/// <param name="path">The path and name of the file to create.</param>
|
||||
/// <param name="content">The content to write in the created file.</param>
|
||||
/// <remarks>If the folder doesn't exist, it will be created.</remarks>
|
||||
void CreateFile(string path, string content);
|
||||
|
||||
/// <summary>
|
||||
/// Creates or overwrites the file in the specified path.
|
||||
/// </summary>
|
||||
/// <param name="path">The path and name of the file to create.</param>
|
||||
/// <returns>
|
||||
/// A <see cref="Stream"/> that provides read/write access to the file specified in path.
|
||||
/// </returns>
|
||||
/// <remarks>If the folder doesn't exist, it will be created.</remarks>
|
||||
Stream CreateFile(string path);
|
||||
|
||||
/// <summary>
|
||||
/// Opens a text file, reads all lines of the file, and then closes the file.
|
||||
/// </summary>
|
||||
/// <param name="path">The path and name of the file to read.</param>
|
||||
/// <returns>A string containing all lines of the file, or <code>null</code> if the file doesn't exist.</returns>
|
||||
string ReadFile(string path);
|
||||
|
||||
/// <summary>
|
||||
/// Open an existing file for reading.
|
||||
/// </summary>
|
||||
/// <param name="path">The path and name of the file to create.</param>
|
||||
/// <returns>
|
||||
/// A <see cref="Stream"/> that provides read access to the file specified in path.
|
||||
/// </returns>
|
||||
Stream OpenFile(string path);
|
||||
void StoreFile(string sourceFileName, string destinationPath);
|
||||
void DeleteFile(string path);
|
||||
|
||||
Reference in New Issue
Block a user