IAgentCharacterEx::SetLanguageID

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

HRESULT SetLanguageID(
   long langID  // language ID setting of character
); 

Sets the language ID set for the character.

• Returns S_OK to indicate the operation was successful.

langID

The language ID setting for the character.

A Long integer specifying the language ID for the character. The language ID (LANGID) for a character is a 16-bit value defined by Windows, consisting of a primary language ID and a secondary language ID. You can use the following values for the specified languages. For more information, see the Platform SDK documentation.

If you do not set the language ID for the character, its language ID will be the current system language ID if the corresponding Agent language DLL is installed; otherwise, the character's language will be English (US).

This property also determines the language for the word balloon text, the commands in the character's pop-up menu, and the speech recognition engine. It also determines the default language for TTS output. To determine if there is a compatible speech engine available for the character's language, use IAgentCharacterEx::GetSRModeID or IAgentCharacterEx::GetTTSModeID.

If you try to set the language ID for a character and the Agent language resources, the code page, or a display font for the language ID is not available, Agent returns an error and the character's language ID remains at its last setting. Setting this property does not return an error if there are no matching speech engines for the language.

This property applies only to your client application's use of the character; the setting does not affect other clients of the character or other characters of your client application.

See Also

IAgentCharacterEx:GetLanguageID, IAgentCharacterEx::GetSRModeID, IAgentCharacterEx::GetTTSModeID