Edit

Share via

EncoderParameterValueType enumeration (gdiplusenums.h)

  • Article

The EncoderParameterValueType enumeration specifies data types for image codec (encoder/decoder) parameters. An element of this enumeration is assigned to the Type data member of an EncoderParameter object.

Syntax

typedef enum EncoderParameterValueType {
  EncoderParameterValueTypeByte = 1,
  EncoderParameterValueTypeASCII = 2,
  EncoderParameterValueTypeShort = 3,
  EncoderParameterValueTypeLong = 4,
  EncoderParameterValueTypeRational = 5,
  EncoderParameterValueTypeLongRange = 6,
  EncoderParameterValueTypeUndefined = 7,
  EncoderParameterValueTypeRationalRange = 8,
  EncoderParameterValueTypePointer = 9
} ;

Constants

 
EncoderParameterValueTypeByte
Value: 1
Specifies that the parameter is an 8-bit unsigned integer.
EncoderParameterValueTypeASCII
Value: 2
Specifies that the parameter is a null-terminated character string.
EncoderParameterValueTypeShort
Value: 3
Specifies that the parameter is a 16-bit unsigned integer.
EncoderParameterValueTypeLong
Value: 4
Specifies that the parameter is a 32-bit unsigned integer.
EncoderParameterValueTypeRational
Value: 5
Specifies that the parameter is an array of two, 32-bit unsigned integers. The pair of integers represents a fraction. The first integer in the pair is the numerator, and the second integer in the pair is the denominator.
EncoderParameterValueTypeLongRange
Value: 6
Specifies that the parameter is an array of two, 32-bit unsigned integers. The pair of integers represents a range of numbers. The first integer is the smallest number in the range, and the second integer is the largest number in the range.
EncoderParameterValueTypeUndefined
Value: 7
Specifies that the parameter is an array of bytes that can hold values of any type.
EncoderParameterValueTypeRationalRange
Value: 8
Specifies that the parameter is an array of four, 32-bit unsigned integers. The first two integers represent one fraction, and the second two integers represent a second fraction. The two fractions represent a range of rational numbers. The first fraction is the smallest rational number in the range, and the second fraction is the largest rational number in the range.
EncoderParameterValueTypePointer
Value: 9
Specifies that the parameter is a pointer to a block of custom metadata.

Requirements

Requirement Value
Minimum supported client Windows Vista [desktop apps only]
Minimum supported server Windows Server 2008 [desktop apps only]
Header gdiplusenums.h (include Gdiplus.h)

See also

EncoderParameter