RepositoryPieceUtilized

 

 

Name

 

            RepositoryPieceUtilized

 

When to use it

 

            During the OnFinish event.

 

Prototype

 

            HRESULT RepositoryPieceUtilized(

                        Index: Long/*[in]*/,

                        BarIndex: Long/*[out]*/,

                        ExternalID: Long /*[out]*/

            );

 

Explanations

 

            Specify whether a given REPOSITORY piece is utilized or not.

 

Parameters

 

            - Index is the index of a piece from Repository. Index is between 0 and the NumberOfRepositoryPieces - 1.

            - BarIndex is set to the index of the layout where the REPOSITORY piece is utilized. BarIndex is set to a value between 0 and TotalNumberOfUtilizedRepositoryPieces - 1. If the piece is not utilized BarIndex will receive value -1.

            - ExternalID is the external ID of the repository piece whose input index is Index. External ID is an integer number which was assigned to each piece in order to be easier identified.

 

Remarks

 

            Not all Repository pieces are utilized.

 

 

Links

        back to index

        www.optimalprograms.com