ILTDVDBurner::GetProgress

Summary

Retrieves the progress of the current operation.

Syntax

#include "ILTDVDBurner2.h"
Platform Syntax
C HRESULT ILTDVDBurner_getProgress(pDVDBurner, pState, pProgress, pComplete, pDescription)
C++ HRESULT GetProgress(pState, pProgress, pComplete, pDescription)

Parameters

ILTDVDBurner *pDVDBurner

Pointer to an ILTDVDBurner interface.

long *pState

Pointer to a variable to be updated with an LTDVDBurner_State value describing the burner's state.

long *pProgress

Pointer to a variable to be updated with an LTDVDBurner_Progress value describing the progress of the current operation.

long *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 and the value 10000 means 100% completed.

BSTR *pDescription

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

Returns

Value Meaning
S_OK The function was successful.
<> S_OK An error occurred. Refer to the Error Codes

Comments

If the function succeeds, the user is responsible for freeing the string retrieved in pDescription by calling SysFreeString.

Required DLLs and Libraries

Platforms

Win32, x64

See Also

Functions

Topics

Example

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

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

Help Version 23.0.2024.3.3
Products | Support | Contact Us | Intellectual Property Notices
© 1991-2024 LEAD Technologies, Inc. All Rights Reserved.

LEADTOOLS Media Writer C API Help

Products | Support | Contact Us | Intellectual Property Notices
© 1991-2023 LEAD Technologies, Inc. All Rights Reserved.