Share via

2.2.7.1.5 parameter Element

  • Article

The parameter XML element specifies a string using attributes or nested text that provides parameter substitution information for a string specified by a body or title element.

 <xs:element name="parameter">
   <xs:complexType>
     <xs:simpleContent>
       <xs:extension
         base="xs:string"
       >
         <xs:attribute name="type"
           type="xs:string"
           use="optional"
          />
         <xs:attribute name="stringID"
           type="xs:integer"
           use="optional"
          />
         <xs:attribute name="resourceDll"
           type="xs:string"
           use="optional"
          />
       </xs:extension>
     </xs:simpleContent>
   </xs:complexType>
 </xs:element>

Attributes

Name

Type

Description

type

xs:string

The value of this optional attribute, if present, MUST be the string "PrinterName". If this value is specified, then the client MUST ignore the stringID and resourceDll attributes. For string resource formatting purposes, the client SHOULD use a recognizable name for the printer that triggered the notification.

stringID

xs:integer

The value of this optional attribute, if present, is the key of a string resource in the resource file specified by the resourceDll attribute. If the resourceDll attribute is not specified, stringID MUST be used as the key of a string resource in the default resource file.

String resources that are present in the default resource file are specified in section 2.2.6.

resourceDll

xs:string

The value of this optional attribute, if present, is the driver-file name of a resource file on the client system that contains the string resources used in this message. If neither a type attribute nor a resourceDll attribute is specified, then the default resource file MUST be used.

If neither the type nor the stringID attribute is specified, then the text content in the parameter element MUST be present and MUST be used by the client when processing position parameter replacement tags within a string specified by a title or body element.

If the type attribute is specified, then the parameter element SHOULD NOT contain nested text and the client SHOULD treat the presence of such text as an error. If stringID is present but the client is unable to load a corresponding string resource, the client SHOULD use the nested text.