GarbageWaste

 

Name

 

            GarbageWaste

 

Type

 

            Read

 

When to use it

 

            You may use this method during the OnFinish event.

 

Prototype

 

    HRESULT GarbageWaste(

            SheetIndex: long /*[in]*/,

            GarbageWaste: double /*[out]*/,

            RepositoryIndex: long /*[out]*/,

            RepositoryExternalID: long /*[out]*/

    );

 

Explanations

 

            The surface of the wastes that are garbaged (which have at least one size smaller than MinimalUsefulSize).

 

Parameters

 

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

            GarbageWaste - the surface of the garbaged waste.

            RepositoryIndex - The index of the Repository piece which is utilized in the SheetIndex layout. RepositoryIndex is between 0 and NumberOfRepositoryPieces - 1.

            RepositoryExternalID - an user defined value which was set by SetRepositoryPiece method.

 

Remark

 

   

See Also:

 

            WasteSurface, GetWastePiece, SurfaceCovered, OnFinish.