L_NITFFreeTextHeader
#include "ltntf.h"
L_LTNTF_API L_INT L_NITFFreeTextHeader(pTxtHeader)
pTXTHEADER pTxtHeader; |
/* pointer to a structure */ |
Frees the text header data and resources allocated by the L_NITFGetTextHeader function.
Parameter |
Description |
pTxtHeader |
Pointer to a TXTHEADER structure to be freed. |
Returns
SUCCESS |
The function was successful. |
< 1 |
An error occurred. Refer to Return Codes. |
Comments
This function should be called when the text header information of a specific text segment is no longer needed.
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: |
L_NITFGetTextHeaderCount, L_NITFGetTextHeader, L_NITFSetTextHeader |
Topics: |
|
|
Example
For an example, refer to L_NITFGetTextHeader.