CHeader.GetOrderArraymethod
Gets the current left-to-right order of items in a header control.
Syntax
FUNCTION GetOrderArray (BYVAL hHeader AS HWND, BYVAL iCount AS LONG, BYVAL lpiArray AS LONG PTR) AS LONGParameters
| Name | Description | |
|---|---|---|
hHeader | The handle of the header control. | |
iCount | The number of integer elements that lpiArray can hold. This value must be equal to the number of items in the control (see GetItemCount). | |
lpiArray | A pointer to an array of integers that receive the index values for items in the header. |
Return value
Returns nonzero if successful, and the buffer at lpiArray receives the item number of each item in the header control in the order in which they appear from left to right. Returns zero otherwise.
Description
Gets the current left-to-right order of items in a header control.
Remarks
The number of elements in lpiArray is specified in iCount and must be equal to the number of items in the control. For example, the following code fragment will reserve enough memory to hold the index values.
Reference
- Include file
CHeader.inc - Defined in AfxNova/CHeader.inc:340
- Documented in Windows/WIndows Controls/CHeader Class.md
- Topic: CHeader Class