IPB_Session interface:

SetArrayItemValue method

Description

Sets the value of an array item to the value of an IPB_Value.

Syntax

SetArrayItemValue( pbarray <span>array</span>, pblong <span>dim</span>[ ]<span></span>, IPB_Value* <span>src</span>)

1	SetArrayItemValue( pbarray <span>array</span>, pblong <span>dim</span>[ ]<span></span>, IPB_Value* <span>src</span>)

Argument	Description
array	A valid pbarray structure in which you want to set an array item to null.
dim	A pblong array to hold the indexes of each dimension of the array. The size of the array must equal the dimensions of array.
src	The value to which the array item is to be changed.

Return Values

None.

Examples

This code sets the value of each item in an array:

for( i=1; i &lt;= bound; i++)<br>{<br>&#160;&#160;&#160;dim[0]= i;<br>&#160;&#160;&#160;ipv = Session -&gt; AcquireArrayItemValue(refArg, dim);<br>&#160;&#160;&#160;Session -&gt; SetArrayItemValue(*i_array, dim, ipv);<br>&#160;&#160;&#160;Session -&gt; ReleaseValue(ipv);<br>}

1	for( i=1; i <= bound; i++)<br>{<br>   dim[0]= i;<br>   ipv = Session -> AcquireArrayItemValue(refArg, dim);<br>   Session -> SetArrayItemValue(*i_array, dim, ipv);<br>   Session -> ReleaseValue(ipv);<br>}

Usage

The SetArrayItemValue method does not verify
that the datatype of the replacement value matches the datatype
of the original value.

August 20, 2023

Was this article helpful?

SetArrayItemValue – PB Docs 150