LNITFFile::SetTextHeader

#include "ltwrappr.h"

L_INT LNITFFile::SetTextHeader(uIndex, pTxtHeader)

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

uIndex

A zero-based index of the text segment in the NITF file 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 get the number of the text segments in the NITF file, call the LNITFFile::GetTextHeaderCount function.

To retrieve the text header for a specific text segment, call the LNITFFile::GetTextHeader 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:

LNITFFile::Create, LNITFFile::Destroy, LNITFFile::GetStatus, LNITFFile::SaveFile, LNITFFile::AppendImageSegment, LNITFFile::AppendGraphicSegment, LNITFFile::AppendTextSegment, LNITFFile::SetVector, LNITFFile::GetVector, LNITFFile::GetNITFHeader, LNITFFile::SetNITFHeader, LNITFFile::GetGraphicHeaderCount, LNITFFile::GetGraphicHeader, LNITFFile::SetGraphicHeader, LNITFFile::GetImageHeaderCount, LNITFFile::GetImageHeader, LNITFFile::SetImageHeader, LNITFFile::GetTextHeaderCount, LNITFFile::GetTextHeader.

Topics:

NITF Functions: Getting and Setting Header Information.

 

Programming with LEADTOOLS NITF Functions.

Example

For an example, refer to LNITFFile::GetTextHeader