GetPropertiesByID

Description

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

Syntax

[C#/C++]
public Bool GetPropertiesByID (long lID, FBButtonProperties* pButtonProperties);

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

Parameters

lID : [In] ID of a button.

pButtonProperties : [Out] Pointer to a FBButtonProperties 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 FBButtonProperties object before passing its pointer in. After changing the properties of the object, the changes can be committed back to the in-movie button object by using the SetProperties or SetPropertiesByID methods.

See Also

The FBButtonProperties Class  FBButtons::GetProperties  FBButtons::SetProperties  FBButtons::SetPropertiesByID