WordRpt_InsertScaledImage
- Updated2023-02-21
- 1 minute(s) read
HRESULT WordRpt_InsertScaledImage (CAObjHandle documentHandle, char imageFileName[], float heightFactor, float widthFactor, CAObjHandle *imageHandle);
Purpose
Inserts an image from the specified file into the Word document, scales the image by the factor specified by heightFactor and widthFactor and returns an object handle to the image.
Parameters
| Input | ||
| Name | Type | Description |
| documentHandle | CAObjHandle | A handle to the Word Document object. When it is no longer needed, this handle must be discarded using CA_DiscardObjHandle. |
| imageFileName | char [] | The pathname of the file containing the image. |
| heightFactor | float | Specifies the ratio between the height of the shape after it is scaled and original height. For example, to make a rectangle 50 percent larger, specify 1.5 for this argument. |
| widthFactor | float | Specifies the ratio between the width of the shape after it is scaled and original width. For example, to make a rectangle 50 percent larger, specify 1.5 for this argument. |
| Output | ||
| Name | Type | Description |
| imageHandle | CAObjHandle | A handle to the Word Shape object. When it is no longer needed, this handle must be discarded using CA_DiscardObjHandle. |
Return Value
| Name | Type | Description |
| status | HRESULT | A value indicating whether an error occurred. Function failure is indicated by a negative error code. Error codes are defined in CVIversion\include\cviauto.h and <Program Files>\National Instruments\Shared\MSDTRedistributables\SDKHeaderFiles\8.1\winerror.h. You can use CA_GetAutomationErrorString to get the description of an error code. |
Additional Information
Library: Word Report
Include file: activex\word\WordReport.h
LabWindows/CVI compatibility: LabWindows/CVI 7.0 and later