131 lines
2.7 KiB
Groff
131 lines
2.7 KiB
Groff
.TH "CampusAppWP8.Utility.File" 3 "Thu Sep 26 2013" "CampusAppWp8" \" -*- nroff -*-
|
|
.ad l
|
|
.nh
|
|
.SH NAME
|
|
CampusAppWP8.Utility.File \-
|
|
.PP
|
|
\fBFile\fP class\&.
|
|
|
|
.SH SYNOPSIS
|
|
.br
|
|
.PP
|
|
.SS "Public Member Functions"
|
|
|
|
.in +1c
|
|
.ti -1c
|
|
.RI "\fBFile\fP (string filename)"
|
|
.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 "byte[] \fBReadFile\fP ()"
|
|
.br
|
|
.RI "\fIRead data from file to a string\&.\fP"
|
|
.ti -1c
|
|
.RI "void \fBWriteFile\fP (byte[] data, \fBWriteCallbackFunc\fP onSavedCallback, \fBWriteCallbackFunc\fP onFailedCallback)"
|
|
.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"
|
|
.ti -1c
|
|
.RI "async Task< StorageFile > \fBAsStorageFile\fP ()"
|
|
.br
|
|
.RI "\fIConverts this object to a storage file\&.\fP"
|
|
.in -1c
|
|
.SH "Detailed Description"
|
|
.PP
|
|
\fBFile\fP class\&.
|
|
|
|
|
|
.SH "Constructor & Destructor Documentation"
|
|
.PP
|
|
.SS "CampusAppWP8\&.Utility\&.File\&.File (stringfilename)"
|
|
|
|
.PP
|
|
Initializes a new instance of the \fBFile\fP class\&.Stubbfel, 03\&.09\&.2013\&.
|
|
.PP
|
|
\fBParameters:\fP
|
|
.RS 4
|
|
\fIfilename\fP file name\&.
|
|
.RE
|
|
.PP
|
|
|
|
.SH "Member Function Documentation"
|
|
.PP
|
|
.SS "async Task<StorageFile> CampusAppWP8\&.Utility\&.File\&.AsStorageFile ()"
|
|
|
|
.PP
|
|
Converts this object to a storage file\&.Stubbfel, 03\&.09\&.2013\&.
|
|
.PP
|
|
\fBReturns:\fP
|
|
.RS 4
|
|
Storage \fBFile\fP
|
|
.RE
|
|
.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 "byte [] CampusAppWP8\&.Utility\&.File\&.ReadFile ()"
|
|
|
|
.PP
|
|
Read data from file to a string\&.Stubbfel, 03\&.09\&.2013\&.
|
|
.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)"
|
|
|
|
.PP
|
|
Write bytes to the file\&.Stubbfel, 03\&.09\&.2013\&.
|
|
.PP
|
|
\fBParameters:\fP
|
|
.RS 4
|
|
\fIdata\fP data byte array\&.
|
|
.br
|
|
\fIonSavedCallback\fP callback function, called after writing is done\&.
|
|
.br
|
|
\fIonFailedCallback\fP callback function, called when writing failed\&.
|
|
.RE
|
|
.PP
|
|
|
|
|
|
.SH "Author"
|
|
.PP
|
|
Generated automatically by Doxygen for CampusAppWp8 from the source code\&.
|