NVList::add_item_consume

Overview Adds an element to the end of a named value list.
Original class CORBA::NVList


Intended Usage

The add_item_consume method is used by a client program to populate the NVList object associated with a DII request. The add_item_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 and flags. The difference between the add_item and add_item_consume methods is that the former does not assume ownership of the input argument name, while the latter does. The caller may not access the memory referred to by the input parameter after it has been passed in. See also the add, add_value, and add_value_consume methods.

Syntax

  CORBA::NamedValue_ptr add_item_consume(char *id, 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. The argument name must be allocated using the CORBA::string_alloc method. 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.

Related reference
CORBA module



Searchable topic ID:   rcor_modnv5
Last updated: Jun 21, 2007 8:07:48 PM CDT    WebSphere Business Integration Server Foundation, Version 5.0.2
http://publib.boulder.ibm.com/infocenter/wasinfo/index.jsp?topic=/com.ibm.wasee.doc/info/ee/corba/ref/rcor_modnv5.html

Library | Support | Terms of Use | Feedback