Documentation Center

OutputFormat 2.5 Create

Creates an Output Format object.


Parameters

NameTypeDirectionDescription
psAuthContextStringInOutDeprecated proprietary authentication context only used by .ASMX web services based on internal username/password authentication. Claims based security standards drive all the WCF .SVC web services making this parameter redundant.
psOutputFormatNameStringInThe name of the output format (e.g. Manual, Online Documentation, Booklet, Compiled Help,...)
psOutputEDTStringInThe unique identifier of the Electronic Document Type of the output (e.g. EDTPDF, EDTXML, EDTHTML,...)
psXMLMetaDataStringInMetadata XML structure with the metadata that will be set on the current object
psOutOutputFormatIdStringOutThe element name of the output format

Requirements are:
  • Only an 'Administrator' user can create an Output Format object.
Note that:
  • The level attribute on the ishfield element must be 'none'.
  • The name of the output format must be unique.
  • The internal element name is generated using the prefix VOUTPUTFORMAT and the given psOutputFormat value (see Naming conventions for readable Element Names).