ImgControl_GetDocument¶
Return the image document currently assigned to a ImgControl form object.
ImgControl_GetDocument(controlName) ➔ imgDocRef
controlName | Text | The name of the ImgControl form object. |
imgDocRef | Text | The image document reference. |
Return the image document currently assigned to the ImgControl
form object named controlName
.
The image document reference is returned in imgDocRef
. If no document
is currently assigned to the area, an empty string is returned.
Note
Important: this method returns a retained document reference which means
that the caller must release the document when no longer needed with a call
to ImgObj_Release
. Otherwise, there will be a memory leak.