IWICLeadBitmapEncoder::GetQualityFactorPredefinedFriendlyName Method

Gets the encoder's friendly name for a specific predefined quality factor value. This method is only valid for the Cmp and Abc encoders.

Syntax


Gets the encoder's friendly name for a specific predefined quality factor value. This method is only valid for the Cmp and Abc encoders.

Syntax


            HRESULT GetQualityFactorPredefinedFriendlyName( 
                INT nQualityFactor,
                UINT cchFriendlyName,
                WCHAR *pwzFriendlyName,
                UINT *pcchActual
            );

Parameters

nQualityFactor

[in] A value that specifies one of the WICLeadAbcQualityFactorPredefined or WICLeadAbcQualityFactorPredefined constants.

cchFriendlyName

[in] The size of the pwzFriendlyName buffer.

pwzFriendlyName

[in,out] A pointer that receives the friendly name for the component.

pcchActual

[out] A pointer that receives the actual length of the component's friendly name.

Return Values

Returns S_OK if successful, or an error value otherwise.

Remarks

Use this method to get a user-readable string representation for any of the predefined quality factor constants (WICLeadAbcQualityFactorPredefined or WICLeadAbcQualityFactorPredefined ). Call GetQualityFactorPredefinedFriendlyName once to get the length of the friendly name. Allocate the appropriately sized array. Then call GetQualityFactorPredefinedFriendlyName again, passing the allocated array as an argument. The example illustrates this technique.

Note that the GetLeadEnumFriendlyName method can also be used to obtain a readable string from any of the LEAD WIC Enumerations that are identical to the constant name.

For more information, refer to GetQualityFactorPredefined, QualityFactor, WICLeadAbcQualityFactorPredefined, and WICLeadCmpQualityFactorPredefined.

Example

For an example, refer to IWICLeadBitmapEncoder::GetQualityFactorPredefined

References

LEAD WIC-Enabled Codecs Overview
Registering a LEAD WIC-Enabled Codec
WICLeadEnumName
GetLeadEnumFriendlyName
QualityFactor property bag
WICLeadSubFormatFlags
IWICLeadBitmapEncoder::GetQualityFactorRange
IWICLeadBitmapEncode::GetQualityFactorPredefined
WICLeadAbcQualityFactorPredefined
WICLeadCmpQualityFactorPredefined

Parameters

nQualityFactor

[in] A value that specifies one of the WICLeadAbcQualityFactorPredefined or WICLeadAbcQualityFactorPredefined constants.

cchFriendlyName

[in] The size of the pwzFriendlyName buffer.

pwzFriendlyName

[in,out] A pointer that receives the friendly name for the component.

pcchActual

[out] A pointer that receives the actual length of the component's friendly name.

Return Values

Returns S_OK if successful, or an error value otherwise.

Remarks

Use this method to get a user-readable string representation for any of the predefined quality factor constants (WICLeadAbcQualityFactorPredefined or WICLeadAbcQualityFactorPredefined ). Call GetQualityFactorPredefinedFriendlyName once to get the length of the friendly name. Allocate the appropriately sized array. Then call GetQualityFactorPredefinedFriendlyName again, passing the allocated array as an argument. The example illustrates this technique.

Note that the GetLeadEnumFriendlyName method can also be used to obtain a readable string from any of the LEAD WIC Enumerations that are identical to the constant name.

For more information, refer to GetQualityFactorPredefined, QualityFactor, WICLeadAbcQualityFactorPredefined, and WICLeadCmpQualityFactorPredefined.

Example

For an example, refer to IWICLeadBitmapEncoder::GetQualityFactorPredefined