IWICLeadBitmapEncoder::GetProgressiveOptionsFriendlyName Method

Gets the LEAD Bitmap Encoder progressive options friendly name for a particular progressive option value.

Syntax


Gets the LEAD Bitmap Encoder progressive options friendly name for a particular
                    progressive option value.

Syntax


            HRESULT GetProgressiveOptionsFriendlyName( INT nProgressiveOption,
                                                       UINT cchFriendlyName,
                                                       INT WCHAR *pwzFriendlyName,
                                                       INT UINT *pcchActual
                                                     );

Parameters

nProgressiveOption

[in] A value that specifies a progressive option.

cchFriendlyName

[in] The size of the pwzFriendlyName buffer.

pwzFriendlyName

[in,out] A pointer that receives the friendly name of 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 of a progressive option. Call the GetSubFormatFlags method to determine if a LEAD Bitmap Encoder supports progressive save options. Call GetProgressiveOptions to get the list of valid progressive options values. Call GetProgressiveOptionsFriendlyName once to get the length of the friendly name. Allocate the appropriately sized array. Then call GetProgressiveOptionsFriendlyName again, passing the allocated array as an argument. The example illustrates this technique.

For more information on progressive saves, refer to the GetSubFormatFlags method.

Example

See the example for IWICLeadBitmapEncoder::GetProgressiveOptions

References

LEAD WIC-Enabled Codecs Overview
Registering a LEAD WIC-Enabled Codec
WICLeadEnumName

Parameters

nProgressiveOption

[in] A value that specifies a progressive option.

cchFriendlyName

[in] The size of the pwzFriendlyName buffer.

pwzFriendlyName

[in,out] A pointer that receives the friendly name of 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 of a progressive option. Call the GetSubFormatFlags method to determine if a LEAD Bitmap Encoder supports progressive save options. Call GetProgressiveOptions to get the list of valid progressive options values. Call GetProgressiveOptionsFriendlyName once to get the length of the friendly name. Allocate the appropriately sized array. Then call GetProgressiveOptionsFriendlyName again, passing the allocated array as an argument. The example illustrates this technique.

For more information on progressive saves, refer to the GetSubFormatFlags method.

Example

See the example for IWICLeadBitmapEncoder::GetProgressiveOptions

References

LEAD WIC-Enabled Codecs Overview
Registering a LEAD WIC-Enabled Codec
WICLeadEnumName