<doc>
  <legacy_id>2068</legacy_id>
  <name>passKey</name>
  <type>property</type>
  <syntax>
    <example>set the passKey of <i>stack</i> to <i>passwordString</i></example>
  </syntax>
  <library></library>
  <objects>
    <stack/>
  </objects>
  <synonyms>
  </synonyms>
  <classification>
    <category>The System Environment</category>
  </classification>
  <references>
    <property tag="password">password Property</property>
  </references>
  <history>
    <introduced version="1.0">Added.</introduced>
  </history>
  <platforms>
    <mac/>
    <windows/>
    <linux/>
    <ios/>
    <android/>
  </platforms>
  <classes>
    <desktop/>
    <server/>
    <web/>
    <mobile/>
  </classes>
  <security>
  </security>
  <summary>Enters a <property tag="password">password</property> for a locked <object tag="stack">stack</object>, letting the user modify the <object tag="stack">stack</object>.</summary>
  <examples>
    <example>set the passKey of this stack to field "Challenge"</example>
  </examples>
  <description>
    <p>Use the <b>passKey</b> <glossary tag="property">property</glossary> to unlock a <property tag="password">password</property>-protected <object tag="stack">stack</object>.</p><p/><p><b>Value:</b></p><p>The <b>passKey</b> of a <object tag="stack">stack</object> is a <keyword tag="string">string</keyword>.</p><p/><p>By default, the <b>passKey</b> <glossary tag="property">property</glossary> of newly created <function tag="stacks">stacks</function> is set to empty.</p><p/><p><b>Comments:</b></p><p>If a stack has been locked against modification with a password, you can set the <b>passKey</b> <glossary tag="property">property</glossary> of the stack to the correct <property tag="password">password</property> to <glossary tag="unlock">unlock</glossary> the <object tag="stack">stack</object>. Setting the <b>passKey</b> <glossary tag="property">property</glossary> is the <property tag="script">script</property> equivalent of typing the <property tag="password">password</property> into LiveCode's <property tag="password">password</property> <glossary tag="dialog box">dialog box</glossary>. Use this <glossary tag="property">property</glossary> if you want to perform <property tag="password">password</property> authentication in a <glossary tag="handler">handler</glossary>.</p>
  </description>
</doc>