Print this Page

DICTIONARY Functions

Below is a listing of all the functions.

 

AddDictionary

AddDictionary

 

Return Type: n/a

 

Name

Type

Description

Name

String

The name of the dictionary you want to insert.

Locale

String

The locale that the dictionary should be for. A listing of the locales can be found in Appendix A.

DateFormat

String

The date format you wish to use with this dictionary (example: mm/dd/yyyy).

TimeFormat

String

The time format you wish to use with this dictionary (example: hh:mm:ss tt).

 

DeleteDictionary

DeleteDictionary

 

Return Type: n/a

 

Name

Type

Description

DictionaryID

Integer

The ID of the dictionary that you want to delete.

 

GetDictionaries

GetDictionaries

 

Return Type: Dictionary()

 

GetDictionaryByID

GetDictionaryByID

 

Return Type: Dictionary

 

Name

Type

Description

DictionaryID

Integer

The ID of the dictionary that you want to retrieve.

 

GetDictionaryForForum

GetDictionaryForForum

 

Return Type:DictionaryWord()

 

Name

Type

Description

DictionaryPath

String

The path where the dictionary can be found.

DictionaryID

Integer

The ID of the dictionary that you want to retrieve the words for.

 

GetWord

GetWord

 

Return Type: String

 

Name

Type

Description

WordID

Integer

The ID of the word you wish to retrieve.

 

UpdateDictionary

UpdateDictionary

 

Return Type: n/a

 

Name

Type

Description

Name

String

The name of the dictionary you want to insert.

Locale

String

The locale that the dictionary should be for. A listing of the locales can be found in Appendix A.

DateFormat

String

The date format you wish to use with this dictionary (example: mm/dd/yyyy).

TimeFormat

String

The time format you wish to use with this dictionary (example: hh:mm:ss tt).

DictionaryID

String

The ID of the dictionary that you want to update.