LabWindows/CVI

WordRpt_SortTable

HRESULT WordRpt_SortTable (CAObjHandle tableHandle, int field1, int field2, WREnum_SortOrder sortOrder);

Purpose

Sorts the table according to the specified sort order.

Parameters

Input
Name Type Description
tableHandle CAObjHandle A handle to the Word Table object.

When it is no longer needed, this handle must be discarded using CA_DiscardObjHandle.
field1 int The 1–based column number of the first field according to which the sorting is to be done.
field2 int The 1–based column number of the second field according to which the sorting is to be done.
sortOrder WREnum_SortOrder The order by which to sort the table.

Can be one of the following constants:

WRConst_SortOrderAscending = 0
WRConst_SortOrderDescending = 1

Return Value

Name Type Description
status HRESULT A value indicating whether an error occurred. Function failure is indicated by a negative error code.

Error codes are defined in CVIversion\include\cviauto.h and <Program Files>\National Instruments\Shared\MSDTRedistributables\SDKHeaderFiles\8.1\winerror.h.

You can use CA_GetAutomationErrorString to get the description of an error code.

Additional Information

Library: Word Report

Include file: activex\word\WordReport.h

LabWindows/CVI compatibility: LabWindows/CVI 7.0 and later