[Enterprise Extensions only]

Context::get_values

Overview Retrieves one or more property values.
Original class CORBA::Context
Exceptions CORBA::SystemException


Intended Usage

The get_values method retrieves the specified context property values. If the property name has a trailing wildcard character ("*"), then all matching properties and their values are returned. If a matching property is not found at the starting scope, the search optionally continues up the context tree until a match is found or all contexts in the chain have been exhausted.

IDL Syntax

  CORBA::Status get_value(const char *start_scope,
                          CORBA::Flags op_flags,
                          const char *prop_name,
                          CORBA::NVList_ptr &values);

Input parameters

start_scope
An identifier specifying the name of the context at which the search should begin. If the search scope is not specified, the search begins with the target Context object. If the specified search scope is not found, a system exception is raised.
op_flags
CORBA::CTX_RESTRICT_SCOPE may be used to indicate searching is limited to the specified search scope. By default, the entire context tree is searched.
prop_name
An identifier specifying the name of the properties to return. To specify multiple properties, pass an identifier with a trailing wildcard character.
values
The pointer for an NVList object, passed by reference, to be updated by the get_values method to point to the resulting NVList. Ownership of the returned object transfers to the caller. Memory should be freed by calling CORBA::release(NVList_ptr).The pointer for an NVList object, passed by reference, to be updated by the get_values method to point to the resulting NVList. Ownership of the returned object transfers to the caller. Memory should be freed by calling CORBA::release(NVList_ptr).

Return values

CORBA::Status
A zero return code indicates that one or more property values were successfully returned. If no matching property name is found, -1 is returned.