GetOverlayAttributes Method

Summary

Gets one or more overlay attributes for the specified index.

Syntax

Objective-C

C++

Java

public RasterOverlayAttributes GetOverlayAttributes( 
   int index, 
   RasterGetSetOverlayAttributesFlags flags 
)

Public Function GetOverlayAttributes( _ 
   ByVal index As Integer, _ 
   ByVal flags As RasterGetSetOverlayAttributesFlags _ 
) As RasterOverlayAttributes

- (nullable LTRasterOverlayAttributes *)getOverlayAttributesAtIndex:(NSInteger)index  
                                                              flags:(LTRasterGetSetOverlayAttributesFlags)flags  
                                                              error:(NSError **)error

public RasterOverlayAttributes getOverlayAttributes( 
  int index,  
  int flags 
)

public: 
RasterOverlayAttributes^ GetOverlayAttributes(  
   int index, 
   RasterGetSetOverlayAttributesFlags flags 
)

Parameters

index
The zero-based index of the overlay for which to get the attributes.

flags
Flags that determine which attributes to retrieve.

Return Value

An RasterOverlayAttributes object filled with the attribute data requested or null if the image does not have an overlay attribute at the specific index.

Remarks

Only the members specified by flags will contain valid values in returned RasterOverlayAttributes retrieved by the method will be updated. The other values are left to the defult value.

For more information, refer to Overlay Overview.

Example

For an example, refer to UpdateOverlayAttributes example.

Requirements

Target Platforms