Skip to content

Commit

Permalink
docs : upload variable function documentation
Browse files Browse the repository at this point in the history
  • Loading branch information
nickorr committed Jul 16, 2024
1 parent d056d6d commit a0424e2
Show file tree
Hide file tree
Showing 2 changed files with 11 additions and 9 deletions.
9 changes: 5 additions & 4 deletions docs/Functions/BE_VariableGet.md
Original file line number Diff line number Diff line change
@@ -1,14 +1,14 @@
## BE_VariableGet

BE_VariableGet ( name )
BE_VariableGet ( name )

**Description**

This function gets the previously stored variable of name.
Gets the value of the previously stored plugin variable with *name*.

**Parameters**

* *name* : The name of the variable to return.
* *name* : the name of the variable to return.

**Keywords**

Expand All @@ -22,6 +22,8 @@ Variable Get

Plugin variables are much like $local and $$global FileMaker variables, except the scope is the instance of the plugin, so will persist across FileMaker files and even on closing and opening of files. They are only lost when the plugin is loaded or unloaded, usually only ever when FileMaker restarts.

On FileMaker Server they exist in a single session, and not across different sessions as each session is a new application launch effectively.

**Compatibility**

| Platform | Compatibility |
Expand All @@ -34,4 +36,3 @@ Plugin variables are much like $local and $$global FileMaker variables, except t
| Linux | Yes |

**Example Code**

11 changes: 6 additions & 5 deletions docs/Functions/BE_VariableSet.md
Original file line number Diff line number Diff line change
@@ -1,15 +1,15 @@
## BE_VariableSet

BE_VariableSet ( name ; { value } )
BE_VariableSet ( name ; { value } )

**Description**

This function creates and sets a variable of *name* with *value*.
Sets *value* into a plugin preference with name of *name*.

**Parameters**

* *name* : The name of the variable to create/set.
* *value* ( optional ) : The value to store. Optional because an empty value will delete that variable.
* *name* : the name of the variable to return.
* *value* ( optional ) : the value to store. An empty value will delete that variable.

**Keywords**

Expand All @@ -23,6 +23,8 @@ Variable Set

Plugin variables are much like $local and $$global FileMaker variables, except the scope is the instance of the plugin, so will persist across FileMaker files and even on closing and opening of files. They are only lost when the plugin is loaded or unloaded, usually only ever when FileMaker restarts.

On FileMaker Server they exist in a single session, and not across different sessions as each session is a new application launch effectively.

**Compatibility**

| Platform | Compatibility |
Expand All @@ -35,4 +37,3 @@ Plugin variables are much like $local and $$global FileMaker variables, except t
| Linux | Yes |

**Example Code**

0 comments on commit a0424e2

Please sign in to comment.