SessionBaseFileOpen Method (Database, FileAccess, String, FileMode, Boolean, Int32, Boolean) |
Opens a
Databasefile for read/update. Internal use only.
Namespace:
VelocityDb.Session
Assembly:
VelocityDb (in VelocityDb.dll) Version: 11.1.0.0 (11.1)
Syntax public virtual Stream FileOpen(
Database db,
FileAccess fileAccess,
ref string errorMessage,
FileMode fileMode = FileMode.Open,
bool excusiveAccess = false,
int waitOverride = -1,
bool signalError = true
)
Public Overridable Function FileOpen (
db As Database,
fileAccess As FileAccess,
ByRef errorMessage As String,
Optional fileMode As FileMode = FileMode.Open,
Optional excusiveAccess As Boolean = false,
Optional waitOverride As Integer = -1,
Optional signalError As Boolean = true
) As Stream
public:
virtual Stream^ FileOpen(
Database^ db,
FileAccess fileAccess,
String^% errorMessage,
FileMode fileMode = FileMode::Open,
bool excusiveAccess = false,
int waitOverride = -1,
bool signalError = true
)
abstract FileOpen :
db : Database *
fileAccess : FileAccess *
errorMessage : string byref *
?fileMode : FileMode *
?excusiveAccess : bool *
?waitOverride : int *
?signalError : bool
(* Defaults:
let _fileMode = defaultArg fileMode FileMode.Open
let _excusiveAccess = defaultArg excusiveAccess false
let _waitOverride = defaultArg waitOverride -1
let _signalError = defaultArg signalError true
*)
-> Stream
override FileOpen :
db : Database *
fileAccess : FileAccess *
errorMessage : string byref *
?fileMode : FileMode *
?excusiveAccess : bool *
?waitOverride : int *
?signalError : bool
(* Defaults:
let _fileMode = defaultArg fileMode FileMode.Open
let _excusiveAccess = defaultArg excusiveAccess false
let _waitOverride = defaultArg waitOverride -1
let _signalError = defaultArg signalError true
*)
-> Stream
Parameters
- db
- Type: VelocityDbDatabase
Database for which we want to open Stream - fileAccess
- Type: System.IOFileAccess
Opening for read or update? - errorMessage
- Type: SystemString
Used for passing error messages back to caller - fileMode (Optional)
- Type: System.IOFileMode
FileMode used for opening file - excusiveAccess (Optional)
- Type: SystemBoolean
Do we want exclusive access to file? - waitOverride (Optional)
- Type: SystemInt32
How long are we willing to wait for a file lock to clear? - signalError (Optional)
- Type: SystemBoolean
Throw exception if we can't open file within wait time?
Return Value
Type:
StreamA
Stream used for accessing
Database data
See Also