GetProperties

Description

Retrieves in the properties of a ZoomPan instance into a FBZoomPanProperties object.

Syntax

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

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

Parameters

lIndex : [In] Index of a ZoomPan instance in the collection.

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

See Also

FBZoomPanObjects::SetProperties  The FBZoomPanProperties class