LAnnContainer::FileInfo
#include "ltwrappr.h"
virtual L_INT LAnnContainer::FileInfo(pszFile, pAnnFileInfo, uStructSize)
L_TCHAR * pszFile; |
/* input file name to query */ |
pANNFILEINFO pAnnFileInfo; |
/* pointer to a structure */ |
L_UINT uStructSize; |
/* size in bytes, of the structure pointed to by pAnnFileInfo */ |
Gets information about the specified annotation file and fills the specified ANNFILEINFO structure with the information.
Parameter |
Description |
pszFile |
Character string containing the name of the annotation input file. |
pAnnFileInfo |
Pointer to the ANNFILEINFO structure to be filled. For more information, refer to the ANNFILEINFO structure. |
uStructSize |
Size in bytes, of the structure pointed to by pAnnFileInfo, for versioning. Use sizeof(ANNFILEINFO). |
Returns
SUCCESS |
The function was successful. |
< 1 |
An error occurred. Refer to Return Codes. |
Comments
This function can be used to find information about a LEAD annotation file.
To use this function, do the following:
1. |
Declare a variable with the datatype of ANNFILEINFO. |
2. |
Fill in the nSize and nOffset fields of the ANNFILEINFO variable. The field nSize should contain the size of the ANNFILEINFO structure in bytes. The nOffset field should contain the byte location of the first byte of the annotation file. |
3. |
Declare and assign a character string variable for the annotation file name. |
4. |
Call the LAnnContainer::FileInfo function, passing the file name and the address of the ANNFILEINFO variable as parameters. |
5. |
Get the image information from the fields described in the ANNFILEINFO structure. |
Required DLLs and Libraries
LTANN 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
Example
L_VOID TestFunction(LAnnContainer & AnnContainer, L_TCHAR
* szFile, L_UINT uFormat)
{
SAVEFILEOPTION
SaveFileOption;
ANNFILEINFO AnnFileInfo;
L_TCHAR szMessage[256];
L_TCHAR * szFormat;
// Save the annotations
as the first page of the file
AnnContainer.Save(szFile, uFormat, FALSE);
// Flip and then
save as the second page of the file
AnnContainer.Flip(NULL, ANNFLAG_RECURSE);
SaveFileOption.uStructSize
= sizeof(SAVEFILEOPTION);
SaveFileOption.Flags
= ESO_INSERTPAGE;
SaveFileOption.PageNumber
= 2;
AnnContainer.Save(szFile, uFormat, FALSE, &SaveFileOption);
// Rotate and
then save as the third page of the file
AnnContainer.Rotate(45.0, NULL, ANNFLAG_RECURSE);
SaveFileOption.PageNumber
= 3;
AnnContainer.Save(szFile, uFormat, FALSE, &SaveFileOption);
// Get information
about the file
AnnFileInfo.uStructSize
= sizeof(ANNFILEINFO);
AnnFileInfo.nOffset
= 0;
AnnContainer.FileInfo(szFile, &AnnFileInfo, sizeof(AnnFileInfo));
switch (AnnFileInfo.uFormat)
{
case
ANNFMT_NATIVE:
szFormat
= TEXT("ANNFMT_NATIVE");
break;
case
ANNFMT_WMF:
szFormat
= TEXT("ANNFMT_WMF");
break;
case
ANNFMT_ENCODED:
szFormat
= TEXT("ANNFMT_ENCODED");
break;
default:
szFormat
= TEXT("Unknown");
break;
}
wsprintf(szMessage,
TEXT("File Name: %s\nVersion: %d\nFormat: %s\nTotal Pages: %d"),
szFile, AnnFileInfo.nVersion, szFormat, AnnFileInfo.nTotalPages);
MessageBox(NULL,
szMessage, TEXT("Information"), MB_OK);
// Now, delete
the second page
AnnContainer.DeletePage(szFile, 2);
// Again, get
information about the file
AnnFileInfo.uStructSize
= sizeof(ANNFILEINFO);
AnnFileInfo.nOffset
= 0;
AnnContainer.FileInfo(szFile, &AnnFileInfo, sizeof(AnnFileInfo));
wsprintf(szMessage,
TEXT("File Name: %s\nVersion: %d\nFormat: %s\nTotal Pages: %d"),
szFile, AnnFileInfo.nVersion, szFormat, AnnFileInfo.nTotalPages);
MessageBox(NULL,
szMessage, TEXT("Information"), MB_OK);
}