GetNTFInfo()

Summary

Provides information on a dataset of Ordnance Survey NTF volumes.

 

Syntax

ntf_info = GetNTFInfo(array file_names)

 

Argument	Contents
file_names	An array of strings containing the path and file name of each file in the series, in increasing volume order

 

Returns

An array of information as follows:

 

Element	Type	Contents
1	String	The type of data product; one of the following: "Unknown", "ADDRESS-POINT", "BaseData.GB", "Boundary-Line", "Land-Line", "Land-Form PANORAMA Contours", "Land-Form PANORAMA DTM", "Land-Form PROFILE Contours", "Land-Form PROFILE DTM", "OSCAR Asset-Manager", "OSCAR Network-Manager", "OSCAR Route-Manager", "Strategi", "Urban-Areas"
2	String	The NTF release, or null if no release is identified
3	String	The NTF version, or null if no version is identified
4	Array	An array of name-datatype pairs indicating the type of information in the series; valid data types are: Point, Line, Area, Point and Line

 

Notes

• The first element of each name-datatype pair is a level or feature type name, which is passed to ImportNTF().

• Some Ordnance Survey NTF products do not have levels. In this case, the fourth element of the array returned by GetNTFInfo() contains a single name-datatype pair with a null value for the name.

• Only one series of volumes should be listed, and they must be listed by increasing volume number.

• If the data product is unknown, it cannot be imported by ImportNTF().

Example

// This one simple call...

ntf_info = GetNTFInfo({"c:\ntf\2112_1.ntf", "c:\ntf\2112_2.ntf"})

 

// Can return all of this information...

// ntf_info = {

 

Error Codes

Error Type	Meaning
Error	One or more of the files are not a valid NTF files, or the files are not listed in increasing volume order starting with volume one
NotFound	One of the file_names could not be found in the specified path

 

See Also

Function	Summary
GetNTFVolume()	Returns information on an Ordnance Survey NTF file (volume)
ImportNTF()	Imports features from one or more Ordnance Survey NTF volumes into a geographic file