WordRpt_AddPageNumbers
HRESULT WordRpt_AddPageNumbers (CAObjHandle documentHandle, WREnum_HeaderFooter headerFooter, int pageNumberAlignment, WREnum_Boolean firstPage);
Purpose
Adds page numbers to the pages of the document.
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. |
||||||||||
| headerFooter | WREnum_HeaderFooter | The parameter specifies whether the page number is to be added to the header or the footer of each page. Can be one of the following constants:
|
||||||||||
| pageNumberAlignment | int | Specifies the alignment of the page number. Can be one of the following constants:
|
||||||||||
| firstPage | WREnum_Boolean | Determines if a page number is added to the first page of the document. If set to WRConst_FALSE, a page number is not added to the first page of the document. Can be one of the following constants:
|
||||||||||
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