Main Content



Return header fields matching name or class


[fields,indices] = getFields(headers,ids) returns fields and their indices in the header fields that match the given IDs.

Input Arguments

expand all

Header fields, specified as a vector of objects.

Names to match, specified as one of the following.

  • String vector, character vector, cell array of character vectors, or comma-separated list of strings or character vectors containing the names of the fields to return. Names are not case-sensitive.

  • Vector or comma-separated list of one or more objects whose Name properties are used to determine which fields to return. Names are not case-sensitive. Header field values in these objects are ignored.

  • Vector or comma-separated list of matlab.metadata.Class objects that are subclasses of HeaderField.

    The getFields method searches for names that match names supported by the specified classes, regardless of the class. If a subclass does not have a specific set of supported names, all header fields of that subclass are matched regardless of their names. Call the HeaderField.displaySubclasses method to see supported names.

Output Arguments

expand all

Fields matching input, returned as an array of objects. If no matches exist, getFields returns an empty HeaderField array. The name search is case-insensitive.

Index values of fields, returned as an array of integers, or [] if no match.

If messages is a vector, then getFields returns fields matching ids from all messages. indices is a cell array of vectors, where indices{i} contains the indices of the matching fields in messages{i}.

Version History

Introduced in R2018a