GetPropertiesByID

Description

Sets the properties of a FBSoundProperties object to those of a specified sound within the movie, given its ID.

Syntax

[C#/C++]
public Bool GetPropertiesByID (long lID, FBSoundProperties* pProperties)

[VB.NET]
Public Function GetPropertiesByID (ByVal lID As Long, ByRef pSoundProperties() As FBSoundProperties) As Boolean

Parameters

lID : [In] ID of a sound.

pProperties : [In] Pointer to a FBSoundProperties object

Return Values

If the function fails, the return value is nonzero.

If the function succeeds, the return value is zero.

Remarks

The caller should create the FBSoundProperties object before passing its pointer in. After changing the properties of the object, the changes can be committed back to the in-movie sound object by using the SetProperties or SetPropertiesByID methods.

See Also

The FBSoundProperties Class  FBSounds::GetProperties  FBSounds::SetProperties  FBSounds::SetPropertiesByID