Jump to content

wpQueryFldrSortClass

From EDM2

This method is specific to version 3, or higher, of the OS/2 operating system.

This instance method returns the sort class object whose details are currently being used as sort criteria for a given folder.

Syntax

_wpQueryFldrSortClass(somSelf)

Parameters

somSelf (WPFolder *) - input
Pointer to the object on which the method is being invoked.
Points to an object of class WPFolder.

Returns

Class (M_WPObject *) - returns
Pointer to the class object.

How to Override

This method is generally not overridden.

Remarks

The **"sort class"** for a particular folder determines what class's sort details appear as active sort criteria for the folder's **Settings** page and sort submenu. The default sort class for all folders is WPFileSystem. The sort class can be manually changed via the folder's **Settings** page or can be programmatically changed via wpSetFldrSortClass.

Example Code

#define INCL_WINWORKPLACE
#include <os2.h>

WPFolder *somSelf; /* Pointer to the object on which the method is being invoked. */
M_WPObject *Class; /* Pointer to the class object. */

Class = _wpQueryFldrSortClass(somSelf);

Related Methods