Polycom VIEWSTATION EX Manual De Usuario

Descargar
Página de 224
ViewStation EX, ViewStation FX, and VS4000 API Guide    
© Polycom, Inc. 2003
13
Syntax Summary
The following syntactic notation is used for the API shell control 
commands. 
Note  All defined commands are case sensitive.
<x>  
A required parameter. The text between the angled 
brackets is one or more parameter(s) that can occur at the 
specified point in the command. Multiple parameters are 
listed separated by the “|” character (pipe) which is a 
notational shortcut for "or.” If the text between the angled 
brackets is in parenthesis, then it is a user comment of the 
expected parameter, rather than an enumeration of the 
valid parameters.
Example
allowdialing <yes|no|get>
[x]  
An optional parameter. As with required parameters, 
optional parameters may be presented with a '|' character 
(pipe) to indicate choices. 
Example
gabpassword <set|get> ["password"]
.. 
Indicates a range of values.
Example
displaybolt <n|{0..100}>
"x" 
String parameters to be supplied by the user are denoted 
with quoted strings (example: “symbol”). In general, 
parameters are supplied from a set of defined string 
values that are specifically enumerated. These values are 
command specific. Note: a quoted string parameter can 
contain any value. 
Example
The command gabpassword <set|get> ["password"] 
requires that the user supply the string parameter 
password as shown in the following example:
gabpassword set MyPassword