|
APIs in Category: client |
API version 5.0 |
client-registry-destroy |
DFM Server maintains a registry of name/value pairs on behalf of client applications. Applications can use this to store persistent data about the user's configuration of the application. Examples might be view preferences or window sizes and locations. Information in the client application registry is indexed by the name of the appliacation and the name of the user that authenticates with DataFabric Manager. The APIs determine the username automatically. Applications should pick an "application-name" that is likely to be unique. We encourage client application developers to use the application provider's company stock ticker symbol as a prefix for the application name to reduce the chance of name collisions. For example, all client applications provided by Network Appliance will use application names beginning with "NTAP". |
| client-registry-destroy | [top] |
Remove one or all name/value pairs from the persistent store.
Input Name Range Type Description application-name string
Unique name identifying the application requesting the data. match string
optional
Specify how the API should determine which name/value pairs to remove. Use "exact", the default, to specify that the option name must exactly match "option". The API returns ENAMENOTFOUND if an option by that name does not exist. Use "all" to indicate that the API should ignore the option name and return all name/value pairs. Use "regexp" to indicate that the API should interpret the option as an extended regular expression, and return all name/value pairs where the option name matches the pattern specified in "option". The API returns EINVALIDINPUTERROR if the "option" is not a valid regular expression. option string
optional
Name of the key to remove. See the description of the "match" parameter for more information.
Errno Description ENAMENOTFOUND EINVALIDINPUTERROR
| client-registry-get | [top] |
Retrieve one or all name/value string pairs.
Input Name Range Type Description application-name string
Unique name identifying the application requesting the data. match string
optional
Indicate how the API should find matching options. Use "exact", the default, to specify that the option name must exactly match "option". The API returns ENAMENOTFOUND if no option with that name exists for this application. Use "all" to indicate that the API should ignore the option name and return all name/value pairs. Use "regexp" to indicate that the API should interpret the option as an extended regular expression, and return all name/value pairs where the option name matches the pattern specified in "option". In the case of "regexp", the API returns EINVALIDINPUTERROR if the "option" is not a valid regular expression. option string
optional
Name of the registry key to fetch. See the description of the "match" parameter for more information. Output Name Range Type Description options client-option-info[]
An array of name/value pair objects.
Errno Description ENAMENOTFOUND EINVALIDINPUTERROR
| client-registry-set | [top] |
Store one or more name/value string pairs.
Input Name Range Type Description application-name string
Unique name identifying the application requesting storage. options client-option-info[]
An array of name/value pair objects.
| Element definition: client-option-info | [top] |
Single name/value pair.
Name Range Type Description option string
Key for the database to be stored. value string
The data itself.