Monkeybread Software - MBS FileMaker Plugin: Dictionary.ValueForKey

Components	All	New	MacOS		Windows		Linux		iOS
Examples	Mac & Win		Server	Client	Guides	Statistic	FMM	Blog	Deprecated	Old

Dictionary.ValueForKey

Queries value for the key.

Component	Version	macOS	Windows	Linux	Server	iOS SDK
Dictionary	5.0	✅ Yes	✅ Yes	✅ Yes	✅ Yes	✅ Yes

MBS( "Dictionary.ValueForKey"; DictionaryRef; Key ) More

Parameters

Parameter Description Example

DictionaryRef The reference number to the dictionary. $dic

Key The key to use. Keys are case sensitive. "FirstName"

Parameter	Description	Example
DictionaryRef	The reference number to the dictionary.	$dic
Key	The key to use. Keys are case sensitive.	"FirstName"

Result

Returns value or error.

Description

Queries value for the key.
As dictionary preserves data type, result can be empty, text, number, date, time, timestamp, container or boolean.
Returns an error, if key is not found. See Dictionary.Lookup to pass default value.

Examples

Serialize and unserialize with date and time:

# Create Dictionary
Set Variable [$dict; Value:MBS ( "Dictionary.Create" )]
# put date and time inside:
Set Variable [$r; Value:MBS ( "Dictionary.SetValueForKey"; $dict; "theTime"; Get ( CurrentTime ))]
Set Variable [$r; Value:MBS ( "Dictionary.SetValueForKey"; $dict; "theDate"; Get ( CurrentDate ))]
# Serialize this
Set Variable [$dictEncoded; Value:MBS ( "Dictionary.Serialize"; $dict )]
#Free dictionary
Set Variable [$r; Value:MBS ( "Dictionary.Release"; $dict )]
# Unpack it:
Set Variable [$newDict; Value:MBS ( "Dictionary.Deserialize"; $dictEncoded )]
# and get values
Set Variable [$TheTime; Value: MBS ( "Dictionary.ValueForKey"; $newDict; "theTime" )]
Set Variable [$TheDate; Value: MBS ( "Dictionary.ValueForKey"; $newDict; "theDate" )]
Show Custom Dialog [$TheTime & " " & $TheDate]
Set Variable [$r; Value:MBS ( "Dictionary.Release"; $newDict )]

<?xml version="1.0" encoding="UTF-8"?>
<fmxmlsnippet type="FMObjectList">
  <Step enable="True" id="89" name="# (comment)">
    <Text> Create Dictionary</Text>
  </Step>
  <Step enable="True" id="141" name="Set Variable">
    <Value>
      <Calculation>MBS ( "Dictionary.Create" )</Calculation>
    </Value>
    <Repetition>
      <Calculation>1</Calculation>
    </Repetition>
    <Name>$dict</Name>
  </Step>
  <Step enable="True" id="89" name="# (comment)">
    <Text> put date and time inside:</Text>
  </Step>
  <Step enable="True" id="141" name="Set Variable">
    <Value>
      <Calculation>MBS ( "Dictionary.SetValueForKey"; $dict; "theTime"; Get ( CurrentTime ))</Calculation>
    </Value>
    <Repetition>
      <Calculation>1</Calculation>
    </Repetition>
    <Name>$r</Name>
  </Step>
  <Step enable="True" id="141" name="Set Variable">
    <Value>
      <Calculation>MBS ( "Dictionary.SetValueForKey"; $dict; "theDate"; Get ( CurrentDate ))</Calculation>
    </Value>
    <Repetition>
      <Calculation>1</Calculation>
    </Repetition>
    <Name>$r</Name>
  </Step>
  <Step enable="True" id="89" name="# (comment)">
    <Text> Serialize this</Text>
  </Step>
  <Step enable="True" id="141" name="Set Variable">
    <Value>
      <Calculation>MBS ( "Dictionary.Serialize"; $dict )</Calculation>
    </Value>
    <Repetition>
      <Calculation>1</Calculation>
    </Repetition>
    <Name>$dictEncoded</Name>
  </Step>
  <Step enable="True" id="89" name="# (comment)">
    <Text>Free dictionary</Text>
  </Step>
  <Step enable="True" id="141" name="Set Variable">
    <Value>
      <Calculation>MBS ( "Dictionary.Release"; $dict )</Calculation>
    </Value>
    <Repetition>
      <Calculation>1</Calculation>
    </Repetition>
    <Name>$r</Name>
  </Step>
  <Step enable="True" id="89" name="# (comment)">
    <Text> Unpack it:</Text>
  </Step>
  <Step enable="True" id="141" name="Set Variable">
    <Value>
      <Calculation>MBS ( "Dictionary.Deserialize"; $dictEncoded )</Calculation>
    </Value>
    <Repetition>
      <Calculation>1</Calculation>
    </Repetition>
    <Name>$newDict</Name>
  </Step>
  <Step enable="True" id="89" name="# (comment)">
    <Text> and get values</Text>
  </Step>
  <Step enable="True" id="141" name="Set Variable">
    <Value>
      <Calculation>MBS ( "Dictionary.ValueForKey"; $newDict; "theTime" )</Calculation>
    </Value>
    <Repetition>
      <Calculation>1</Calculation>
    </Repetition>
    <Name>$TheTime</Name>
  </Step>
  <Step enable="True" id="141" name="Set Variable">
    <Value>
      <Calculation>MBS ( "Dictionary.ValueForKey"; $newDict; "theDate" )</Calculation>
    </Value>
    <Repetition>
      <Calculation>1</Calculation>
    </Repetition>
    <Name>$TheDate</Name>
  </Step>
  <Step enable="True" id="87" name="Show Custom Dialog">
    <Title>
      <Calculation>$TheTime &amp; " " &amp; $TheDate</Calculation>
    </Title>
    <Message>
      <Calculation/>
    </Message>
    <Buttons>
      <Button CommitState="True">
        <Calculation>"OK"</Calculation>
      </Button>
      <Button CommitState="False">
        <Calculation>"Cancel"</Calculation>
      </Button>
      <Button CommitState="False"/>
    </Buttons>
  </Step>
  <Step enable="True" id="141" name="Set Variable">
    <Value>
      <Calculation>MBS ( "Dictionary.Release"; $newDict )</Calculation>
    </Value>
    <Repetition>
      <Calculation>1</Calculation>
    </Repetition>
    <Name>$r</Name>
  </Step>
</fmxmlsnippet>

Example Databases

Blog Entries

This function checks for a license.

Created 12nd December 2014, last changed 15th February 2022

Dictionary.ToXML - Dictionary.ValueTypeForKey

💬 Ask a question or report a problem