COleControlContainer::GetDlgItemText

Retrieves the text of the given control.

virtual int GetDlgItemText(
   int nID,
   LPTSTR lpStr,
   int nMaxCount 
) const;

Parameters

  • nID
    The identifier of the control.

  • lpStr
    Pointer to the text of the control.

  • nMaxCount
    Specifies the maximum length, in characters, of the string to be copied to the buffer pointed to by lpStr. If the length of the string exceeds the limit, the string is truncated.

Return Value

If the function succeeds, the return value specifies the number of characters copied to the buffer, not including the terminating null character.

If the function fails, the return value is zero. To get extended error information, call GetLastError.

Requirements

Header: afxocc.h

See Also

Concepts

COleControlContainer Class

COleControlContainer Members

Hierarchy Chart