chatGetChannelTopic
Queries the server for the specified channel’s topic. Also known as the room description.
- void chatGetChannelTopic(
- CHAT chat,
- const gsi_char * channel,
- chatGetChannelTopicCallback callback,
- void * param,
- CHATBool blocking );
| Routine | Required Header | Distribution |
|---|---|---|
| chatGetChannelTopic | <chat.h> | SDKZIP |
Parameters
- chat
- [in] Chat SDK object, previously initialized using one of the chatConnect methods.
- channel
- [in] Name of the chat channel whose topic is being retrieved.
- callback
- [in] Optional user-supplied function to be called when the operation has completed.
- param
- [in] Optional pointer to user data; will be passed unmodified to the callback function.
- blocking
- [in] If CHATTrue, return only after the operation has completed; otherwise, return immediately.
Unicode Mappings
| Routine | GSI_UNICODE Not Defined | GSI_UNICODE Defined |
|---|---|---|
| chatGetChannelTopic | chatGetChannelTopicA | chatGetChannelTopicW |
chatGetChannelTopicW and chatGetChannelTopicA are UNICODE and ANSI mapped versions of chatGetChannelTopic. The arguments of chatGetChannelTopicA are ANSI strings; those of chatGetChannelTopicW are wide-character strings.
Section Reference: Gamespy Chat SDK
See Also: chatSetChannelTopic