IltmfConvert::get_PercentCompleteScalar

Summary

Retrieves the scalar value by which to divide the current conversion completion percentage.

Syntax

#include "ltmf.h"

Language Syntax
C HRESULT IltmfConvert_get_PercentCompleteScalar(pVal)
C++ HRESULT get_PercentCompleteScalar(pVal)

Parameters

long *pVal

Pointer to a variable that receives the scalar value.

Returns

Value Meaning
S_OK The function ran successfully.
<> S_OK An error occurred. Refer to the Error Codes or the HRESULT error codes in the MediaFoundation documentation.

Comments

The programmer retrieves the current conversion completion percentage value by calling IltmfConvert::get_PercentComplete, then divides the percentage complete by the percent complete scalar value to determine the actual percentage complete. For example, if the scalar value is 100 and a call to IltmfConvert::get_PercentComplete retrieves a value of 50, then the process is 50/100 complete (0.5%) instead of 50%. Likewise, if the scalar is 1 and the programmer gets a percent complete value of 50, then the percentage complete is 50/1, or 50% complete.

Call IltmfConvert::put_PercentCompleteScalar to set the percentage complete scalar.

Required DLLs and Libraries

Platforms

Win32, x64.

See Also

Functions

Topics

Example

For a C++ example, refer to IltmfConvert::get_PercentCompleteScalar Example for C++.

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

LEADTOOLS Media Foundation C API Help
Products | Support | Contact Us | Intellectual Property Notices
© 1991-2023 LEAD Technologies, Inc. All Rights Reserved.