Use this function to specify encodings for the sort prefilter.
Namespace: NetricsServerInterface
Assembly: NetricsServerInterface (in NetricsServerInterface.dll)
Syntax
| Visual Basic (Declaration) |
|---|
| Public Sub setSortEncodings( _ ByVal encodings As String()(), _ ByVal backwards_fields As Integer()() _ ) |
| C# |
|---|
| public void setSortEncodings( string[][] encodings, int[][] backwards_fields ) |
| C++ |
|---|
| public: void setSortEncodings( array<array<String>^>^ encodings, array<array<int>^>^ backwards_fields ) sealed |
| J# |
|---|
| public void setSortEncodings( string[][] encodings, int[][] backwards_fields ) |
| JScript |
|---|
| public
function setSortEncodings( encodings : String[][], backwards_fields : int[][] ) |
Parameters
- encodings
- Each string array is a list of field names which will be used for a given sort encoding. The first field name will be the primary sort key, the second field will be secondary, and so on. In general, you should have as many encodings as the number of fields in the table and use all important fields as the primary sort key in at least one encoding.
- backwards_fields
- Fields can also be sorted backwards (from the last characters in the field to the first). Important fields can and should be used as primary sort keys in both their forward and reverse directions. The backwards_fields array should be the same Length as the encodings array and the subarray at each position in the two primary arrays should also be the same Length. In this way, there is an integer in the backwards_fields arrays for each of the fields in the encodings arrays. The integer is set to 1 if the field is to be sorted in the backwards direction and 0 for the forward direction.
Remarks
It is recommended that you contact your Netrics representative for advice on which sort encodings to use for your specific application.