BB FlashBack SDK: FBBitmaps

GetProperties

Description

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

Syntax

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

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

Parameters

lIndex : [In] Index of a bitmap.

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

See Also

The FBBitmapProperties Class  FBBitmaps::GetPropertiesByID  FBBitmaps::SetProperties  FBBitmaps::SetPropertiesByID