GetNTFVolume()

Summary

Returns information on an Ordnance Survey NTF file (volume).

Syntax

ntf_info = GetNTFInfo(string file_name)

Argument Contents
file_name The path and file name of the NTF file

Returns

An array of information as follows:

Element Type Contents
1 String Version number
2 String A code that can be compared among files to indicate whether the volumes are from the same series; a match in the code between files strongly indicates (but does not guarantee) that they are from the same series
3 Integer The volume sequence number of this file in its series
4 Boolean "True" if the volume contains the entire dataset (in which case the volume sequence number is 1), or "False" if this is one volume from a multiple-volume series

Example

ntf_volinfo = GetNTFVolume("c:\datafile.ntf")
// ntf_volinfo = {"2.00, Level 4", "ABCDEFG", 2, "False"}

Error Codes

Error Type Meaning
Error The file is not a valid NTF file
NotFound The specified file does not exist

See Also

Function Summary
ImportNTF() Imports features from one or more Ordnance Survey NTF volumes into a geographic file
GetNTFInfo() Provides information on a dataset of Ordnance Survey NTF volumes