IVirtualFileSystemGetCaption Method

Determine the caption for a script.

Namespace: WinWrap.Basic.Server
Assembly: WinWrap.Basic.Server (in WinWrap.Basic.Server.dll)

Syntax

string GetCaption(
	string scriptPath
)

Function GetCaption ( 
	scriptPath As String
) As String

String^ GetCaption(
	String^ scriptPath
)

scriptPath String: The path of the script which is always in canonical form as returned by the Combine method.

String
The short form of the script's path for display by the IDE.

Remarks

Implement this method to get the script's caption.

Example

IVirtualFileSystem implementation which uses the normal file system.

public string GetCaption(string scriptPath)
{
    return Path.GetFileName(scriptPath);
}

Function GetCaption(ByVal scriptPath As String) As String
    Return Path.GetFileName(scriptPath)
End Function