Table of Contents

Class FileHelper

Namespace
Gio
Assembly
Gio-2.0.dll
public sealed class FileHelper : Object, File, NativeObject, IDisposable, InstanceFactory, GTypeProvider
Inheritance
FileHelper
Implements
Inherited Members

Constructors

FileHelper(ObjectHandle) 

protected FileHelper(ObjectHandle handle)

Parameters

handle ObjectHandle

Methods

AppendTo(FileCreateFlags, Cancellable?) 

public FileOutputStream AppendTo(FileCreateFlags flags, Cancellable? cancellable)

Parameters

flags FileCreateFlags
cancellable Cancellable

Returns

FileOutputStream

AppendToFinish(AsyncResult) 

public FileOutputStream AppendToFinish(AsyncResult res)

Parameters

res AsyncResult

Returns

FileOutputStream

BuildAttributeListForCopy(FileCopyFlags, Cancellable?) 

[Version("2.68")]
public string BuildAttributeListForCopy(FileCopyFlags flags, Cancellable? cancellable)

Parameters

flags FileCopyFlags
cancellable Cancellable

Returns

string

Copy(File, FileCopyFlags, Cancellable?, FileProgressCallback?) 

public bool Copy(File destination, FileCopyFlags flags, Cancellable? cancellable, FileProgressCallback? progressCallback)

Parameters

destination File
flags FileCopyFlags
cancellable Cancellable
progressCallback FileProgressCallback

Returns

bool

CopyAsync(File, FileCopyFlags, int, Cancellable?, Closure?, Closure) 

[Version("2.82")]
public void CopyAsync(File destination, FileCopyFlags flags, int ioPriority, Cancellable? cancellable, Closure? progressCallbackClosure, Closure readyCallbackClosure)

Parameters

destination File
flags FileCopyFlags
ioPriority int
cancellable Cancellable
progressCallbackClosure Closure
readyCallbackClosure Closure

CopyAttributes(File, FileCopyFlags, Cancellable?) 

public bool CopyAttributes(File destination, FileCopyFlags flags, Cancellable? cancellable)

Parameters

destination File
flags FileCopyFlags
cancellable Cancellable

Returns

bool

CopyFinish(AsyncResult) 

public bool CopyFinish(AsyncResult res)

Parameters

res AsyncResult

Returns

bool

Create(FileCreateFlags, Cancellable?) 

public FileOutputStream Create(FileCreateFlags flags, Cancellable? cancellable)

Parameters

flags FileCreateFlags
cancellable Cancellable

Returns

FileOutputStream

CreateFinish(AsyncResult) 

public FileOutputStream CreateFinish(AsyncResult res)

Parameters

res AsyncResult

Returns

FileOutputStream

CreateReadwrite(FileCreateFlags, Cancellable?) 

[Version("2.22")]
public FileIOStream CreateReadwrite(FileCreateFlags flags, Cancellable? cancellable)

Parameters

flags FileCreateFlags
cancellable Cancellable

Returns

FileIOStream

CreateReadwriteFinish(AsyncResult) 

[Version("2.22")]
public FileIOStream CreateReadwriteFinish(AsyncResult res)

Parameters

res AsyncResult

Returns

FileIOStream

Delete(Cancellable?) 

public bool Delete(Cancellable? cancellable)

Parameters

cancellable Cancellable

Returns

bool

DeleteFinish(AsyncResult) 

[Version("2.34")]
public bool DeleteFinish(AsyncResult result)

Parameters

result AsyncResult

Returns

bool

Dup() 

public File Dup()

Returns

File

EjectMountableFinish(AsyncResult) 

public bool EjectMountableFinish(AsyncResult result)

Parameters

result AsyncResult

Returns

bool

EjectMountableWithOperationFinish(AsyncResult) 

[Version("2.22")]
public bool EjectMountableWithOperationFinish(AsyncResult result)

Parameters

result AsyncResult

Returns

bool

EnumerateChildren(string, FileQueryInfoFlags, Cancellable?) 

public FileEnumerator EnumerateChildren(string attributes, FileQueryInfoFlags flags, Cancellable? cancellable)

Parameters

attributes string
flags FileQueryInfoFlags
cancellable Cancellable

Returns

FileEnumerator

EnumerateChildrenFinish(AsyncResult) 

public FileEnumerator EnumerateChildrenFinish(AsyncResult res)

Parameters

res AsyncResult

Returns

FileEnumerator

Equal(File) 

public bool Equal(File file2)

Parameters

file2 File

Returns

bool

FindEnclosingMount(Cancellable?) 

public Mount FindEnclosingMount(Cancellable? cancellable)

Parameters

cancellable Cancellable

Returns

Mount

FindEnclosingMountFinish(AsyncResult) 

public Mount FindEnclosingMountFinish(AsyncResult res)

Parameters

res AsyncResult

Returns

Mount

GetBasename() 

public string? GetBasename()

Returns

string

GetChild(string) 

public File GetChild(string name)

Parameters

name string

Returns

File

GetChildForDisplayName(string) 

public File GetChildForDisplayName(string displayName)

Parameters

displayName string

Returns

File

GetGType() 

public static Type GetGType()

Returns

Type

GetParent() 

public File? GetParent()

Returns

File

GetParseName() 

public string GetParseName()

Returns

string

GetPath() 

public string? GetPath()

Returns

string

GetRelativePath(File) 

public string? GetRelativePath(File descendant)

Parameters

descendant File

Returns

string

GetUri() 

public string GetUri()

Returns

string

GetUriScheme() 

public string? GetUriScheme()

Returns

string

HasParent(File?) 

[Version("2.24")]
public bool HasParent(File? parent)

Parameters

parent File

Returns

bool

HasPrefix(File) 

public bool HasPrefix(File prefix)

Parameters

prefix File

Returns

bool

HasUriScheme(string) 

public bool HasUriScheme(string uriScheme)

Parameters

uriScheme string

Returns

bool

Hash() 

public uint Hash()

Returns

uint

IsNative() 

public bool IsNative()

Returns

bool

LoadBytes(Cancellable?, out string?) 

[Version("2.56")]
public Bytes LoadBytes(Cancellable? cancellable, out string? etagOut)

Parameters

cancellable Cancellable
etagOut string

Returns

Bytes

LoadBytesFinish(AsyncResult, out string?) 

[Version("2.56")]
public Bytes LoadBytesFinish(AsyncResult result, out string? etagOut)

Parameters

result AsyncResult
etagOut string

Returns

Bytes

MakeDirectory(Cancellable?) 

public bool MakeDirectory(Cancellable? cancellable)

Parameters

cancellable Cancellable

Returns

bool

MakeDirectoryFinish(AsyncResult) 

[Version("2.38")]
public bool MakeDirectoryFinish(AsyncResult result)

Parameters

result AsyncResult

Returns

bool

MakeDirectoryWithParents(Cancellable?) 

[Version("2.18")]
public bool MakeDirectoryWithParents(Cancellable? cancellable)

Parameters

cancellable Cancellable

Returns

bool

MakeSymbolicLink(string, Cancellable?) 

public bool MakeSymbolicLink(string symlinkValue, Cancellable? cancellable)

Parameters

symlinkValue string
cancellable Cancellable

Returns

bool

MakeSymbolicLinkFinish(AsyncResult) 

[Version("2.74")]
public bool MakeSymbolicLinkFinish(AsyncResult result)

Parameters

result AsyncResult

Returns

bool

MeasureDiskUsage(FileMeasureFlags, Cancellable?, FileMeasureProgressCallback?, out ulong, out ulong, out ulong) 

[Version("2.38")]
public bool MeasureDiskUsage(FileMeasureFlags flags, Cancellable? cancellable, FileMeasureProgressCallback? progressCallback, out ulong diskUsage, out ulong numDirs, out ulong numFiles)

Parameters

flags FileMeasureFlags
cancellable Cancellable
progressCallback FileMeasureProgressCallback
diskUsage ulong
numDirs ulong
numFiles ulong

Returns

bool

MeasureDiskUsageFinish(AsyncResult, out ulong, out ulong, out ulong) 

[Version("2.38")]
public bool MeasureDiskUsageFinish(AsyncResult result, out ulong diskUsage, out ulong numDirs, out ulong numFiles)

Parameters

result AsyncResult
diskUsage ulong
numDirs ulong
numFiles ulong

Returns

bool

Monitor(FileMonitorFlags, Cancellable?) 

[Version("2.18")]
public FileMonitor Monitor(FileMonitorFlags flags, Cancellable? cancellable)

Parameters

flags FileMonitorFlags
cancellable Cancellable

Returns

FileMonitor

MonitorDirectory(FileMonitorFlags, Cancellable?) 

public FileMonitor MonitorDirectory(FileMonitorFlags flags, Cancellable? cancellable)

Parameters

flags FileMonitorFlags
cancellable Cancellable

Returns

FileMonitor

MonitorFile(FileMonitorFlags, Cancellable?) 

public FileMonitor MonitorFile(FileMonitorFlags flags, Cancellable? cancellable)

Parameters

flags FileMonitorFlags
cancellable Cancellable

Returns

FileMonitor

MountEnclosingVolumeFinish(AsyncResult) 

public bool MountEnclosingVolumeFinish(AsyncResult result)

Parameters

result AsyncResult

Returns

bool

MountMountableFinish(AsyncResult) 

public File MountMountableFinish(AsyncResult result)

Parameters

result AsyncResult

Returns

File

Move(File, FileCopyFlags, Cancellable?, FileProgressCallback?) 

public bool Move(File destination, FileCopyFlags flags, Cancellable? cancellable, FileProgressCallback? progressCallback)

Parameters

destination File
flags FileCopyFlags
cancellable Cancellable
progressCallback FileProgressCallback

Returns

bool

MoveAsync(File, FileCopyFlags, int, Cancellable?, Closure?, Closure) 

[Version("2.82")]
public void MoveAsync(File destination, FileCopyFlags flags, int ioPriority, Cancellable? cancellable, Closure? progressCallbackClosure, Closure readyCallbackClosure)

Parameters

destination File
flags FileCopyFlags
ioPriority int
cancellable Cancellable
progressCallbackClosure Closure
readyCallbackClosure Closure

MoveFinish(AsyncResult) 

[Version("2.72")]
public bool MoveFinish(AsyncResult result)

Parameters

result AsyncResult

Returns

bool

NewBuildFilenamev(string[]) 

[Version("2.78")]
public static File NewBuildFilenamev(string[] args)

Parameters

args string[]

Returns

File

NewForCommandlineArg(string) 

public static File NewForCommandlineArg(string arg)

Parameters

arg string

Returns

File

NewForCommandlineArgAndCwd(string, string) 

[Version("2.36")]
public static File NewForCommandlineArgAndCwd(string arg, string cwd)

Parameters

arg string
cwd string

Returns

File

NewForPath(string) 

public static File NewForPath(string path)

Parameters

path string

Returns

File

NewForUri(string) 

public static File NewForUri(string uri)

Parameters

uri string

Returns

File

NewFromPointer(nint, bool)

Creates a new managed FileHelper instance for a given pointer.

public static FileHelper NewFromPointer(nint ptr, bool ownsHandle)

Parameters

ptr nint
ownsHandle bool

Returns

FileHelper

NewTmpDirFinish(AsyncResult) 

[Version("2.74")]
public static File NewTmpDirFinish(AsyncResult result)

Parameters

result AsyncResult

Returns

File

OpenReadwrite(Cancellable?) 

[Version("2.22")]
public FileIOStream OpenReadwrite(Cancellable? cancellable)

Parameters

cancellable Cancellable

Returns

FileIOStream

OpenReadwriteFinish(AsyncResult) 

[Version("2.22")]
public FileIOStream OpenReadwriteFinish(AsyncResult res)

Parameters

res AsyncResult

Returns

FileIOStream

ParseName(string) 

public static File ParseName(string parseName)

Parameters

parseName string

Returns

File

PeekPath() 

[Version("2.56")]
public string? PeekPath()

Returns

string

PollMountableFinish(AsyncResult) 

[Version("2.22")]
public bool PollMountableFinish(AsyncResult result)

Parameters

result AsyncResult

Returns

bool

QueryDefaultHandler(Cancellable?) 

public AppInfo QueryDefaultHandler(Cancellable? cancellable)

Parameters

cancellable Cancellable

Returns

AppInfo

QueryDefaultHandlerFinish(AsyncResult) 

[Version("2.60")]
public AppInfo QueryDefaultHandlerFinish(AsyncResult result)

Parameters

result AsyncResult

Returns

AppInfo

QueryExists(Cancellable?) 

public bool QueryExists(Cancellable? cancellable)

Parameters

cancellable Cancellable

Returns

bool

QueryFileType(FileQueryInfoFlags, Cancellable?) 

[Version("2.18")]
public FileType QueryFileType(FileQueryInfoFlags flags, Cancellable? cancellable)

Parameters

flags FileQueryInfoFlags
cancellable Cancellable

Returns

FileType

QueryFilesystemInfo(string, Cancellable?) 

public FileInfo QueryFilesystemInfo(string attributes, Cancellable? cancellable)

Parameters

attributes string
cancellable Cancellable

Returns

FileInfo

QueryFilesystemInfoFinish(AsyncResult) 

public FileInfo QueryFilesystemInfoFinish(AsyncResult res)

Parameters

res AsyncResult

Returns

FileInfo

QueryInfo(string, FileQueryInfoFlags, Cancellable?) 

public FileInfo QueryInfo(string attributes, FileQueryInfoFlags flags, Cancellable? cancellable)

Parameters

attributes string
flags FileQueryInfoFlags
cancellable Cancellable

Returns

FileInfo

QueryInfoFinish(AsyncResult) 

public FileInfo QueryInfoFinish(AsyncResult res)

Parameters

res AsyncResult

Returns

FileInfo

QuerySettableAttributes(Cancellable?) 

public FileAttributeInfoList QuerySettableAttributes(Cancellable? cancellable)

Parameters

cancellable Cancellable

Returns

FileAttributeInfoList

QueryWritableNamespaces(Cancellable?) 

public FileAttributeInfoList QueryWritableNamespaces(Cancellable? cancellable)

Parameters

cancellable Cancellable

Returns

FileAttributeInfoList

Read(Cancellable?) 

public FileInputStream Read(Cancellable? cancellable)

Parameters

cancellable Cancellable

Returns

FileInputStream

ReadFinish(AsyncResult) 

public FileInputStream ReadFinish(AsyncResult res)

Parameters

res AsyncResult

Returns

FileInputStream

Replace(string?, bool, FileCreateFlags, Cancellable?) 

public FileOutputStream Replace(string? etag, bool makeBackup, FileCreateFlags flags, Cancellable? cancellable)

Parameters

etag string
makeBackup bool
flags FileCreateFlags
cancellable Cancellable

Returns

FileOutputStream

ReplaceContents(Span<byte>, string?, bool, FileCreateFlags, out string?, Cancellable?) 

public bool ReplaceContents(Span<byte> contents, string? etag, bool makeBackup, FileCreateFlags flags, out string? newEtag, Cancellable? cancellable)

Parameters

contents Span<byte>
etag string
makeBackup bool
flags FileCreateFlags
newEtag string
cancellable Cancellable

Returns

bool

ReplaceContentsFinish(AsyncResult, out string?) 

public bool ReplaceContentsFinish(AsyncResult res, out string? newEtag)

Parameters

res AsyncResult
newEtag string

Returns

bool

ReplaceFinish(AsyncResult) 

public FileOutputStream ReplaceFinish(AsyncResult res)

Parameters

res AsyncResult

Returns

FileOutputStream

ReplaceReadwrite(string?, bool, FileCreateFlags, Cancellable?) 

[Version("2.22")]
public FileIOStream ReplaceReadwrite(string? etag, bool makeBackup, FileCreateFlags flags, Cancellable? cancellable)

Parameters

etag string
makeBackup bool
flags FileCreateFlags
cancellable Cancellable

Returns

FileIOStream

ReplaceReadwriteFinish(AsyncResult) 

[Version("2.22")]
public FileIOStream ReplaceReadwriteFinish(AsyncResult res)

Parameters

res AsyncResult

Returns

FileIOStream

ResolveRelativePath(string) 

public File ResolveRelativePath(string relativePath)

Parameters

relativePath string

Returns

File

SetAttribute(string, FileAttributeType, nint, FileQueryInfoFlags, Cancellable?) 

public bool SetAttribute(string attribute, FileAttributeType type, nint valueP, FileQueryInfoFlags flags, Cancellable? cancellable)

Parameters

attribute string
type FileAttributeType
valueP nint
flags FileQueryInfoFlags
cancellable Cancellable

Returns

bool

SetAttributeByteString(string, string, FileQueryInfoFlags, Cancellable?) 

public bool SetAttributeByteString(string attribute, string value, FileQueryInfoFlags flags, Cancellable? cancellable)

Parameters

attribute string
value string
flags FileQueryInfoFlags
cancellable Cancellable

Returns

bool

SetAttributeInt32(string, int, FileQueryInfoFlags, Cancellable?) 

public bool SetAttributeInt32(string attribute, int value, FileQueryInfoFlags flags, Cancellable? cancellable)

Parameters

attribute string
value int
flags FileQueryInfoFlags
cancellable Cancellable

Returns

bool

SetAttributeInt64(string, long, FileQueryInfoFlags, Cancellable?) 

public bool SetAttributeInt64(string attribute, long value, FileQueryInfoFlags flags, Cancellable? cancellable)

Parameters

attribute string
value long
flags FileQueryInfoFlags
cancellable Cancellable

Returns

bool

SetAttributeString(string, string, FileQueryInfoFlags, Cancellable?) 

public bool SetAttributeString(string attribute, string value, FileQueryInfoFlags flags, Cancellable? cancellable)

Parameters

attribute string
value string
flags FileQueryInfoFlags
cancellable Cancellable

Returns

bool

SetAttributeUint32(string, uint, FileQueryInfoFlags, Cancellable?) 

public bool SetAttributeUint32(string attribute, uint value, FileQueryInfoFlags flags, Cancellable? cancellable)

Parameters

attribute string
value uint
flags FileQueryInfoFlags
cancellable Cancellable

Returns

bool

SetAttributeUint64(string, ulong, FileQueryInfoFlags, Cancellable?) 

public bool SetAttributeUint64(string attribute, ulong value, FileQueryInfoFlags flags, Cancellable? cancellable)

Parameters

attribute string
value ulong
flags FileQueryInfoFlags
cancellable Cancellable

Returns

bool

SetAttributesFromInfo(FileInfo, FileQueryInfoFlags, Cancellable?) 

public bool SetAttributesFromInfo(FileInfo info, FileQueryInfoFlags flags, Cancellable? cancellable)

Parameters

info FileInfo
flags FileQueryInfoFlags
cancellable Cancellable

Returns

bool

SetDisplayName(string, Cancellable?) 

public File SetDisplayName(string displayName, Cancellable? cancellable)

Parameters

displayName string
cancellable Cancellable

Returns

File

SetDisplayNameFinish(AsyncResult) 

public File SetDisplayNameFinish(AsyncResult res)

Parameters

res AsyncResult

Returns

File

StartMountableFinish(AsyncResult) 

[Version("2.22")]
public bool StartMountableFinish(AsyncResult result)

Parameters

result AsyncResult

Returns

bool

StopMountableFinish(AsyncResult) 

[Version("2.22")]
public bool StopMountableFinish(AsyncResult result)

Parameters

result AsyncResult

Returns

bool

SupportsThreadContexts() 

[Version("2.22")]
public bool SupportsThreadContexts()

Returns

bool

Trash(Cancellable?) 

public bool Trash(Cancellable? cancellable)

Parameters

cancellable Cancellable

Returns

bool

TrashFinish(AsyncResult) 

[Version("2.38")]
public bool TrashFinish(AsyncResult result)

Parameters

result AsyncResult

Returns

bool

UnmountMountableFinish(AsyncResult) 

public bool UnmountMountableFinish(AsyncResult result)

Parameters

result AsyncResult

Returns

bool

UnmountMountableWithOperationFinish(AsyncResult) 

[Version("2.22")]
public bool UnmountMountableWithOperationFinish(AsyncResult result)

Parameters

result AsyncResult

Returns

bool
Edit this page