GetRepositoryPiece

 

 

Obsolated: Use GetRepositoryPiece2 instead.

 

Name

 

            GetRepositoryPiece

 

When to use it

 

            After setting the size using the SetRepositoryPiece method and before the OnFinish event ends.

 

Prototype

 

            HRESULT GetRepositoryPiece(

                        Index: Long/*[in]*/,

                        Length: Long/*[out]*/,

                        ExternalID: Long /*[out]*/

            );

 

Explanations

 

            GetRepositoryPiece returns information about each piece to be cut.

            The number of pieces to be cut is given by the NumberOfRepositoryPieces property.

            The information of each piece can be set using the SetRepositoryPiece method.

 

Parameters

 

            Index - the index of the piece whose information are extracted. This number is in range [0...NumberOfRepositoryPieces - 1].

            Length - the length of the piece.

            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.

 

 

Links

        back to index

        www.optimalprograms.com