L_NITFSetTextHeader
#include "ltntf.h"
L_LTNTF_API L_INT L_NITFSetTextHeader(hNitf, uIndex, pTxtHeader)
HNITF hNitf; |
/* handle to an existing NITF file */ |
L_UINT uIndex; |
/* index of the text segment */ |
pTXTHEADER pTxtHeader; |
/* pointer to a TXTHEADER structure */ |
Changes the text header information of a specific text segment. This function is available in the Document Toolkit.
Parameter |
Description |
hNitf |
Handle to an existing NITF file, created by calling the L_NITFCreate function. |
uIndex |
A zero-based index of the text segment in the hNitf handle to be changed with the new text header information. |
pTxtHeader |
Pointer to a TXTHEADER structure that contains the new text header information to set in the text segment in the NITF file at the specified index uIndex. |
Returns
SUCCESS |
The function was successful. |
< 1 |
An error occurred. Refer to Return Codes. |
Comments
To retrieve the number of the text segments in the hNitf handle, call the L_NITFGetTextHeaderCount function.
To retrieve the text header for a specific text segment, call the L_NITFGetTextHeader function.
Required DLLs and Libraries
LTNTF For a listing of the exact DLLs and Libraries needed, based on the toolkit version, refer to Files To Be Included With Your Application. |
See Also
Functions: |
|
Topics: |
|
|
Example
For an example, refer to L_NITFGetTextHeader.