PIExportMode Enumeration
- Last UpdatedNov 18, 2025
- 4 minute read
- PI System
- AF SDK 2024 R2
- Developer
Indicates the type of export to perform when using an ExportXml method.
Since this is a bit mask, several of these values can be set at the same time.
Namespace: OSIsoft.AF
Assembly: OSIsoft.AFSDK (in OSIsoft.AFSDK.dll) Version: 3.1.1.1182
Syntax
[FlagsAttribute] public enum PIExportMode
<FlagsAttribute> Public Enumeration PIExportMode Dim instance As PIExportMode
[FlagsAttribute] public enum class PIExportMode
[<FlagsAttribute>] type PIExportMode
Members
| Member name | Value | Description | |
|---|---|---|---|
| StrongReferences | 0 | Export this object and all objects it contains. Objects being referenced by the object being exported will not be included. For example if an element or event frame is being exported, only child elements or child event frames will be exported, not those being referenced by it. This flag should not be used with either the AllReferences or NoReferences flags. If it is used with one of them, StrongReferences will be ignored and the other flag will be used for the export operation. This option applies only to XML export. | |
| AllReferences | 1 | Export this object and all objects it contains or references. This flag cannot be set if the NoReferences flag is set. This flag should not be used with the StrongReferences flag. If it is, StrongReferences will be ignored and AllReferences will be used for the export operation. This option applies only to XML export. The OSIsoft.AF.xsd file, located in the default x86 installation folder of AF Client, documents the type of references which are included for each major AF type. | |
| NoReferences | 2 | Export this object only without referenced objects. Top-level attributes, analyses, and notification rules will be included for elements. Top-level attributes will be included for event frames. Child or referenced elements, child or referenced event frames, and child attributes will not be included. This flag cannot be set if the AllReferences flag is set. This flag should not be used with the StrongReferences flag. If it is, StrongReferences will be ignored and NoReferences will be used for the export operation. This option applies only to XML export. | |
| ChangesOnly | 8 | Export changes only. Not Implemented. | |
| NoUniqueID | 16 | Don't export UniqueIDs associated with each object. This option applies only to XML export. | |
| DefaultValues | 32 | Export default values. This option only applies to XML export. Cs export always includes default values. | |
| Library | 64 | Used to limit the export of a database to include library objects only. Library objects are Categories, all Templates, Enumeration Sets, Reference Types, Tables and the Unit-of-Measure Database. This option only applies to XML export. | |
| Security | 128 | Include Security Descriptors in export. Exporting Security Descriptors will have a performance impact on both Export and Import. This option only applies to XML export. | |
| Flat | 256 | Export hierarchical objects in a flattened style. This includes Elements, Attributes, Attribute Templates, and Event Frames. This option only applies to XML export. | |
| SimplifiedConfigStrings | 512 | Export the simplified form of configuration strings for attributes and attribute templates. The simplified strings will already have parameters substituted and will not include UniqueIDs or point identifiers. | |
| AppendUnitsOfMeasure | 1024 | Append the unit of measure, if any, to the end of attribute values and attribute template values when they are exported. | |
| ReferencedAttributeValues | 2048 | Include data values from data references for attributes if their values are to be exported. This option only applies to CSV export. | |
| ReferencedTransposedValues | 4096 | Include data values from data references for attribute column values when exporting data in CSV format. | |
| UseMilliseconds | 8192 | Include milliseconds on DateTimes when exporting data in CSV format. XML export always will use the full timestamp precision. | |
| PasteOperation | 16384 | Use user interface Paste Rules to determine what properties of objects defined by a template should be exported. This option only applies to XML export. | |
| UseServerTimeZone | 32768 | Return PI Tags and AF Objects with relevant time fields in their respective Server's time zone rather than local time. | |
| UseUtcTime | 65536 | Return PI Tags and AF Objects with relevant time fields in UTC time rather than local time. |