getMainPartPath

Class: mlreportgen.dom.Document
Namespace: mlreportgen.dom

Return path of main part of document output package

Syntax

pathOut = getMainPartPath(docObj)

Description

pathOut = getMainPartPath(docObj) returns the full path of the main part of the output package of the specified document. The main part is the file that contains the XML or HTML markup for a document.

Examples

Get Path to Main Part of Output Package

This code returns the path to the main part of an HTML document named MyReport. The main part is named index.html and it is in the root of the MyReport package. This example assumes that there is a reports folder on the S: drive.

d = mlreportgen.dom.Document("S:\reports\MyReport","html");
d.PackageType="unzipped";
getMainPartPath(d)

"s:\reports\MyReport\index.hml"

Input Arguments

docObj — Document that contains main part

mlreportgen.dom.Document object

Document that contains the main part, specified as an mlreportgen.dom.Document object.

Output Arguments

pathOut — Path of main part of document output package

character vector

Path of the main part of document output package.

Version History

Introduced in R2014b