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

HRESULT GetSoundEffectsOn(
   long * pbOn  // address of variable for sound effects setting 

Retrieves whether the character's sound effects setting is enabled.

  • Returns S_OK to indicate the operation was successful.


Address of a variable that receives True if the character's sound effects setting is enabled, False if disabled.

The character's sound effects setting determines whether sound effects compiled as a part of the character are played when you play an associated animation. The setting is subject to the user's global sound effects setting in IAgentAudioOutputProperties::GetUsingSoundEffects.

See Also

IAgentCharacter::SetSoundEffectsOn, IAgentAudioOutputProperties::GetUsingSoundEffects