Difference between revisions of "PRIVATE"
Helengeorge (Talk | contribs) (→Class) |
Yvonnemilne (Talk | contribs) |
||
| (11 intermediate revisions by one user not shown) | |||
| Line 1: | Line 1: | ||
| − | |||
| − | |||
==Purpose== | ==Purpose== | ||
| − | Declare memory variables private to a procedure or program | + | Declare memory variables private to a procedure or program and optionally assign a data type and value |
==Syntax== | ==Syntax== | ||
| − | PRIVATE < | + | PRIVATE <variable1> [AS <datatype>] [= <value>] [, <variable2> [AS <datatype>] [= <value>]...] | ALL [EXCEPT | LIKE <skeleton>] |
==See Also== | ==See Also== | ||
| − | [[DECLARE]], [[DIMENSION]], [[DO]], [[DISPLAY MEMORY]], [[LOCAL]], [[PARAMETERS]], [[PUBLIC]], [[SET CLIPPER]] | + | [[DECLARE]], [[DIMENSION]], [[DO]], [[DISPLAY MEMORY]], [[LOCAL]], [[NAMESPACE]], [[NAMESPACE()]], [[PARAMETERS]], [[PUBLIC]], [[SET CLIPPER]], [[SET STRICT]], [[STORE]], [[VARINFO()]] |
==Description== | ==Description== | ||
| − | The PRIVATE command provides a facility for declaring memory variables or arrays which are local to a procedure or program. When the procedure or program returns, all of the memory variables or arrays that were declared by PRIVATE, are released. The memory variables are initially declared as logicals with the value .F. | + | The PRIVATE command provides a facility for declaring memory variables or arrays which are local to a procedure or program. When the procedure or program returns, all of the memory variables or arrays that were declared by PRIVATE, are released. The memory variables are initially declared as logicals with the value .F. (if CLIPPER is set ON they are defined as 'U'). If the optional = <value> clause is included, then the specified value is assigned to the variable. |
| + | |||
| + | Memory variables and arrays declared with the optional AS <datatype> clause are subject to data type checking when a value is assigned. An attempt to assign a value of an incompatible data type will fail and return error 306. The following <datatype> values can be specified: | ||
| + | |||
| + | |||
| + | * ARRAY | ||
| + | * CHARACTER | ||
| + | * CLASSNAME | ||
| + | * CURRENCY | ||
| + | * DATE | ||
| + | * DATETIME | ||
| + | * LOGICAL | ||
| + | * NUMERIC | ||
| + | * OBJECT | ||
| + | |||
| − | You can declare PRIVATE memory variables with the same name as other memory variables, which were declared at lower levels. Any procedures or programs that are called can access these private memory variables. Any memory variables or arrays that need to be accessed globally should be declared using the PUBLIC command. By default any memory variables declared at the Recital | + | You can declare PRIVATE memory variables with the same name as other memory variables, which were declared at lower levels. Any procedures or programs that are called can access these private memory variables. Any memory variables or arrays that need to be accessed globally should be declared using the PUBLIC command. By default any memory variables declared at the Recital Developer development prompt, are declared as PUBLIC memory variables, and any others are declared as PRIVATE memory variables. |
The ALL option allows you to define all current memory variables as private. The ALL EXCEPT <skeleton> allows the user to define all the current memory variables that do not match the wildcard <skeleton> as private. The ALL LIKE <skeleton> option allows you to define all the current memory variables that match the wildcard <skeleton> specification as private. PRIVATE ALL LIKE <skeleton> and ALL EXCEPT <skeleton> will privatize the memory variables that exist as public when used in a lower level procedure. | The ALL option allows you to define all current memory variables as private. The ALL EXCEPT <skeleton> allows the user to define all the current memory variables that do not match the wildcard <skeleton> as private. The ALL LIKE <skeleton> option allows you to define all the current memory variables that match the wildcard <skeleton> specification as private. PRIVATE ALL LIKE <skeleton> and ALL EXCEPT <skeleton> will privatize the memory variables that exist as public when used in a lower level procedure. | ||
| − | See DECLARE or DIMENSION for more details on array declaration. | + | See [[DECLARE]] or [[DIMENSION]] for more details on array declaration. |
==Example== | ==Example== | ||
<code lang="recital"> | <code lang="recital"> | ||
| − | private i,j,k | + | private i as numeric = 42, j as character, k |
| − | ? | + | ? k |
.F. | .F. | ||
</code> | </code> | ||
| Line 32: | Line 44: | ||
==Products== | ==Products== | ||
| − | Recital | + | Recital, Recital Server |
[[Category:Documentation]] | [[Category:Documentation]] | ||
[[Category:Commands]] | [[Category:Commands]] | ||
[[Category:Memory Variables]] | [[Category:Memory Variables]] | ||
[[Category:Memory Variables Commands]] | [[Category:Memory Variables Commands]] | ||
Latest revision as of 10:00, 30 August 2011
Purpose
Declare memory variables private to a procedure or program and optionally assign a data type and value
Syntax
PRIVATE <variable1> [AS <datatype>] [= <value>] [, <variable2> [AS <datatype>] [= <value>]...] | ALL [EXCEPT | LIKE <skeleton>]
See Also
DECLARE, DIMENSION, DO, DISPLAY MEMORY, LOCAL, NAMESPACE, NAMESPACE(), PARAMETERS, PUBLIC, SET CLIPPER, SET STRICT, STORE, VARINFO()
Description
The PRIVATE command provides a facility for declaring memory variables or arrays which are local to a procedure or program. When the procedure or program returns, all of the memory variables or arrays that were declared by PRIVATE, are released. The memory variables are initially declared as logicals with the value .F. (if CLIPPER is set ON they are defined as 'U'). If the optional = <value> clause is included, then the specified value is assigned to the variable.
Memory variables and arrays declared with the optional AS <datatype> clause are subject to data type checking when a value is assigned. An attempt to assign a value of an incompatible data type will fail and return error 306. The following <datatype> values can be specified:
- ARRAY
- CHARACTER
- CLASSNAME
- CURRENCY
- DATE
- DATETIME
- LOGICAL
- NUMERIC
- OBJECT
You can declare PRIVATE memory variables with the same name as other memory variables, which were declared at lower levels. Any procedures or programs that are called can access these private memory variables. Any memory variables or arrays that need to be accessed globally should be declared using the PUBLIC command. By default any memory variables declared at the Recital Developer development prompt, are declared as PUBLIC memory variables, and any others are declared as PRIVATE memory variables.
The ALL option allows you to define all current memory variables as private. The ALL EXCEPT <skeleton> allows the user to define all the current memory variables that do not match the wildcard <skeleton> as private. The ALL LIKE <skeleton> option allows you to define all the current memory variables that match the wildcard <skeleton> specification as private. PRIVATE ALL LIKE <skeleton> and ALL EXCEPT <skeleton> will privatize the memory variables that exist as public when used in a lower level procedure.
See DECLARE or DIMENSION for more details on array declaration.
Example
private i as numeric = 42, j as character, k ? k .F.
Products
Recital, Recital Server
