Fnd_Dict
40 shared methods.
- Fnd_Dict_DataType
- Fnd_Dict_GetArray
- Fnd_Dict_GetBoolean
- Fnd_Dict_GetDate
- Fnd_Dict_GetLongint
- Fnd_Dict_GetPointer
- Fnd_Dict_GetReal
- Fnd_Dict_GetText
- Fnd_Dict_GetTime
- Fnd_Dict_GetValue
- Fnd_Dict_HasKey
- Fnd_Dict_ID
- Fnd_Dict_Info
- Fnd_Dict_IsValid
- Fnd_Dict_ItemCount
- Fnd_Dict_Key
- Fnd_Dict_Keys
- Fnd_Dict_Load
- Fnd_Dict_LoadFromBlob
- Fnd_Dict_LoadFromFile
- Fnd_Dict_LockInternalState
- Fnd_Dict_Name
- Fnd_Dict_New
- Fnd_Dict_Release
- Fnd_Dict_Remove
- Fnd_Dict_Retain
- Fnd_Dict_RetainCount
- Fnd_Dict_Save
- Fnd_Dict_SaveToBlob
- Fnd_Dict_SaveToFile
- Fnd_Dict_SetArray
- Fnd_Dict_SetBoolean
- Fnd_Dict_SetDate
- Fnd_Dict_SetLongint
- Fnd_Dict_SetPointer
- Fnd_Dict_SetReal
- Fnd_Dict_SetText
- Fnd_Dict_SetTime
- Fnd_Dict_SetValue
- Fnd_Dict_Values
Fnd_Dict_DataType
Fnd_Dict_DataType (dict ID; key name) --> Number
Returns the data type of a key.
| Parameter | Type | Direction | Description |
|---|---|---|---|
dictionary | Longint | in | Dictionary ID |
key | Text | in | Key name |
Result | Longint | out | Data type |
Fnd_Dict_GetArray
Fnd_Dict_GetArray (dict ID; key name; ->values)
Returns an array of values from a dictionary given a key.
| Parameter | Type | Direction | Description |
|---|---|---|---|
dictionary | Longint | in | Dictionary ID |
key | Text | in | Key name |
value | Pointer | in | Text array to receive values |
Fnd_Dict_GetBoolean
Fnd_Dict_GetBoolean (dict ID; key) --> Boolean
Returns a Boolean value from a dictionary given a key.
| Parameter | Type | Direction | Description |
|---|---|---|---|
dictionary | Longint | in | Dictionary ID |
key | Text | in | Key name |
Result | Boolean | out | The key's value |
Fnd_Dict_GetDate
Fnd_Dict_GetDate (dict ID; key) --> Date
Returns a date value from a dictionary given a key.
| Parameter | Type | Direction | Description |
|---|---|---|---|
dictionary | Longint | in | Dictionary ID |
key | Text | in | Key name |
Result | Date | out | The key's value |
Fnd_Dict_GetLongint
Fnd_Dict_GetLongint (dict ID; key) --> Longint
Returns a longint value from a dictionary given a key.
| Parameter | Type | Direction | Description |
|---|---|---|---|
dictionary | Longint | in | Dictionary ID |
key | Text | in | Key name |
Result | Longint | out | The key's value |
Fnd_Dict_GetPointer
Fnd_Dict_GetPointer (dict ID; key) --> Pointer
Returns a pointer value from a dictionary given a key.
| Parameter | Type | Direction | Description |
|---|---|---|---|
dictionary | Longint | in | Dictionary ID |
key | Text | in | Key name |
Result | Pointer | out | The key's value |
Fnd_Dict_GetReal
Fnd_Dict_GetReal (dict ID; key) --> Real
Returns a real value from a dictionary given a key
| Parameter | Type | Direction | Description |
|---|---|---|---|
dictionary | Longint | in | Dictionary ID |
key | Text | in | Key name |
Result | Real | out | The key's value |
Fnd_Dict_GetText
Fnd_Dict_GetText (dict ID; key) --> Text
Returns a text value from a dictionary given a key.
| Parameter | Type | Direction | Description |
|---|---|---|---|
dictionary | Longint | in | Dictionary ID |
key | Text | in | Key name |
Result | Text | out | The key's value |
Fnd_Dict_GetTime
Fnd_Dict_GetTime (dict ID; key) --> Time
Returns a time value from a dictionary given a key.
| Parameter | Type | Direction | Description |
|---|---|---|---|
dictionary | Longint | in | Dictionary ID |
key | Text | in | Key name |
Result | Time | out | The key's value |
Fnd_Dict_GetValue
Fnd_Dict_GetValue (dict ID; key) --> Text
Returns a value from a dictionary given a key
| Parameter | Type | Direction | Description |
|---|---|---|---|
dictionary | Longint | in | Dictionary ID |
key | Text | in | Key name |
Result | Text | out | The key's value as text |
Fnd_Dict_HasKey
Fnd_Dict_HasKey (dict ID; key) --> Boolean
Checks whether a dictionary contains a given key.
| Parameter | Type | Direction | Description |
|---|---|---|---|
dictionary | Longint | in | Dictionary ID |
key | Text | in | Key name |
Result | Boolean | out | True if the key exists |
Fnd_Dict_ID
Fnd_Dict_ID (name) --> Number
Returns the reference number of the dictionary with the specified name.
Returns 0 if the dictionary does not exist.
| Parameter | Type | Direction | Description |
|---|---|---|---|
name | Text | in | A dictionary name |
Result | Longint | out | The dictionary's reference number |
Fnd_Dict_Info
Fnd_Dict_Info (label) --> Text
Returns requested information. See the Fnd_Gen_ComponentInfo method for more information.
| Parameter | Type | Direction | Description |
|---|---|---|---|
request | Text | in | Info desired ("version" or "name") |
Result | Text | out | Response |
Fnd_Dict_IsValid
Fnd_Dict_IsValid (dict ID) --> Boolean
Checks whether a dictionary reference is valid.
| Parameter | Type | Direction | Description |
|---|---|---|---|
dictionary | Longint | in | Dictionary ID |
Result | Boolean | out | True if the dictionary reference is valid |
Fnd_Dict_ItemCount
Fnd_Dict_ItemCount (dict ID) --> Number
Returns the number of items in a dictionary.
| Parameter | Type | Direction | Description |
|---|---|---|---|
dictionary | Longint | in | Dictionary ID |
Result | Longint | out | Item count |
Fnd_Dict_Key
Fnd_Dict_Key (dict ID; key number) --> Text
Returns the nth key from a dictionary.
| Parameter | Type | Direction | Description |
|---|---|---|---|
dictionary | Longint | in | Dictionary ID |
index | Longint | in | Key number |
Result | Text | out | The key's value as text |
Fnd_Dict_Keys
Fnd_Dict_Keys (dict ID; ->keys array)
Fills an array with the keys in a dictionary.
| Parameter | Type | Direction | Description |
|---|---|---|---|
dictionary | Longint | in | Dictionary ID |
array | Pointer | in | Text array |
Fnd_Dict_Load
Fnd_Dict_Load (->blob or path)
Loads a dictionary from either a blob or a file
| Parameter | Type | Direction | Description |
|---|---|---|---|
source | Pointer | in | Dictionary or path |
Result | Longint | out | Dictionary ID |
Fnd_Dict_LoadFromBlob
Fnd_Dict_LoadFromBlob (->blob) --> Longint
Loads a dictionary from a BLOB.
| Parameter | Type | Direction | Description |
|---|---|---|---|
source | Pointer | in | Dictionary as blob |
Result | Longint | out | Dictionary ID |
Fnd_Dict_LoadFromFile
Fnd_Dict_LoadFromFile (path) --> Longint
Loads a dictionary from a file.
| Parameter | Type | Direction | Description |
|---|---|---|---|
filename | Text | in | File path |
Result | Longint | out | Dictionary ID |
Fnd_Dict_LockInternalState
Fnd_Dict_LockInternalState (lock?)
Locks the internal state for the dictionary module.
| Parameter | Type | Direction | Description |
|---|---|---|---|
lock | Boolean | in | True to Lock, False to Unlock |
Fnd_Dict_Name
Fnd_Dict_Name (dict ID) --> Text
Returns the name of the dictionary.
| Parameter | Type | Direction | Description |
|---|---|---|---|
dictionary | Longint | in | Dictionary ID |
Result | Text | out | Dictionary Name |
Fnd_Dict_New
Fnd_Dict_New ({name}) --> Longint
Creates a new dictionary and returns a refernece to it.
| Parameter | Type | Direction | Description |
|---|---|---|---|
inName | Text | in | Name (optional) |
Result | Longint | out | Dictionary ID |
Fnd_Dict_Release
Fnd_Dict_Release (dict ID)
Decrements the retain count of a dictionary and deletes it when the retain count reaches 0.
| Parameter | Type | Direction | Description |
|---|---|---|---|
dictionary | Longint | in | Dictionary ID |
Fnd_Dict_Remove
Fnd_Dict_Remove (dict ID; key)
Removes a key from a dictionary.
| Parameter | Type | Direction | Description |
|---|---|---|---|
dictionary | Longint | in | Dictionary ID |
key | Text | in | Key name |
Fnd_Dict_Retain
Fnd_Dict_Retain (dict ID)
Increments the retain count for a dictionary.
| Parameter | Type | Direction | Description |
|---|---|---|---|
dictionary | Longint | in | Dictionary ID |
Fnd_Dict_RetainCount
Fnd_Dict_RetainCount (dict ID) --> Longint
Returns the retain count for a dictionary
| Parameter | Type | Direction | Description |
|---|---|---|---|
dictionary | Longint | in | Dictionary ID |
Result | Longint | out | Retain count |
Fnd_Dict_Save
Fnd_Dict_Save (dict ID; ->blob or path)
Saves a dictionary as either a blob or a file.
| Parameter | Type | Direction | Description |
|---|---|---|---|
dictionary | Longint | in | Dictionary ID |
blobPath | Pointer | in | Blob or path |
Fnd_Dict_SaveToBlob
Fnd_Dict_SaveToBlob (dict ID; ->blob)
Saves a dictionary as a blob.
| Parameter | Type | Direction | Description |
|---|---|---|---|
dictionary | Longint | in | Dictionary ID |
destination | Pointer | in | Blob to store dictionary |
Fnd_Dict_SaveToFile
Fnd_Dict_SaveToFile (dict ID; path)
Saves a dictionary as a file.
| Parameter | Type | Direction | Description |
|---|---|---|---|
dictionary | Longint | in | Dictionary ID |
filename | Text | in | Path to the file to create (or update) |
Fnd_Dict_SetArray
Fnd_Dict_SetArray (dict ID; key; ->array)
Stores an array of values inside a dictionary.
| Parameter | Type | Direction | Description |
|---|---|---|---|
dictionary | Longint | in | Dictionary ID |
key | Text | in | Key |
value | Pointer | in | Array |
Fnd_Dict_SetBoolean
Fnd_Dict_SetBoolean (dict ID; key; Boolean value)
Assigns a Boolean value to a dictionary given a key.
| Parameter | Type | Direction | Description |
|---|---|---|---|
dictionary | Longint | in | Dictionary ID |
key | Text | in | Key name |
value | Boolean | in | Value to store |
Fnd_Dict_SetDate
Fnd_Dict_SetDate (dict ID; key; date value)
Assigns a date value to a dictionary given a key.
| Parameter | Type | Direction | Description |
|---|---|---|---|
dictionary | Longint | in | Dictionary ID |
key | Text | in | Key name |
value | Date | in | Value to store |
Fnd_Dict_SetLongint
Fnd_Dict_SetLongint (dict ID; key; longint value)
Assigns a longint value to a dictionary given a key.
| Parameter | Type | Direction | Description |
|---|---|---|---|
dictionary | Longint | in | Dictionary ID |
key | Text | in | Key name |
value | Longint | in | Value to store |
Fnd_Dict_SetPointer
Fnd_Dict_SetPointer (dict ID; key; pointer)
Assigns a pointer value to a dictionary given a key
| Parameter | Type | Direction | Description |
|---|---|---|---|
dictionary | Longint | in | Dictionary ID |
key | Text | in | Key name |
value | Pointer | in | Pointer to store |
Fnd_Dict_SetReal
Fnd_Dict_SetReal (dict ID; key; real value)
Assigns a real value to a dictionary given a key
| Parameter | Type | Direction | Description |
|---|---|---|---|
dictionary | Longint | in | Dictionary ID |
key | Text | in | Key name |
value | Real | in | Value to store |
Fnd_Dict_SetText
Fnd_Dict_SetText (dict ID; key; text value)
Assigns a text value to a dictionary given a key
| Parameter | Type | Direction | Description |
|---|---|---|---|
dictionary | Longint | in | Dictionary ID |
key | Text | in | Key name |
value | Text | in | Value to store |
Fnd_Dict_SetTime
Fnd_Dict_SetTime (dict ID; key; time value)
Assigns a time value to a dictionary given a key
| Parameter | Type | Direction | Description |
|---|---|---|---|
dictionary | Longint | in | Dictionary ID |
key | Text | in | Key name |
value | Time | in | Value to store |
Fnd_Dict_SetValue
Fnd_Dict_SetValue (dict ID; key; value as text; data type)
Assigns a value to a dictionary given a key
| Parameter | Type | Direction | Description |
|---|---|---|---|
dictionary | Longint | in | Dictionary ID |
key | Text | in | Key name |
value | Text | in | Value to store |
type | Longint | in | Data type |
Fnd_Dict_Values
Fnd_Dict_Values (dict ID; ->array)
Fills an array with the values in a dictionary.
| Parameter | Type | Direction | Description |
|---|---|---|---|
dictionary | Longint | in | Dictionary ID |
array | Pointer | in | Array to receive values |