IVsCfgProvider2.GetSupportedPlatformNames(UInt32, String[], UInt32[]) Method

Reference

Definition

Namespace:: Microsoft.VisualStudio.Shell.Interop

Assembly:: Microsoft.VisualStudio.Shell.Interop.dll

Assembly:: Microsoft.VisualStudio.Interop.dll

Important

Some information relates to prerelease product that may be substantially modified before it’s released. Microsoft makes no warranties, express or implied, with respect to the information provided here.

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

int GetSupportedPlatformNames(unsigned int celt, std::Array <std::wstring const &> const & rgbstr, std::Array <unsigned int> const & pcActual);

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

abstract member GetSupportedPlatformNames : uint32 * string[] * uint32[] -> int

Public Function GetSupportedPlatformNames (celt As UInteger, rgbstr As String(), Optional pcActual As UInteger()) As Integer

Parameters

celt: UInt32

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

rgbstr: 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: UInt32[]

[out, optional] Pointer to a count of the actual number of platform names returned.

Returns

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

Applies to