IG_IP_NR_ROI_mask

This function deletes the mask HIGEAR created by IG_IP_NR_ROI_to_HIGEAR_mask().

Declaration:

	Copy Code
AT_ERRCOUNT ACCUAPI IG_IP_NR_ROI_mask_delete ( LPAT_NR_ROI_MASK lpMask );

Arguments:

Name	Type	Description
lpMask	LPAT_NR_ROI_MASK	A far pointer to the mask structure to delete.

Return Value:

Returns the number of ImageGear errors that occurred during this function call. If there are no errors, the return value is IGE_SUCCESS.

Supported Raster Image Formats:

This function does not process image pixels.

Remarks:

Example:

	Copy Code
AT_ERRCOUNT nErrcount; HIGEAR hIGear; AT_NR_ROI_MASK Mask nErrcount = IG_IP_NR_ROI_mask_delete(&Mask);

When you are done using this mask, and have called the function IG_IP_NR_ROI_mask_unassociate(), you should call IG_IP_NR_ROI_mask_delete() to delete the mask and free up the memory allocated to it.

See also IG_IP_NR_ROI_to_HIGEAR_mask(), IG_IP_NR_ROI_mask_associate(), and IG_IP_NR_ROI_mask_unassociate() functions.