C Syntax

HRESULT LTDVDBurner__getProgress(pDVDBurner, pState, pProgress, pComplete, pDescription)

C++ Syntax

HRESULT GetProgress(pState, pProgress, pComplete, pDescription)

ILTDVDBurner *pDVDBurner;

/* pointer to an interface */

long *pState;

/* pointer to a variable */

long *pProgress;

/* pointer to a variable */

long *pComplete;

/* pointer to a variable */

BSTR *pDescription;

/* pointer to a string */

Parameter

Description

pDVDBurner

Pointer to an ILTDVDBurner interface.

pState

Pointer to a variable to be updated with the current state of the burner. 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.

pProgress

Pointer to a variable to be updated with current operation progress. Possible values are:

Value

Meaning

LTDVDBurner_Progress_Idle

[0] No operation is being performed.

LTDVDBurner_Progress_Initializing

[1] Performing steps required before starting the actual operation.

LTDVDBurner_Progress_Writing

[2] Writing an image to disc.

LTDVDBurner_Progress_Finalizing

[3] Finalizing the current operation.

LTDVDBurner_Progress_Erasing

[4] Erasing data from the disc.

LTDVDBurner_Progress_Completed

[5] Operation completed.

LTDVDBurner_Progress_Aborted

[6] Operation aborted due to errors.

pComplete

Pointer to a variable to be updated with the current operation completion status. Possible values range from 0 to 10000, where the value 0 means 0% completed while the value 10000 means 100% completed.

pDescription

Pointer to a character string to be updated with a description of the current step being performed, or the current encountered errors.

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.

LTDVDBRN
DSKernel

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

Functions:

ILTDVDBurner::get_State

Topics:

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