VS:GetSprdSortSum

From Vectorworks Developer
Revision as of 14:32, 12 August 2013 by Root (talk | contribs) (1 revision)
(diff) ← Older revision | Latest revision (diff) | Newer revision → (diff)
Jump to navigation Jump to search
The printable version is no longer supported and may have rendering errors. Please update your browser bookmarks and please use the default browser print function instead.

.VectorScript|VectorScript ..VS:Function Reference|Function Reference ..VS:Function_Reference_Appendix|Appendix

Description

Procedure GetSprdSortSum returns sorting and summation options for a database row in the referenced worksheet.

PROCEDURE GetSprdSortSum(
sheetHd :HANDLE;
row :INTEGER;
VAR sortCol1 :INTEGER;
VAR sortCol2 :INTEGER;
VAR sortCol3 :INTEGER;
VAR sumCol :INTEGER);
def vs.GetSprdSortSum(sheetHd, row):
    return (sortCol1, sortCol2, sortCol3, sumCol)

Parameters

sheetHd HANDLE Handle to worksheet.
row INTEGER Worksheet database row index.
sortCol1 INTEGER Primary sort column index.
sortCol2 INTEGER Secondary sort column index.
sortCol3 INTEGER Tertiary sort column index.
sumCol INTEGER Summation column.

Remarks

Gets sorting for a database row. The sortCol1, sortCol2, and sortCol3 values specify the primary, secondary and tertiary sorts for the database row. For descending sorts, a positive column is returned; for ascending sorts, a negative column is returned. For no sort, 0 is returned. Sum works the same way. [VML 01/09/01]

Version

GetSprdSortSum is obsolete as of VectorWorks 9.0, see new GetWSColumnOperators.

Availability: from VectorWorks 8.0

See Also

GetWSColumnOperators

[[VS:GetWSColumnOperators | GetWSColumnOperators]]