%ZHSLIB.PackageManager.Developer.Extension.SourceControl.ISC

Inherited description: Name of page to help configure source control on a per-module basis

Inherited description: This is called after the UserAction() and after any template is run or dialog is displayed. For a list of input arguments see UserAction(). In the case of the dialog the button pushed by the user is passed in Answer:

• 0 - No
• 1 - Yes
• 2 - Cancel

For the dialog that contains a textbox field the text of this field is passed in 'Msg' argument. In the case of a template if the template was closed from the 'x' button then Answer=2 to indicate the user attempted to cancel the operation. Otherwise if the template closed normally by getting to the end Answer=1. For the cases where Studio did not perform any interaction this method is not called. The default implementation is to call the standard source control tags . If the Reload argument is set to true by this method then the current document will be reloaded in Studio.

Check this routine/class/csp file out of source control.
Following successful checkout, the copy of the file on disk is loaded into the Namespace, unless Load is false.

Invoked after zpm "init" to configure settings for this source control class

Returns value that shows whether or not this instance is "Disconnected" from Perforce

Return values are:

• 0: Instance is Connected
• 1: Instance is Disconnected but could connect at a future time
• 2: Instance is Permanently Disconnected (no plans of ever connecting to Perforce)

Export items to source control dir, or to AltPath as UDL if not mapped in source control

After compilation, check out any .GBL resources and re-export. TODO: revert if unchanged.

Return filename of this item Override superclass method to honor new convention: if name starts with special characters defined in ..#NOPREFIXCHARCODE, then don't use the prefix path in ^Sources

Return the name of this item without the prefix to be added by ExtName

Invoked after build process runs

Invoked after each lifecycle phase

Inherited description: This is called after the item has been saved to the database. It may be passed a reference to the object representing the item just saved. It can be use to export this documement to an external form for example.

Invoked before build process runs. Sets $$$BuildFlag; for dev builds, creates %SourceControl and backs up ^Sources.

Invoked before each lifecycle phase

Before validation, export all resources that have not been added to source control to their proper location, if any, and mark them for add.

Invoked when an existing module is reloaded from a different directory than its known module root Removes mappings for all of the module's resources (to prevent an automatic p4 move)

Invoked when the user has attempted to edit a module document reported by the active Studio extension as read-only (i.e., because it is not checked out)

Inherited description: This is called for every menu item returned to Studio to allow the menu to be enabled/disabled without having to write a custom query for MenuItems. The DisplayName of this menu is also passed by reference and this may be modified to change the appearance of this menu item. The MenuName is the main menu name then the submenu name separated by a ','. If Enabled is set to -1 then it will remove this menu item from the list totally, 0 will gray the menu item out, and the default 1 will display the menu item as normal.

Invoked when the list of resources for a module changes.

Called to delete this item from source control

Utility method to remove all mappings for a named module.

Gets the latest revision of all files within filesystem-based repositories that fall within the current namespace's Perforce workspace.

Inherited description: Undo the checkout of this item.

Utility method to update mappings for a named module, placing the module's root at a given path. Note: pPath is expected to be an absolute path, possibly prefixed with $c(8).

Inherited description: This is called when the user performs an action that may need to interact with the server, such as selecting a menu or adding a new document. This encompases what the deprecated Flags parameter did and allows additional flexibility.

The Type argument values are:

• 0 : Server defined menu item selected
• 1 : Other Studio action

When a menu item is selected the Name argument is the name of this menu item in the format '<MainMenu>,<SubMenu>'. For other Studio actions the Name argument is one of:

• 0 : User has tried to change a document that is locked in source control
• 1 : User has created a new document
• 2 : User has deleted a document
• 3 : User has opened a document
• 4 : User has closed a document
• 5 : User has connected to a new namespace
• 6 : User has selected to import comma delimetered list of documents
• 7 : User has saved a new document for the first time

The InternalName argument is the name of the document about which this action occurs. If there is any selected text in the document which has focus this is sent in the SelectedText argument. The Action argument is set by this method to tell Studio what to do. Possible return values for this are:

• 0 : Do nothing, note that this method can still perform some action such as check an item out of source control, but Studio will not ask for user input.
• 1 : Display the default Studio dialog with a yes/no/cancel button. The text for this dialog is provided in the 'Target' return argument.
• 2 - Run a CSP page/Template. The Target is the full url to the CSP page/Template, as usual the page will be passed the current document name, any selected text, the project name, the namespace.
• 3 - Run an EXE on the client. The Target is the name of an executable file on the client machine. It is the responsibility of the customer to ensure this EXE is installed in a suitable location.
• 4 - Insert the text in Target in the current document at the current selection point.
• 5 - Studio will open the documents listed in Target. If there are multiple documents to open they will be separated with commas. If the document name is 'test.mac:label+10' it will open the document 'test.mac' and goto 'label+10'.
• 6 - Display an alert dialog in Studio with the text from the Target variable.
• 7 - Display a dialog with a textbox and Yes/No/Cancel buttons. The text for this dialog is provided by the 'Target' return argument. The initial text for the textbox is provided by the 'Msg' return argument.

If the Reload argument is set to true then the current document will be reloaded in Studio. This is useful if you change the document to change its attribute so Studio will pick up these changes.