Project Provider Framework/API VIs

The following is a list of all of the API VIs.

mxLvGetAssociatedItems.vi

Returns the items that belong to this project and are associated with one of the file paths.

mxLvAddIconOverlays.vi

Registers a set of Icon Overlay Aliases and tells the framework where to find the .ico files matching these Aliases.

mxLvDeleteAllProperties.vi

Removes all properties from the property bag for the given Item.

mxLvDeleteProperty.vi

Removes a property from the property bag for the given Item.

mxLvDisplayMessage.vi

Displays a message box for the Provider.

mxLvEnumProperties.vi

Enumerates all the properties of the specified item.

mxLvErrorHandler.vi

Converts an error or warning code to an error cluster. This VI is useful when you receive a return value from a shared library call or when you return user-defined error codes.

mxLvFilesExist.vi

Checks whether the given files exist or not.

mxLvGenerateGuid.vi

Generates a GUID (a unique identifier).

mxLvGetAllDescendentsSFP.vi

Gets all descendents for the given item. It should return the same results as the ProjectItem:Get All Descendents method with the default values. NOTE: This VI only works during the Provider_OnSaveForPreviousEx call.

mxLvGetBinaryProperty.vi

Retrieves a binary property from the property bag for the given Item.

mxLvGetBooleanProperty.vi

Retrieves a Boolean property from the property bag for the given Item.

mxLvGetFilePath.vi

Gets the file path for the current Item.

mxLvGetFilePathBatch.vi

Gets the file paths for the specified Items.

mxLvGetIntProperty.vi

Retrieves an Integer property from the property bag for the given Item.

mxLvGetIntPropertyBatch.vi

Retrieves the values for the Integer property from the property bag for the given Items.

mxLvGetItem.vi

Given a NIIM gets the associated Item. NIIM is a cluster of Item URL Item ID Item Index and the Specific Type. Refer mxLvNIIM.ctl in the <LabVIEW>/resource/Framework/Providers/API directory.

mxLvGetItemBatch.vi

Given a list of NIIMs gets the associated Items.

mxLvGetItemFromItemIDSFP.vi

Returns the Item for the specified Item ID. This VI only works during the Provider_OnSaveForPreviousEx call.

mxLvGetItemIDFromItemSFP.vi

Returns the Item ID for an Item. This VI only works during the Provider_OnSaveForPreviousEx call.

mxLvGetItemRef.vi

Given an item gets the associated item refnum.

mxLvGetNIIM.vi

Given an item gets the associated NIIM.

mxLvGetNIIMBatch.vi

Given a list of items gets the associated NIIMs.

mxLvGetPathProperty.vi

Retrieves a path property from the property bag for the given Item.

mxLvGetProjectPath.vi

Gets the path to the project that the item belongs to.

mxLvGetProjectRef.vi

Gets a reference to the 'current' Project so the Provider can call VI Server methods on the Project.

mxLvGetPropertyType.vi

Retrieves the type of the property for the given Item.

mxLvGetProviderAppRef.vi

Gets a reference to the current application so the provider can call VI Server methods on the application.

mxLvGetRefProperty.vi

Retrieves a reference property from the property bag for the given Item.

mxLvGetStringProperty.vi

Retrieves a String property from the property bag for the given Item.

mxLvGetTarget.vi

Returns the target for the given item.

mxLvGetURLSFP.vi

Returns the project URL for the specified item. NOTE: This VI only works during the Provider_OnSaveForPreviousEx call.

mxLvGetVariantProperty.vi

Retrieves a property from the property bag for the given Item as variant data.

mxLvGetVIRefProperty.vi

Gets an Integer property from the property bag for the given Item and casts it to a VI Refnum.

mxLvHasProperty.vi

Returns whether the given Item has the specified property in its property bag.

mxLvHasPropertyBatch.vi

Returns whether the given Items have the specified property in their property bag.

mxLvIsPersistent.vi

Returns whether the given property of the item is saved with the project or not.

mxLvNotifyChanged.vi

Notifies the providers for the specified items of the change.

mxLvSetBinaryProperty.vi

Writes a binary property to the property bag for the given Item.

mxLvSetBooleanProperty.vi

Writes a Boolean property to the property bag for the given Item.

mxLvSetCursorBusy.vi

Sets the cursor to busy state.

mxLvSetIcon.vi

Sets the icon to be displayed next to the item in the tree.

mxLvSetIconOverlays

Turns on or off Icon overlays for the given Item specified by previously registered Aliases. See mvLvAddIconOverlays.vi

mxLvSetIconOverlaysBatch

Turns on or off Icon overlays for the given Items specified by previously registered Aliases. See mvLvAddIconOverlays.vi

mxLvSetIntProperty

Writes an Integer property to the property bag for the given Item.

mxLvSetIntPropertyBatch

Writes an Integer property to the property bag for the given Items.

mxLvSetMenu

Specifies menu items. The order in which menu items appear is determined by their order in the "Menu Items" array. For each menu item, the text display description icon and event handling command tag can be specified; please refer to the help for the "Menu Items" cluster elements for details.

mxLvSetName

Sets the name (the text that appears in the tree) for an item.

mxLvSetPathProperty

Writes a Path property to the property bag for the given Item taking care to make the path delimiters cross-platform.

mxLvSetPopupMenu

Specifies pop-up menu items for specified project item. The order in which menu items appear is determined by their order in the "Popup Menu Items" array. For each menu item, the text display description icon and event handling command tag can be specified; please refer to the help for the "Popup Menu Items" cluster elements for details.

mxLvSetPopupMenuBatch

Specifies pop-up menu items for specified project items. The order in which menu items appear is determined by their order in the "Menu Items" array. For each menu item, the text display description icon and event handling command tag can be specified; please refer to the help for the "Menu Items" cluster elements for details.

mxLvSetProperty

Writes a property to the property bag for the given item. This is a polymorphic VI.

mxLvSetRefProperty

Writes a reference property to the property bag for the given Item.

mxLvSetStringProperty

Writes a String property to the property bag for the given Item.

mxLvSetToolbar

Specifies toolbar items. The order in which toolbar items appear is determined by their order in the "Toolbar Items" array. For each toolbar item, the text display description icon and event handling command tag can be specified; please refer to the help for the "Toolbar Items" cluster elements for details.

mxLvSetVariantProperty

Writes variant property after converting to appropriate type to the property bag for the given Item.

mxLvSetVIRefProperty

Casts the given VI Reference to an Integer and writes the Integer to the property bag for the given Item.

mxLvSupportsInterface

Returns whether the given Item supports the specified interface.

mxLvSupportsInterfaceBatch

Returns whether the given Items support the specified interface.

mxLvUpdateUI

Forces the UI to update the item based on the specified flags.

mxLvUpdateUIBatch

Forces the UI to update the items based on the specified flags.