ILTDVDBurner::get_State

#include "ILTDVDBurner2.h"

C Syntax

HRESULT LTDVDBurner__get_State(pDVDBurner, pVal)

C++ Syntax

HRESULT get_State(pVal)

 

ILTDVDBurner *pDVDBurner;

/* pointer to an interface */

long *pVal;

/* pointer to a variable */

Retrieves the burner state.

Parameter

Description

pDVDBurner

Pointer to an ILTDVDBurner interface.

pVal

Pointer to a variable to be updated with the burner state. Possible values are:

 

Value

Meaning

 

LTDVDBurner_State_Idle

[0] The burner is in the idle state. Operations and checks that require the burner to be in the idle state can be performed now.

 

LTDVDBurner_State_Writing

[1] The burner is performing a writing operation. Certain operations and checks cannot be performed while the burner is in this state.

 

LTDVDBurner_State_TestWriting

[2] The burner is performing a writing test. Certain operations and checks cannot be performed while the burner is in this state.

 

LTDVDBurner_State_Erasing

[3] The burner is performing an erasing operation. Certain operations and checks cannot be performed while the burner is in this state.

Returns

S_OK

The function was successful.

<> S_OK

An error occurred. Refer to the Error Codes or the HRESULT error codes in the DirectShow documentation.

Comments

The following is a list of all possible operations with the required state for each operation:

Operation

Required State

Write

Idle

Erase

Idle

Cancel

Any

RefreshDriveList

Idle

get_DriveCount

Any

get_CurrentDrive

Any

GetDriveName

Any

get_InputPath

Any

put_InputPath

Idle

get_VolumeName

Any

put_VolumeName

Idle

get_LastError

Any

get_State

Any

GetProgress

Any

EjectDisc

Idle

get_AutoEject

Any

put_AutoEject

Idle

get_Eraseable

Idle

get_Writeable

Idle

get_Ejectable

Idle

get_ISOOutputFile

Any

put_ISOOutputFile

Idle

get_DiscType

Any (preferred when Idle to get a fresh profile)

GetDiscTypeName

Any

RefreshSpeedList

Idle

get_CurrentSpeed

Any

put_CurrentSpeed

Idle

GetSpeedValue

Any

GetSpeedName

Any

get_SpeedListChanged

Idle (will return VARIANT_FALSE without checking if called in a different state).

get_DiscCapacity

Idle (will return zero without checking if called in a different state).

LoadDisc

Idle

get_Loadable

Idle (will return VARIANT_FALSE without checking if called in a different state).

get_TestWriteable

Idle (will return VARIANT_FALSE without checking if called in a different state).

get_SpeedCount

Any

get_SystemSupported

Any

GetDriveId

Any

get_ImageSize

Idle (will return zero without checking if called in a different state).

GetDriveDiscTypeCount

Any

GetDriveDiscType

Any

GetDiscTypeWriteable

Any

ResetToDefaults

Idle

Required DLLs and Libraries

LTDVDBrn

DSKernel (Multimedia toolkit)  or LTKRN (Imaging Pro, Document, or Medical toolkits)

For a listing of the exact DLLs and Libraries needed, based on the toolkit version, refer to Files To Be Included With Your Application.

Platforms

Win32, x64

See Also

Functions:

ILTDVDBurner::GetProgress

Topics:

Video Streaming Function Groups, Multimedia Function Group, DVD Function Groups

Example

For a C example, refer to ILTDVDBurner::get_State Example for C.

For a C++ example, refer to ILTDVDBurner::get_State Example for C++.