|
|
| INT
NntpGetGroupTitle(
|
|
|
HCLIENT
hClient, |
|
|
|
|
LPTSTR
lpszGroupTitle, |
|
|
|
|
INT nMaxLength |
|
|
| );
|
The NntpGetGroupTitle function returns a description of
the currently selected newsgroup.
Parameters
- hClient
- Handle to the client session.
- lpszGroupTitle
- Pointer to a null-terminated 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-byte.
Return Value
If the function succeeds, the return value is the length of the
description. If no newsgroup has been selected, the function will
return a value of zero. If the function fails, the return value is
NNTP_ERROR. To get extended error information, call
NntpGetLastError.
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
Client: Requires Windows Vista, Windows XP or Windows
2000 Professional.
Server: Requires Windows Server 2008, Windows Server 2003 or
Windows 2000 Server.
Header: Include cstools6.h.
Library: Use csnwsav6.lib.
Unicode: Implemented as Unicode and ANSI versions.
See Also
NntpGetGroupName, NntpListGroups, NntpListNewGroups, NntpSelectGroup
|
|