GetColumnInBandInfofunction
Retrieves information regarding columns within a band.
No implementation located. This member is documented, but the source scan found no matching declaration. It is likely declared in a header this scan does not resolve, or provided by a macro.
Syntax
FUNCTION CMSHFlexGrid.GetColumnInBandInfo (BYVAL BandNumber AS LONG, BYVAL UIIndex AS LONG, BYVAL ColName AS BSTR PTR, BYVAL Caption AS BSTR PTR, BYVAL Hidden AS VARIANT_BOOL PTR, BYVAL RowsetColIndex AS LONG PTR, BYVAL Alignment AS SHORT PTR) AS HRESULTParameters
| Name | Description | |
|---|---|---|
BandNumber | Zero‑based band index of the band. | |
UIIndex | Zero‑based column index within that band. | |
ColName | Receives the underlying Recordset field name. | |
Caption | Receives the display caption for this column. | |
Hidden | Receives whether the column is hidden (VARIANT_TRUE / VARIANT_FALSE). | |
RowsetColIndex | Receives the absolute Recordset column index for this band column. | |
Alignment | Receives the alignment constant used for this column. |
Description
Undocumented. Retrieves all metadata for a specific column within a specific band (hierarchical level).
This is the internal metadata accessor for hierarchical columns. It returns everything the grid knows about a column in a specific band:
- the logical field name
- the display caption
- whether the column is hidden
- the Recordset field index this column maps to
- the alignment used for rendering
This is the low‑level API behind:
- ColHeaderCaption
- ColAlignment
- ColHidden
- BandColIndex
- CountColumnsInBand
The grid calls this internally when building the UI for shaped Recordsets.
Reference
- Documented in Windows/Windows GUI/MSHFlexGrid Class.md
- Topic: Microsoft Hierarchical Grid