172 lines
3.5 KiB
Groff
172 lines
3.5 KiB
Groff
.TH "CampusAppWP8.Utility.File" 3 "Thu Aug 15 2013" "CampusAppWp8" \" -*- nroff -*-
|
|
.ad l
|
|
.nh
|
|
.SH NAME
|
|
CampusAppWP8.Utility.File \-
|
|
.PP
|
|
\fBFile\fP class\&.
|
|
|
|
.SH SYNOPSIS
|
|
.br
|
|
.PP
|
|
.SS "Public Types"
|
|
|
|
.in +1c
|
|
.ti -1c
|
|
.RI "enum \fBIOTypeRead\fP { \fBIOTypeRead\&.INVALID\fP = 0, \fBIOTypeRead\&.ReadSync\fP = 1, \fBIOTypeRead\&.ReadAsync\fP = 2 }"
|
|
.br
|
|
.RI "\fIIO read type ENUM\&. \fP"
|
|
.ti -1c
|
|
.RI "enum \fBIOTypeWrite\fP { \fBIOTypeWrite\&.INVALID\fP = 0, \fBIOTypeWrite\&.WriteSync\fP = 1, \fBIOTypeWrite\&.WriteAsync\fP = 2, \fBIOTypeWrite\&.ReadOnly\fP = 3 }"
|
|
.br
|
|
.RI "\fIIO write type ENUM\&. \fP"
|
|
.in -1c
|
|
.SS "Public Member Functions"
|
|
|
|
.in +1c
|
|
.ti -1c
|
|
.RI "\fBFile\fP (string filename, \fBIOTypeRead\fP read, \fBIOTypeWrite\fP write)"
|
|
.br
|
|
.RI "\fIInitializes a new instance of the \fBFile\fP class\&. \fP"
|
|
.ti -1c
|
|
.RI "delegate void \fBWriteCallbackFunc\fP ()"
|
|
.br
|
|
.RI "\fIDelegation of the write callback function prototype\&. \fP"
|
|
.ti -1c
|
|
.RI "string \fBReadFile\fP (\fBIOTypeRead\fP ioType=IOTypeRead\&.INVALID)"
|
|
.br
|
|
.RI "\fIRead data from file to a string\&. \fP"
|
|
.ti -1c
|
|
.RI "void \fBWriteFile\fP (byte[] data, \fBWriteCallbackFunc\fP onSavedCallback, \fBWriteCallbackFunc\fP onFailedCallback, \fBIOTypeWrite\fP ioType=IOTypeWrite\&.INVALID)"
|
|
.br
|
|
.RI "\fIWrite bytes to the file\&. \fP"
|
|
.ti -1c
|
|
.RI "FileInfo \fBGetFileInfo\fP ()"
|
|
.br
|
|
.RI "\fIReturn a info object of the file\&. \fP"
|
|
.ti -1c
|
|
.RI "bool \fBExist\fP ()"
|
|
.br
|
|
.RI "\fICheck if a file is existing\&. \fP"
|
|
.in -1c
|
|
.SH "Detailed Description"
|
|
.PP
|
|
\fBFile\fP class\&.
|
|
|
|
|
|
.SH "Member Enumeration Documentation"
|
|
.PP
|
|
.SS "enum \fBCampusAppWP8\&.Utility\&.File\&.IOTypeRead\fP"
|
|
|
|
.PP
|
|
IO read type ENUM\&.
|
|
.PP
|
|
\fBEnumerator\fP
|
|
.in +1c
|
|
.TP
|
|
\fB\fIINVALID \fP\fP
|
|
Invalid/unset state\&.
|
|
.TP
|
|
\fB\fIReadSync \fP\fP
|
|
Sync read\&.
|
|
.TP
|
|
\fB\fIReadAsync \fP\fP
|
|
Async read\&.
|
|
.SS "enum \fBCampusAppWP8\&.Utility\&.File\&.IOTypeWrite\fP"
|
|
|
|
.PP
|
|
IO write type ENUM\&.
|
|
.PP
|
|
\fBEnumerator\fP
|
|
.in +1c
|
|
.TP
|
|
\fB\fIINVALID \fP\fP
|
|
Invalid/unset state\&.
|
|
.TP
|
|
\fB\fIWriteSync \fP\fP
|
|
Sync write\&.
|
|
.TP
|
|
\fB\fIWriteAsync \fP\fP
|
|
Async write\&.
|
|
.TP
|
|
\fB\fIReadOnly \fP\fP
|
|
Read only, no writing\&.
|
|
.SH "Constructor & Destructor Documentation"
|
|
.PP
|
|
.SS "CampusAppWP8\&.Utility\&.File\&.File (stringfilename, \fBIOTypeRead\fPread, \fBIOTypeWrite\fPwrite)"
|
|
|
|
.PP
|
|
Initializes a new instance of the \fBFile\fP class\&.
|
|
.PP
|
|
\fBParameters:\fP
|
|
.RS 4
|
|
\fIfilename\fP file name
|
|
.br
|
|
\fIread\fP read type
|
|
.br
|
|
\fIwrite\fP write type
|
|
.RE
|
|
.PP
|
|
|
|
.SH "Member Function Documentation"
|
|
.PP
|
|
.SS "bool CampusAppWP8\&.Utility\&.File\&.Exist ()"
|
|
|
|
.PP
|
|
Check if a file is existing\&.
|
|
.PP
|
|
\fBReturns:\fP
|
|
.RS 4
|
|
true, if file exists, otherwise false
|
|
.RE
|
|
.PP
|
|
|
|
.SS "FileInfo CampusAppWP8\&.Utility\&.File\&.GetFileInfo ()"
|
|
|
|
.PP
|
|
Return a info object of the file\&.
|
|
.PP
|
|
\fBReturns:\fP
|
|
.RS 4
|
|
info of the file
|
|
.RE
|
|
.PP
|
|
|
|
.SS "string CampusAppWP8\&.Utility\&.File\&.ReadFile (\fBIOTypeRead\fPioType = \fCIOTypeRead\&.INVALID\fP)"
|
|
|
|
.PP
|
|
Read data from file to a string\&.
|
|
.PP
|
|
\fBParameters:\fP
|
|
.RS 4
|
|
\fIioType\fP read type
|
|
.RE
|
|
.PP
|
|
\fBReturns:\fP
|
|
.RS 4
|
|
data string
|
|
.RE
|
|
.PP
|
|
|
|
.SS "delegate void CampusAppWP8\&.Utility\&.File\&.WriteCallbackFunc ()"
|
|
|
|
.PP
|
|
Delegation of the write callback function prototype\&.
|
|
.SS "void CampusAppWP8\&.Utility\&.File\&.WriteFile (byte[]data, \fBWriteCallbackFunc\fPonSavedCallback, \fBWriteCallbackFunc\fPonFailedCallback, \fBIOTypeWrite\fPioType = \fCIOTypeWrite\&.INVALID\fP)"
|
|
|
|
.PP
|
|
Write bytes to the file\&.
|
|
.PP
|
|
\fBParameters:\fP
|
|
.RS 4
|
|
\fIdata\fP data byte array
|
|
.br
|
|
\fIioType\fP write type
|
|
.RE
|
|
.PP
|
|
|
|
|
|
.SH "Author"
|
|
.PP
|
|
Generated automatically by Doxygen for CampusAppWp8 from the source code\&.
|