BB FlashBack SDK: FBWatermarks

GetProperties

Description

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

Syntax

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

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

Parameters

lIndex : [In] Index of a watermark.

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

See Also

The FBWatermarkProperties Class  FBWatermarks::GetPropertiesByID  FBWatermarks::SetProperties  FBWatermarks::SetPropertiesByID