GetProperties

Description

Sets the properties of a FBHighlightProperties object to those of a specified highlight within the movie, given its index.

Syntax

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

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

Parameters

lIndex : [In] Index of a highlight.

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

See Also

The FBHighlightProperties Class  FBHighlights::GetPropertiesByID  FBHighlights::SetProperties  FBHighlights::SetPropertiesByID