GetPaperUnits()

Summary

Gets the current paper measurement unit.

 

Changes

In Version 2018 added the format types "Display Abbreviation", "Display Singular", and "Display Plural".

 

Syntax

units = GetPaperUnits(string format_type)

 

Argument	Contents
format_type	Format of the measurement unit: "Abbrev", "Singular", "Plural, "Display Abbrev", "Display Singular", or "Display Plural" . If null, Plural is the default.

 

Returns

A string that is the current paper measurement unit.

 

Notes

• Paper units are used to control layouts and to set the basis for map scales (e.g., the "inch" part of miles/inch).

• With the "Display" format types, GetPaperUnits() returns the corresponding "Display" version that was set up with SetDisplayUnits().

Example

p1 = GetPaperUnits("Plural")	// p1 is "Inches"
p2 = GetPaperUnits("Singular")	// p2 is "Inch"
p3 = GetPaperUnits("Abbreviation")	// p3 is "in"

 

Error Codes

Error Type	Meaning
Error	format_type is incorrectly specified

 

See Also

Function	Summary
SetPaperUnits()	Sets the current paper measurement unit
GetPaperUnitNames()	Gets a list of the available paper measurement units
GetMapUnits()	Gets the current map measurement unit