api:dk11:activex:tatukgis_xdk11.itgis_layerpixel.lockpixels_3_itgis_extent_itgis_cscoordinatesystem_double_integer_wordbool
Table of Contents
ITGIS_LayerPixel.LockPixels_3 method
DK11 for ActiveX | TatukGIS_XDK11.ITGIS_LayerPixel.LockPixels_3 | Methods | Properties
Locks a fragment of the pixel layer for updating.
Syntax
// C# public ITGIS_LayerPixelLock LockPixels_3( ITGIS_Extent _ext, ITGIS_CSCoordinateSystem _cs, double _pixelsize, int _band, WordBool _writable );
' VisualBasic Public Function LockPixels_3( ByVal _ext As ITGIS_Extent, ByVal _cs As ITGIS_CSCoordinateSystem, ByVal _pixelsize As Double, ByVal _band As Integer, ByVal _writable As WordBool ) As ITGIS_LayerPixelLock
// Oxygene public function LockPixels_3( _ext : ITGIS_Extent; _cs : ITGIS_CSCoordinateSystem; _pixelsize : Double; _band : Integer; _writable : WordBool ) : ITGIS_LayerPixelLock;
Parameters
| Name | Type | Description |
|---|---|---|
| _ext | ITGIS_Extent | area to be locked; if bigger then layer extent then will be truncated to layer extent |
| _cs | ITGIS_CSCoordinateSystem | coordinate system of _cs; if nil then same as layer CS |
| _pixelsize | double Double | minimum requested size of image pixel; by providing 0 a maximum possible resolution will be used, which is also a fastest method if a layer is full in-memory because in such situation a pointer to existing memory will be used |
| _band | int Integer | specific band to be locked |
| _writable | WordBool | if true than layer will post back any changes in locked area; if write is not possible then TGIS_LayerPixelLock.Writable will be set accordingly |
Result
| Type | Description |
|---|---|
| ITGIS_LayerPixelLock | locked area |
Remarks
Must be paired with UnlockPixels.
To speed-up operation, the function can return a larger area than requested. Use Bounds property of result value to obtain actual scope.
2020/05/07 01:04