openInterface

R2026b

Open interface for Serial Link Designer or Parallel Link Designer from project file

Since R2026b

collapse all in page

Syntax

svr = openInterface(path)

Description

svr = openInterface(path) opens the interface specified by path and returns the server object svr. The file extension determines whether to open the Parallel Link Designer (.edk) or Serial Link Designer (.qcd) app.

Input Arguments

collapse all

Path to the project file, specified as a string. The file must have an .edk extension for parallel link designer interfaces or a .qcd extension for serial link designer interfaces. The file extension matching is case-insensitive.

Name-Value Arguments

collapse all

Specify optional pairs of arguments as Name1=Value1,...,NameN=ValueN, where Name is the argument name and Value is the corresponding value. Name-value arguments must appear after other arguments, but the order of the pairs does not matter.

Example: svr = openInterface("parallel_link.edk", WaitTime=60) opens the interface for a parallel link project and waits upto 60 seconds for the command to complete.

Option to wait for the open command to complete before exiting, specified as true or false. When WaitForCompletion is true, the function blocks until the interface has finished opening. When false, the function returns immediately after issuing the server command.

Data Types: logical

Wait duration mode, specified as timed or forever.

When WaitMode is set to timed, the function waits for the number of seconds specified by WaitTime. When WaitMode is set to forever, the function waits indefinitely until the command finishes.

Note

The function ignores the WaitMode argument when WaitForCompletion is set to false.

Data Types: string

Maximum time to wait for command completion in seconds, specified as a positive numeric scalar. This argument is used only when WaitForCompletion is true and WaitMode is "timed". The default value is 1000 seconds.

Note

The function ignores the WaitTime argument when WaitForCompletion is set to false or WaitMode is set to forever.

Data Types: double

Output Arguments

collapse all

Link designer server object, returned as a parallel link designer or serial link designer object. The type of server returned depends on the file extension of path: .edk files return a parallel link designer server, and .qcd files return a serial link designer server.

Version History

Introduced in R2026b

See Also

|