DocumentEncoding.EncodingList Method (String, Int32, String)

DocumentEncodingEncodingList Method (String, Int32, String)

Content Studio 5.7 SDK

Content Studio Web Content Management System

[This is preliminary documentation and is subject to change.]

Returns the list of encodings available

Namespace: ContentStudio.Document
Assembly: CSServer5 (in CSServer5.dll) Version: 5.7.5016.0 (5.7.5016.0)

Syntax

public string EncodingList(
	string criteriaXml,
	out int status,
	out string statusText
)

Public Function EncodingList ( 
	criteriaXml As String,
	<OutAttribute> ByRef status As Integer,
	<OutAttribute> ByRef statusText As String
) As String

Parameters

criteriaXml: Type: SystemString
A xml document to return an encoding for a certain char set. Parameter is named 'CharSet' and is optional.
status: Type: SystemInt32
An integer indicating result of the call. Zero is success.
statusText: Type: SystemString
The textual representation of the call result.

Return Value

Type: String
XML

Copy

<xml><languages><language encoding="Short name" codepage="NNN" familycodepage="NNNN">Full name</language>
                  <!-- more entires follows-->
              </languages></xml>

Integer: the code page of the encoding; e.g. 1256

Value	Description
encoding attribute	String: the short name of the encoding; e.g. windows-1256
codepage attribute
familycodepage	Integer: the code page of the encoding family; e.g. 1256
Element value	String: The display name of the encoding; e.g. Arabic (Windows)

Remarks

This is the backwards compatible implementation of this method. This implementation does not throw any exceptions, instead callers must examine the outcome of the call in the Status and StatusText output parameters.

Reference

DocumentEncoding Class

EncodingList Overload

ContentStudio.Document Namespace