Loading

ocePrtInputMediaName

OID: 1.3.6.1.4.1.1552.22.10.2.43.8.2.1.12.1.<ocePrtInputIndex>

The ocePrtInputIndex is a value from 1 - N, which represents an input tray of the system. N is the total number of available input trays.

The media and its attributes are defined in the media catalogue. The media is returned as a human readable string in the following format:

  • Media name - can be empty

  • appended with the media size,

  • appended with "weight g/m²" (e.g: 80 g/m²) - not communicated if weight is zero,

  • appended with "Tab" if it is a tab media,

  • appended with "Insert" if it is an insert sheet,

  • appended with "Cyclic(length)" or "Cyclic" for cyclic media,

  • appended with the media type (e.g. "Color copy"),

  • appended with the media colour,

  • appended with "Punched(#holes)" if pre-punched.

The media name must be followed by “; “ (semicolon+space). All other media attributes must be separated with ", " (comma+space). When a media attribute is empty, the media name and its comma will be omitted from the returned string. The string is encoded in UTF-8 without byte order mark (BOM). ocePrtInputMediaName can contain a maximum of 1023 bytes.

Example of returned string

My A4; A4, 80 g/m², Cyclic(5), Color copy, White

Special cases

  • Special case when the media name is empty:

    ; A4, 80 g/m², Cyclic(5), Color copy, White

  • Special case for a custom media size:

    ; 2230x2970, 80 g/m², Cyclic(5), Color copy, White

  • Special case when only a media name is provided (no semicolon/space):

    <media name>

  • Special case when all media attributes are empty:

    <empty string>

  • Special case when no media is assigned to the tray:

    undefined

Remarks

The media name and the media type are user provided strings. The user can type strings with extra semicolons for the media name and type. For example, "My; A4; media". In this case, it is recommended to interpret the last occurring semicolon+space as media name separator.

Also, the user can type "undefined" as media name without providing additional media attributes. Now, the returned string is "undefined" and this string is equal to the special case when no media is assigned to the tray. Therefore, it is recommended to treat this as the special case when no media is assigned to the tray.

None of the communicated strings (Tab, Insert, Cyclic, Punched) and units (g/m²) are localised. This also means that g/m2 is returned when your system is configured to use imperial units.