getDefinedNames-methods: Retrieving defined names in a workbook

In XLConnect: Excel Connector for R

Retrieving defined names in a workbook

Description

Retrieves the defined names in a workbook.

Usage

## S4 method for signature 'workbook'
getDefinedNames(object, validOnly, worksheetScope)

Arguments

object	The workbook to use
validOnly	If validOnly = TRUE only names with valid references are returned. Valid references are ones not starting with #REF! or #NULL! - which could result e.g. due to a missing sheet reference. The default value for validOnly is TRUE.
worksheetScope	Optional - the name of the worksheet in which the names are scoped; to only query names in the global scope, use the value ""

Details

If option XLConnect.setCustomAttributes is TRUE (default FALSE), a list of the worksheet scopes in which the names were found is set as attribute worksheetScope on the result.

Author(s)

Martin Studer
Mirai Solutions GmbH https://mirai-solutions.ch

See Also

workbook, createName, removeName, existsName, readNamedRegion,
writeNamedRegion

Examples

## Not run: 
# mtcars xlsx file from demoFiles subfolder of package XLConnect
mtcarsFile <- system.file("demoFiles/mtcars.xlsx", package = "XLConnect")

# Load workbook
wb <- loadWorkbook(mtcarsFile)

# Retrieve defined names with valid references
getDefinedNames(wb)

## End(Not run)

XLConnect documentation built on Sept. 11, 2024, 8:04 p.m.