GetProperties

Description

Sets the properties of a FBTextBoxProperties object to those of a specified text box within the movie, given its index.

Syntax

[C#/C++]
public Bool GetProperties (long lIndex, FBTextBoxProperties* pProperties)

[VB.NET]
Public Function GetProperties (ByVal lIndex As Long, ByRef pTextboxProperties() As FBTextBoxProperties) As Boolean

Parameters

lIndex : [In] Index of a text box.

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

See Also

The FBTextBoxProperties Class  FBTextBoxes::GetPropertiesByID  FBTextBoxes::SetProperties  FBTextBoxes::SetPropertiesByID