GetUtilizedStock

Name

 

            GetUtilizedStock

 

When to use it

 

            During the OnFinish event.

 

Prototype

 

GetUtilizedStock(

            long SheetIndex/*[in]*/,

            long Type /*[out]*/,

            long StockIndex/*[out]*/,

            long StockUserDefinedData/*[out]*/

);

 

Explanations

 

            This method returns information about an utilized piece from Stock.

            The number of utilized stock pieces is obtained using the property TotalNumberOfUtilizedStock.

 

Parameters

 

            SheetIndex - the index of the layout whose information are extracted. This number is in range [0...TotalNumberOfUtilizedStock - 1].

            Type - type of the stock piece (0 if polygon, 1 if circle).

            StockIndex - The index of the stock piece which is utilized in the SheetIndex layout. StockIndex is between 0 and NumberOfStockPieces - 1.

            StockUserDefinedData - an user defined value which was set by SetStock method.

 

See also

 

            UtilizedStock, SetStock, OnFinish.