IVsCfgProvider2.GetSupportedPlatformNames Method

Article
05/06/2010

Returns the set of platforms that are installed on the user's machine.

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

Syntax

'Déclaration
Function GetSupportedPlatformNames ( _
    celt As UInteger, _
    <OutAttribute> rgbstr As String(), _
    <OutAttribute> pcActual As UInteger() _
) As Integer
'Utilisation
Dim instance As IVsCfgProvider2
Dim celt As UInteger
Dim rgbstr As String()
Dim pcActual As UInteger()
Dim returnValue As Integer

returnValue = instance.GetSupportedPlatformNames(celt, _
    rgbstr, pcActual)

int GetSupportedPlatformNames(
    uint celt,
    string[] rgbstr,
    uint[] pcActual
)

int GetSupportedPlatformNames(
    [InAttribute] unsigned int celt, 
    [OutAttribute] array<String^>^ rgbstr, 
    [OutAttribute] array<unsigned int>^ pcActual
)

abstract GetSupportedPlatformNames : 
        celt:uint32 * 
        rgbstr:string[] byref * 
        pcActual:uint32[] byref -> int

function GetSupportedPlatformNames(
    celt : uint, 
    rgbstr : String[], 
    pcActual : uint[]
) : int

Parameters

celt
Type: System.UInt32
[in] Specifies the requested number of supported platform names. If this number is unknown, celt can be zero.

rgbstr
Type: array<System.String[]
[in, out, size_is(celt)] On input, an allocated array to hold the number of names specified by celt. This parameter can also be null if the celt parameter is zero. On output, rgbstr contains the names of supported platforms.

pcActual
Type: array<System.UInt32[]
[out, optional] Pointer to a count of the actual number of platform names returned.

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 IVsCfgProvider2::GetSupportedPlatformNames(
   [in] ULONG celt,
   [in, out, size_is(celt)] BSTR rgbstr[],
   [out, optional] ULONG *pcActual
);

The set of platform names returned by GetSupportedPlatformNames are the platforms that could be added to a project. A particular project could use one or more of the installed platforms. For example, it is possible to have both the Win32 and Win64 platforms for Visual C++ installed. One project might build for only one of the platforms while another project might build for both platforms.

An individual project type specifies the meaning of each platform. The environment provides the UI that displays the names of the available platforms.

Typically, two calls are made to GetSupportedPlatformNames. With the first call, celt is set to zero, rgbstr to nulla null reference (Nothing in Visual Basic), and pcActual to a valid address. GetSupportedPlatformNames returns with pcActual pointing to the number of supported platform names available. The caller uses this information to allocate rgbstr to the appropriate size and call GetSupportedPlatformNames a second time with celt set to the contents of pcActual.

.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