| synopsis || arguments || prev || next |

kdu_params::describe_attribute

Java: Kdu_params::Describe_attribute

void describe_attribute( const char * name, kdu_message & output, bool include_comments=true)

Java: void Describe_attribute( String name, Kdu_message output, boolean include_comments)

[Declared in "../coresys/common/kdu_params.h"]

Go to class description.


Synopsis

Same as describe_attributes except that only one attribute's record structure will be described. An appropriate error message will be generated (through kdu_error) if the supplied name does not match any of the object's attributes.


Arguments

name [const char *]

If necessary, a full string match is performed on the attribute name, but you would do well to use one of the pre-defined macros for the relevant derived parameter class. These are documented with the derived classes themselves.

output [kdu_message &]

As for describe_attributes.

include_comments [bool]

As for describe_attributes.


| top || synopsis || arguments || prev || next |