IAgentCharacter::SetName

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

HRESULT SetName(
   BSTR bszName   // character name
);

Sets the name of the character.

  • Returns S_OK to indicate the operation was successful.

bszName

A BSTR that sets the character's name. A character's default name is defined when it is compiled with the Microsoft Agent Character Editor. You can change it using IAgentCharacter::SetName; however, this changes the character name for all current clients of the character. This property is not persistent (stored permanently). The character's name reverts to its default name whenever the character is first loaded by a client.

The character's name may also depend on its language ID. Characters can be compiled with different names for different languages.

The server uses the character's name setting in parts of the Microsoft Agent's interface, such as the Voice Commands Window title when the character is input-active and in the Microsoft Agent taskbar pop-up menu.

See Also

IAgentCharacter::GetName