ICustomDataSetInfoProvider.GetInfo Methods
Creates and populates a DataSetInfo, with contents customized for this custom dataset implementation.
Overload List
| Name | Description | |
|---|---|---|
| Public method | GetInfo() | Create and return a DataSetInfo describing this custom dataset instance. |
| Public method | GetInfo(System.String path) | Create and return a DataSetInfo describing the data file at the given file path, or null. |
GetInfo()
Create and return a DataSetInfo describing this custom dataset instance.Syntax
public DataSetInfo GetInfo ()Return Value
Remarks
This method should be implemented to construct and populate a DataSetInfo with contents that describe this dataset instance. If it should be possible to instantiate a new instance of this custom-dataset class using the resulting DataSetInfo, set DataSetInfo.CanCreateDataSet to True. Then, calls to DataSetInfo.CreateDataSet will be forwarded to Instantiate.
DataSetInfo.Crs must be set to the appropriate Crs.
GetInfo(System.String path)
Create and return a DataSetInfo describing the data file at the given file path, or null.Syntax
public DataSetInfo GetInfo (
System.String path
)Parameters
A path to a data file which might be readable by the custom dataset implementation.
Return Value
A DataSetInfo populated with values describing the data at the path, or null, if the custom dataset cannot get the info.
Remarks
This method should be implemented to construct and populate a DataSetInfo with contents that describe the data at the given file path. If there is no data at the path that can be read by this type of custom dataset, this method may return null. The return value may be used to construct a new dataset that reads the data at the path: if DataSetInfo.CreateDataSet is invoked on the returned DataSetInfo, the call will be forwarded to the Instantiate method, given that DataSetInfo.CanCreateDataSet is set to True.
If you only need to support getting DataSetInfo from an existing custom object, it is sufficient to implement the overload of GetInfo that does not take a path argument. In that case, this overload can be implemented to just return null.
DataSetInfo.Crs must be set to the appropriate Crs.
Platforms
Windows, Linux, Android