←Select platform

GetItemValues Method (IContextData)

Summary

Enables a participant in a common context session to obtain the value of one or more common subject context items.

Syntax

C++

object GetItemValues(  
   object itemNames, 
   bool onlyChanges, 
   int contextCoupon 
)

Function GetItemValues( _ 
   ByVal itemNames As Object, _ 
   ByVal onlyChanges As Boolean, _ 
   ByVal contextCoupon As Integer _ 
) As Object

Object^ GetItemValues(  
   Object^ itemNames, 
   bool onlyChanges, 
   int contextCoupon 
)

Parameters

itemNames
The name of the context item values to get.

onlyChanges
Enables a participant to instruct the context manager to filter which items it returns no matter what names were specified. When the value of onlyChanges is true, then the items that are returned are limited to only the context subjects whose items were set by the most recently committed context change transaction, or by the transaction in progress, as indicated by the value of contextCoupon.

contextCoupon
The context coupon.

Return Value

A string array containing the common subject context item values.

Remarks

When the value of the input contextCoupon denotes the most recently committed transaction, the item values that are returned represent the state of the common context as it existed when the transaction was completed. When the value of the input contextCoupon denotes the transaction currently in progress, the item values that are returned represent the state of the common context as it has been established so far by the transaction

Example

For an example refer to JoinCommonContext.

Requirements

Target Platforms

See Also