CNntpClient::GetGroupTitle Method  
 
INT GetGroupTitle(
  LPTSTR lpszGroupTitle,  
  INT nMaxLength  
);
INT GetGroupTitle(
  CString& strGroupTitle  
);

The GetGroupTitle method returns a description of the currently selected newsgroup.

Parameters

lpszGroupTitle
Pointer to a string buffer that will contain a description of the currently selected newsgroup.
nMaxLength
The maximum number of characters that may be copied into the buffer, including the terminating null character.

Return Value

If the method succeeds, the return value is the length of the description. If no newsgroup has been selected, the method will return a value of zero. If the method fails, the return value is NNTP_ERROR. To get extended error information, call GetLastError.

Remarks

The news server must support the XGTITLE command so that the group description can be obtained when the newsgroup is selected. If this command is not recognized, then no description will be returned.

Requirements

Minimum Desktop Platform: Windows 7 (Service Pack 1)
Minimum Server Platform: Windows Server 2008 R2 (Service Pack 1)
Header File: cstools10.h
Import Library: csnwsv10.lib
Unicode: Implemented as Unicode and ANSI versions.

See Also

GetGroupName, ListGroups, SelectGroup