GetExcess

 

 

Name

 

            GetExcess

 

When to use it

 

            You may get the waste during the OnFinish event.

            Otherwise the returned value is undefined.

 

Prototype

 

            HRESULT GetExcess(

                        Index : Long /*in*/,

                        Length: Long/*[out]*/,

                        ExcessQuantity: Long/*[out]*/,

                        DemandIndex: Long /*[out]*/,

                        DemandExternalID: Long /*[out]*/

            );

 

Explanations

 

            The information about each excess piece.

 

Parameters

 

            Index - is the index of the excess piece whose info is request. Index must be between 0 and NumberOfExcess.

            Length - the length of the pieces that form the excess.

            ExcessQuantity- the number of pieces that were in excess.

            DemandIndex is the index of demand piece that was cut in excess. It was set by the SetDemandPiece method. RepositoryIndex is between 0 and NumberOfDemandPieces - 1.

            DemandExternalID is the external ID of the demand piece to which the waste was cut. 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