Difference between revisions of "Accessing and Storing Functions"
(→Load(…)) |
RoderickGI (talk | contribs) (→SaveAdd(…)) |
||
(8 intermediate revisions by one other user not shown) | |||
Line 11: | Line 11: | ||
| arguments=name, mode | | arguments=name, mode | ||
| description= | | description= | ||
+ | {{argument optional|mode|1}} | ||
The [[#Field|Field()]] function returns the value stored in field <i>name</i>. | The [[#Field|Field()]] function returns the value stored in field <i>name</i>. | ||
The format of return is selected by <i>mode</i>. | The format of return is selected by <i>mode</i>. | ||
Line 20: | Line 21: | ||
{{argument table row|1|Formatted data}} | {{argument table row|1|Formatted data}} | ||
}} | }} | ||
− | |||
| examples= | | examples= | ||
'''{{monospace|field(album)}}''' | '''{{monospace|field(album)}}''' | ||
Line 47: | Line 47: | ||
{{function description box | {{function description box | ||
− | | name= | + | | name=Note |
| arguments=field label, field type, occurrence | | arguments=field label, field type, occurrence | ||
| description= | | description= | ||
+ | {{argument optional|field type|FIRST AVAILABLE}} | ||
+ | {{argument optional|occurrence|0}} | ||
The [[#Note|Note()]] function retrieves information from a Media Center Note. | The [[#Note|Note()]] function retrieves information from a Media Center Note. | ||
Specifically, it returns the contents associated with a <i>field label</i>, of a given <i>field type</i>. | Specifically, it returns the contents associated with a <i>field label</i>, of a given <i>field type</i>. | ||
Line 59: | Line 61: | ||
The <i>field type</i> selects the specific sub-type for a given <i>field label</i>, and <i>occurrence</i> selects which instance of | The <i>field type</i> selects the specific sub-type for a given <i>field label</i>, and <i>occurrence</i> selects which instance of | ||
several <i>field label</i> / <i>field type</i> pairs is returned. The <i>occurrence</i> value is zero-based. | several <i>field label</i> / <i>field type</i> pairs is returned. The <i>occurrence</i> value is zero-based. | ||
− | |||
− | |||
− | |||
− | |||
| examples= | | examples= | ||
'''{{monospace|note(phone)}}''' | '''{{monospace|note(phone)}}''' | ||
Line 78: | Line 76: | ||
{{function description box | {{function description box | ||
− | | name= | + | | name=Save |
| arguments=value, variable, mode | | arguments=value, variable, mode | ||
| description= | | description= | ||
+ | {{argument optional|mode|0}} | ||
This [[#Save|Save()]] function saves the <i>value</i> into the specified global <i>variable</i>, and optionally will return that <i>value</i> if <i>mode</i> is set. | This [[#Save|Save()]] function saves the <i>value</i> into the specified global <i>variable</i>, and optionally will return that <i>value</i> if <i>mode</i> is set. | ||
Once a global <i>variable</i> has been created using [[#Save|Save()]], that <i>variable</i>'s <i>value</i> is available for use with either [[#Load|Load()]] or the pseudo-field "[<i>variable</i>]". | Once a global <i>variable</i> has been created using [[#Save|Save()]], that <i>variable</i>'s <i>value</i> is available for use with either [[#Load|Load()]] or the pseudo-field "[<i>variable</i>]". | ||
Line 90: | Line 89: | ||
{{argument table row|1|Output variables <i>value</i>}} | {{argument table row|1|Output variables <i>value</i>}} | ||
}} | }} | ||
− | |||
| examples= | | examples= | ||
'''{{monospace|save(Much Money, local_bank)}}''' | '''{{monospace|save(Much Money, local_bank)}}''' | ||
Line 110: | Line 108: | ||
{{function description box | {{function description box | ||
− | | name= | + | | name=SaveAdd |
| arguments=variable, value, mode | | arguments=variable, value, mode | ||
| description= | | description= | ||
+ | {{argument optional}} | ||
The [[#SaveAdd|SaveAdd()]] function adds <i>value</i> to a global <i>variable</i> either numerically or as a list item. | The [[#SaveAdd|SaveAdd()]] function adds <i>value</i> to a global <i>variable</i> either numerically or as a list item. | ||
The <i>mode</i> argument indicates how <i>variable</i> is modified. | The <i>mode</i> argument indicates how <i>variable</i> is modified. | ||
Line 123: | Line 122: | ||
{{argument table row|2|Prepend string <i>value</i> as a list item to <i>variable</i>}} | {{argument table row|2|Prepend string <i>value</i> as a list item to <i>variable</i>}} | ||
}} | }} | ||
− | |||
| examples= | | examples= | ||
'''{{monospace|saveadd(v, 1)}}''' | '''{{monospace|saveadd(v, 1)}}''' | ||
Line 129: | Line 127: | ||
'''{{monospace|saveadd(v, math(2 - 6))}}''' | '''{{monospace|saveadd(v, math(2 - 6))}}''' | ||
: Numerically increments the global <i>variable</i> {{monospace|v}} by the outcome of the [[#Math|Math()]], which is {{monospace|-4}}. | : Numerically increments the global <i>variable</i> {{monospace|v}} by the outcome of the [[#Math|Math()]], which is {{monospace|-4}}. | ||
− | '''{{monospace| | + | '''{{monospace|save(foo, v)saveadd(v, bar, 1)load(v)}}''' |
: Loads <i>value</i> {{monospace|foo}} into <i>variable</i> {{monospace|v}}, then appends the <i>value</i> {{monospace|bar}} as a list item, and the final {{monospace|load(v)}} expression outputs the result of {{monospace|foo; bar}}. | : Loads <i>value</i> {{monospace|foo}} into <i>variable</i> {{monospace|v}}, then appends the <i>value</i> {{monospace|bar}} as a list item, and the final {{monospace|load(v)}} expression outputs the result of {{monospace|foo; bar}}. | ||
− | '''{{monospace| | + | '''{{monospace|save(That, v)saveadd(v, This, 2)load(v)}}''' |
: Similar to the previous example, but using the prepend <i>mode</i>, resulting in the output {{monospace|This; That}}. | : Similar to the previous example, but using the prepend <i>mode</i>, resulting in the output {{monospace|This; That}}. | ||
}} | }} | ||
Line 139: | Line 137: | ||
{{function description box | {{function description box | ||
− | | name= | + | | name=Tag |
| arguments=tag name | | arguments=tag name | ||
| description= | | description= |
Revision as of 19:34, 18 June 2016
- See also: Expression Language and Function Index
The functions in this section access field values, store and load global variables, access file tags, and access note fields.
Field(…)
- Returns a field's value.
Description | Field(name, mode)
The Field() function returns the value stored in field name. The format of return is selected by mode. Available mode values:
| ||||
---|---|---|---|---|---|
Examples | field(album)
field(date, 0)
|
Load(…)
- Outputs the value of a global variable.
Description | Load(varname)
Loads and outputs the value of the specified global variable varname that has been previously stored with Save(). |
---|---|
Examples | load(var1)
save(math(1 + 2), sum)load(sum)
|
Note(…)
- Retrieve note fields.
Description | Note(field label, field type, occurrence)
The Note() function retrieves information from a Media Center Note. Specifically, it returns the contents associated with a field label, of a given field type. The Nth occurrence may be requested. Notes data may be simple text, or associated with defined a field label. Currently the only type of field label is contact information. The first line of a Note is associated with the omnipresent field label Name. The field type selects the specific sub-type for a given field label, and occurrence selects which instance of several field label / field type pairs is returned. The occurrence value is zero-based. |
---|---|
Examples | note(phone)
note(phone, home)
note(phone, home)
note(phone, home, 1))
|
Save(…)
- Saves a value to a global variable.
Description | Save(value, variable, mode)
This Save() function saves the value into the specified global variable, and optionally will return that value if mode is set. Once a global variable has been created using Save(), that variable's value is available for use with either Load() or the pseudo-field "[variable]". Available mode values:
| ||||
---|---|---|---|---|---|
Examples | save(Much Money, local_bank)
save(More Money, My Bank, 1)
save(math([duration,0] / 60), durmins)if(compare([durmins], >, 5.0), Long Track, Short Track)
Additional Examples |
SaveAdd(…)
- Adds to a global variable.
Description | SaveAdd(variable, value, mode)
The SaveAdd() function adds value to a global variable either numerically or as a list item. The mode argument indicates how variable is modified. Available mode values:
| ||||||
---|---|---|---|---|---|---|---|
Examples | saveadd(v, 1)
saveadd(v, math(2 - 6))
save(foo, v)saveadd(v, bar, 1)load(v)
save(That, v)saveadd(v, This, 2)load(v)
|
Tag(…)
- Returns a file's physical tag.
Description | Tag(tag name)
The Tag() function reads and returns the value of tag name directly from a file. The Media Center Library database is not used with Tag(), and instead the specified file is read for the requested tag. The spelling and letter case of the tag name must match exactly those stored in the file. Performance note: This function must open and read the actual file, so its performance is significantly slower than other functions which operate on database fields. |
---|---|
Examples | tag(My Personal Tag)
tag(Gapless Header)
tag(exif: Date)
|