IVsProjectCfg.get_RootURL Method

Article
05/06/2010

Returns a configuration's root URL for its output items.

Namespace: Microsoft.VisualStudio.Shell.Interop
Assembly: Microsoft.VisualStudio.Shell.Interop (in Microsoft.VisualStudio.Shell.Interop.dll)

Syntax

'Déclaration
Function get_RootURL ( _
    <OutAttribute> ByRef pbstrRootURL As String _
) As Integer
'Utilisation
Dim instance As IVsProjectCfg
Dim pbstrRootURL As String
Dim returnValue As Integer

returnValue = instance.get_RootURL(pbstrRootURL)

int get_RootURL(
    out string pbstrRootURL
)

int get_RootURL(
    [OutAttribute] String^% pbstrRootURL
)

abstract get_RootURL : 
        pbstrRootURL:string byref -> int

function get_RootURL(
    pbstrRootURL : String
) : int

Parameters

pbstrRootURL
Type: System.String%
[out] Pointer to the root URL for the configuration's output items.

Return Value

Type: System.Int32
If the method succeeds, it returns S_OK. If it fails, it returns an error code.

Remarks

COM Signature

From vsshell.idl:

HRESULT IVsProjectCfg::get_RootURL(
   [out] BSTR *pbstrRootURL
);

If an output item's project-relative path is required, it is computed by removing the root URL from its deploy source URL which is retrieved by calling the output item's get_DeploySourceURL method.

The RootURL property is the root URL for project outputs. Essentially, if an output's project-relative path is required, it is computed by removing the RootURL from its DeploySourceURL. The output's project-relative path might be used internally (for example, for computing the relative path of the installed output that must be returned from get_RootRelativeURL) or for a deployment project.

Paths to items in the local file system begin with these eight characters: file:///.

Notes

Due to local firewall and other security settings, consumers of outputs may not be able to process URLs of other forms, so it is very important for projects that are generating URLs for local items to try to use this form of URL as much as possible.

.NET Framework Security

Full trust for the immediate caller. This member cannot be used by partially trusted code. For more information, see Using Libraries from Partially Trusted Code.

Partager via