IVsProjectCfgProvider.OpenProjectCfg Method

Provides access to the IVsProjectCfg interface implemented on a project's configuration object.

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

Syntax

'Declaration
Function OpenProjectCfg ( _
    szProjectCfgCanonicalName As String, _
    <OutAttribute> ByRef ppIVsProjectCfg As IVsProjectCfg _
) As Integer

int OpenProjectCfg(
    string szProjectCfgCanonicalName,
    out IVsProjectCfg ppIVsProjectCfg
)

int OpenProjectCfg(
    [InAttribute] String^ szProjectCfgCanonicalName, 
    [OutAttribute] IVsProjectCfg^% ppIVsProjectCfg
)

abstract OpenProjectCfg : 
        szProjectCfgCanonicalName:string * 
        ppIVsProjectCfg:IVsProjectCfg byref -> int

function OpenProjectCfg(
    szProjectCfgCanonicalName : String, 
    ppIVsProjectCfg : IVsProjectCfg
) : int

Parameters

szProjectCfgCanonicalName
Type: System.String

[in] Pointer to the canonical name of the configuration to access.

ppIVsProjectCfg
Type: Microsoft.VisualStudio.Shell.Interop.IVsProjectCfg%

[out] Pointer to the IVsProjectCfg interface of the configuration identified by szProjectCfgCanonicalName.

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 IVsProjectCfgProvider::OpenProjectCfg(
   [in] LPCOLESTR szProjectCfgCanonicalName,
   [out] IVsProjectCfg **ppIVsProjectCfg
);

A build configuration's canonical name is string concatenation of three strings: the <Configuration Name> the literal string "|" and the platform name. For example, "Debug|Win32" or "Release|Win64" are valid canonical configuration names.

.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.