IAgentCharacter::SetDescription

[Microsoft Agent is deprecated as of Windows 7, and may be unavailable in subsequent versions of Windows.]

HRESULT SetDescription(
   BSTR bszDescription   // character description
); 

Sets the description of the character.

  • Returns S_OK to indicate the operation was successful.

bszDescription

A BSTR that sets the description for the character. A character's default description is defined when it is compiled with the Microsoft Agent Character Editor. The description setting is optional and may not be supplied for all characters. You can change the character's description using IAgentCharacter::setDescription; however, this value is not persistent (stored permanently). The character's description reverts to its default setting whenever the character is first loaded by a client.

See Also

IAgentCharacter::GetDescription