![]() |
Overview Adds an element to the end of a named value list. Original class CORBA::NVList
Intended Usage
The add_value_consume method is used by a client program to populate the NVList associated with a DII request. The add_value_consume method adds an element to the end of a named value list. The newly created named value is initialized using the input argument name, value, and flags. The difference between the add_value and add_value_consume methods is that the former does not assume ownership of the input argument name and value, while the latter does. The caller may not access the memory referred to by the input parameters after they have been passed in.
See also NVList::add, NVList::add_item, and NVList::add_item_consume.
IDL Syntax
CORBA::NamedValue_ptr add_value_consume(char *id, CORBA::Any_ptr any, CORBA::Flags flags);
Input parameters
- id
- The name of the argument to be added. It is legal to pass a null pointer. If specified, the input name should match the argument name specified in the IDL definition for the operation. Ownership of this parameter transfers to the NVList.
- any
- The address of the value of the argument. It is legal to pass a null pointer. Ownership of this parameter transfers to the NVList.
- flags
- A bitmask describing the argument. The following standard flag values identify the argument passing mode:
- CORBA::ARG_IN
- The associated value is an input-only argument.
- CORBA::ARG_OUT
- The associated value is an output-only argument.
- CORBA::ARG_INOUT
- The associated value is an in/out argument.
Return values
- CORBA::NamedValue_ptr
- A pointer to the newly created named value. Ownership of the return value is maintained by the NVList; the return value must not be freed by the caller.