Help Center

CRichEdit.GetTableParamsmethod

Retrieves the table parameters for a table row and the cell parameters for the specified number of cells.

Windowsmethoddocumented

Syntax

FUNCTION GetTableParams (BYVAL hRichEdit AS HWND, BYVAL lptp AS TABLEROWPARMS PTR, BYVAL lptcp AS TABLECELLPARMS PTR) AS DWORD

Parameters

NameDescription
hRichEditThe handle of the rich edit control.
lptpA pointer to a TABLEROWPARMS structure.
lptcpA pointer to a TABLECELLPARMS structure.

Return value

Returns S_OK if successful, or one of the following error codes.

Description

Retrieves the table parameters for a table row and the cell parameters for the specified number of cells.

Remarks

This message gets the table parameters for the row at the character position specified by the cpStartRow member of the TABLEROWPARMS structure, and the number of cells specified by the cCells member of the TABLECELLPARMS structure.

The character position specified by the cpStartRow member of the TABLEROWPARMS structure should be at the start of the table row, or at the end delimiter of the table row. If cpStartRow is set to 1, the character position is given by the current selection. In this case, position the selection at the end of the row (between the cell mark and the end delimiter of the table row), or select the row.

Reference

  • Defined in AfxNova/CRichEdit.inc:663
  • Documented in Windows/WIndows Controls/CRichEdit Class.md
  • Topic: CRichEdit Class