Application class/Context.Create Local Host App Instance method: Difference between revisions
m Category reorg |
Add method and parameter descriptions |
||
| (One intermediate revision by one other user not shown) | |||
| Line 12: | Line 12: | ||
{{TOCright}} | {{TOCright}} | ||
Creates a new (headless) application instance on the local host machine and returns a reference to it. | |||
==Parameters== | ==Parameters== | ||
{| class="wikitable" | {| class="wikitable" | ||
|- | |- | ||
| Line 24: | Line 24: | ||
| '''Context:Create Local Host App Instance''' | | '''Context:Create Local Host App Instance''' | ||
| Yes. Return value. | | Yes. Return value. | ||
| | | Reference to the new application instance. Returns an invalid value if this method had an error. | ||
|- | |- | ||
! scope="row" style="text-align:Center;" | [[File:String.png|frameless|border|String|link=String data type]] | ! scope="row" style="text-align:Center;" | [[File:String.png|frameless|border|String|link=String data type]] | ||
| '''Application Instance Name''' | | '''Application Instance Name''' | ||
| No | | No | ||
| | | A unique name for the new application instance. If no name is provided, this method creates a new unique name on every call ("AppInstance Untitled 1", "AppInstance Untitled 2", ...). If an application instance with the same name already exists, this method returns an error. | ||
|- | |- | ||
! scope="row" style="text-align:Center;" | [[File:Path.png|frameless|border|Path|link=Path data type]] | ! scope="row" style="text-align:Center;" | [[File:Path.png|frameless|border|Path|link=Path data type]] | ||
| '''INI Path''' | | '''INI Path''' | ||
| No | | No | ||
| | | Path to an INI file that will be used for the application instance. Uses default values for all settings if no path is specified. | ||
|- | |- | ||
! scope="row" style="text-align:Center;" | [[File:I32.png|frameless|border|I32|link=I32 data type]] | ! scope="row" style="text-align:Center;" | [[File:I32.png|frameless|border|I32|link=I32 data type]] | ||
| '''Options''' | | '''Options''' | ||
| No | | No | ||
| | | Additional flags that are passed to the application instance. The flag '''kPrivateLVContext''' is always passed automatically. Allowed flags are: | ||
* 0x00000002 kPrivateButAllowSaveChanges | |||
* 0x00000004 kApplyChanges_ReaderContext | |||
* 0x00000008 kApplyChanges_NoParticipation | |||
* 0x00040000 kDoNotWarnAboutRunningVIsOnExit | |||
* 0x00200000 kIsLVWebServiceLVContext | |||
* 0x20000000 kContextDoesNotUpdateVIObjCache | |||
|- | |- | ||
! scope="row" style="text-align:Center;" | [[File:Boolean.png|frameless|border|Boolean|link=Boolean data type]] | ! scope="row" style="text-align:Center;" | [[File:Boolean.png|frameless|border|Boolean|link=Boolean data type]] | ||
| '''Release Ref on Idle (T)''' | | '''Release Ref on Idle (T)''' | ||
| No | | No | ||
| | | If enabled, the application instance will be released when the top-level VI goes idle. Defaults to true. | ||
|} | |} | ||
| Line 65: | Line 71: | ||
{{ambox|text=Add links to external resources that would also help.}} | {{ambox|text=Add links to external resources that would also help.}} | ||
[[Category:Private Method]] | |||
[[Category:VI Server Method]] | [[Category:VI Server Method]] | ||
Latest revision as of 11:39, 28 September 2020
| VI Server Method Information | |
|---|---|
| Method ID | 815 |
| Scope | Private |
| Data Name | Context.CreateLocalHostAppInstance |
| Short Name* | Context.CreateLocalHostAppInstance |
| Long Name* | Context:Create Local Host App Instance |
| * Displayed here in English. Short and Long names appear in the language of the LabVIEW IDE. | |
| Owning Class ID | 1 |
| Owning Class Name | Application Class |
| Return Data Type | Application Refnum data type
|
| Invoke Node | 
|
Creates a new (headless) application instance on the local host machine and returns a reference to it.
Parameters
| Data type | Name | Required | Description |
|---|---|---|---|
|
Context:Create Local Host App Instance | Yes. Return value. | Reference to the new application instance. Returns an invalid value if this method had an error. |
|
Application Instance Name | No | A unique name for the new application instance. If no name is provided, this method creates a new unique name on every call ("AppInstance Untitled 1", "AppInstance Untitled 2", ...). If an application instance with the same name already exists, this method returns an error. |
|
INI Path | No | Path to an INI file that will be used for the application instance. Uses default values for all settings if no path is specified. |
|
Options | No | Additional flags that are passed to the application instance. The flag kPrivateLVContext is always passed automatically. Allowed flags are:
|
|
Release Ref on Idle (T) | No | If enabled, the application instance will be released when the top-level VI goes idle. Defaults to true. |
Uses
 |
Specific use cases for this method. |
History
| |
History information is needed. What changes have occurred over previous versions? |
| Version | Change(s) |
|---|---|
|
More info to come. |
See Also
| |
Add links to internal wiki pages that would also help. |
External Links
| |
Add links to external resources that would also help. |