Starts recording a new video file.

Namespace: ASCOM.DriverAccess
Assembly: ASCOM.DriverAccess (in ASCOM.DriverAccess.dll) Version: 6.0.0.0 (6.1.1.2619)

Syntax

C#
public string StartRecordingVideoFile(
	string PreferredFileName
)
Visual Basic
Public Function StartRecordingVideoFile ( _
	PreferredFileName As String _
) As String
Visual C++
public:
virtual String^ StartRecordingVideoFile(
	String^ PreferredFileName
) sealed

Parameters

PreferredFileName
Type: System..::..String
The file name requested by the client. Some systems may not allow the file name to be controlled directly and they should ignore this parameter.

Return Value

The actual file name of the file that is being recorded.

Implements

IVideo..::..StartRecordingVideoFile(String)

Exceptions

ExceptionCondition
ASCOM..::..NotConnectedExceptionMust throw exception if not connected.
ASCOM..::..InvalidOperationExceptionMust throw exception if the current camera state doesn't allow to begin recording a file.
ASCOM..::..DriverExceptionMust throw exception if there is any other problem as result of which the recording cannot begin.

See Also