BB FlashBack SDK: FBWatermarks

GetPropertiesByID

Description

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

Syntax

[C#/C++]
public Bool GetPropertiesByID (long lID, FBWatermarkProperties* pProperties)

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

Parameters

lID : [In] ID 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 object by using the SetProperties or SetPropertiesByID methods.

See Also

The FBWatermarkProperties Class  FBWatermarks::GetProperties  FBWatermarks::SetProperties  FBWatermarks::SetPropertiesByID