Collapse All Expand All

IltmmConvert::get_PercentCompleteScalar

#include "ltmm.h"

C Syntax	HRESULT IltmmConvert_get_PercentCompleteScalar(pVal)
C++ Syntax	HRESULT get_PercentCompleteScalar(pVal)

 

long *pVal;

/* pointer to a variable */

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

Parameter	Description
pVal	Pointer to a variable that receives the scalar value.

Returns

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

Comments

The programmer retrieves the current conversion completion percentage value by calling IltmmConvert::get_PercentComplete. He or she 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 IltmmConvert::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 IltmmConvert::put_PercentCompleteScalar to set the percentage complete scalar.

Required DLLs and Libraries

LTMM 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

Elements:	IltmmConvert interface, IltmmConvert::Put_PercentCompleteScalar, IltmmConvert::get_PercentComplete
Topics:	Multimedia Function Group

Example

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

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