rmiref.insertRefs

(Not recommended) Insert backlinks in Microsoft Office documents

Using rmiref.insertRefs is not recommended. Use updateBacklinks instead.

Syntax

[links,matches,inserted] = rmiref.insertRefs(model,type)

Description

[links,matches,inserted] = rmiref.insertRefs(model,type) inserts navigation backlinks in the active document of type type to match slreq.Link objects that point from the document to the Simulink^® model model. You can use these backlinks to navigate from the external document to the Simulink model. The function returns the number of links associated with the model, the number of those links that also point to the external requirements document, and the number of backlinks inserted in the requirements document. For more information, see Manage Navigation Backlinks in External Requirements Documents.

Examples

Insert Backlinks in Microsoft Word Document

This example shows how to insert backlinks in a Microsoft® Word document.

Open a model called myModel.

open_system("myModel");

Open a Microsoft^® Word document that contains requirements called myRequirementsDoc.docx

open("myRequirementsDoc.docx");

Insert navigation backlinks in the document for the model myModel. Return the total number of links associated with the model, the number of links that navigate to the document, and the number of links inserted in the document.

[links,matches,inserted] = rmiref.insertRefs("myModel","word")

links = 16
matches = 8
inserted = 8

Input Arguments

model — Name or handle of Simulink model

string scalar | character vector | model handle

Name or handle of a Simulink model, specified as a string scalar, character vector, or model handle.

type — External requirements document type

"word" | "excel"

External requirements document type, specified as "word" or "excel".

Output Arguments

links — Number of links associated with Simulink model

double array

Number of links associated with the Simulink model, returned as a double array.

matches — Number of links associated with external document

double array

Number of links in the Simulink model that are associated with the external requirements document, returned as a double array.

inserted — Number of backlinks inserted in external document

double array

Number of backlinks inserted in the external requirements document, returned as a double array.

Version History

Introduced in R2011a

R2022b: Not recommended

There are no plans to remove rmiref.insertRefs. However, the updateBacklinks method has these advantages over rmiref.insertRefs and is recommended instead:

• You can use updateBacklinks to insert backlinks that correspond to links that are not associated with a model.

• You can use updateBacklinks to insert backlinks in documents in third-party tools other than Microsoft Word and Microsoft Excel^®.