Museum

Home

Lab Overview

Retrotechnology Articles

Online Manuals

⇒ bstr_vmd_load_definitions(3) — BASEstar Open Server 3.2

Media Vault

Software Library

Restoration Projects

Artifacts Sought

bstr_vmd_load_definitions(3)  —  Subroutines

Name

bstr_vmd_load_definitions − Loads the definitions associated with the specified VMD definition (MMS-modeled device connectivity only). 

Syntax

bstr_t_status   bstr_vmd_load_definitions (
                                   bstr_t_string    vmd_name,
                                   bstr_t_string    app_simple_name,
                                   bstr_t_address   vmd_handle,
                                   bstr_t_rcb       ∗control,);

Description

The bstr_vmd_load_definitions procedure loads the Named_Variables, Unnamed_Variables and AP Messages definitions in memory, from the current snapshot configuration. These definitions are all associated with the vmd_name VMD. Polling_Set definitions associated with the specified VMD are not loaded (they are loaded by the Device Services
  server).

During the loading operation, the BASEstar Open datatypes associated with Named_Variables and Unnamed_Variables are automatically converted into the corresponding MMS types. 

If app_simple_name is specified, the access point that contains this application simple name is searched for in the access point list,  pointed by the client_access_point VMD attribute. 

If app_simple_name is not specified, the first application simple name in the VMD’s client_access_point list is used. If the client_access_point_list is empty, the application simple name is assumed to be equal t  vmd_name, and the default protocol profile is used (BSTR_MMS). 

Arguments

vmd_name
access: read
The name of the VMD whose local definitions are to be loaded.

app_simple_name
access: read
The Application Simple Name specified in app_simple_name identifies which of the access points defined  in the client access list attribute is to be used to access the VMD being  loaded. 

If the client_access_point_list is empty, the application simple name is assumed to be equal to vmd_name, and the built-in BSTR_MMS protocol profile is assumed (this means that the VMD is accessed through the Device Services
  server).

The parameters specified in the selected access points are used internally by the omni_connect procedure. 

vmd_handle
access: write
A location to receive the DEComni handle of the VMD definition.

control
access: read
The address of the optional Request Control Block. It is best to specify and use the error stack to obtain the status codes returned by the internally called DEComni procedures, in case an error should occur.

Return Values

BSTR_S_BAD_PARAMETER Bad parameter value
BSTR_S_DVM_CONFIG_ERR Error opening or parsing the Snapshot file
BSTR_S_INVALID_RCB Invalid Request Control Block
BSTR_S_NORMAL Normal successful completion

Typewritten Software • bear@typewritten.org • Edmonds, WA 98026