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

Definition

Namespace:

Microsoft.VisualStudio.Shell.Interop

Assembly:

Microsoft.VisualStudio.Interop.dll

Package:

Microsoft.VisualStudio.Interop v17.12.40391

Returns one or more platform names.

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

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

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

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

Parameters

celt

UInt32

[in] Specifies the requested number of 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 platform names specified by celt. This parameter can also be null if the celt parameter is zero. On output, rgbstr contains platform names.

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

Typically two calls are made to GetPlatformNames. With the first call, celt is set to zero, rgbstr to null, and pcActual to a valid address. GetPlatformNames returns with pcActual pointing to the number of platform names available. The caller uses this information to allocate rgbstr to the appropriate size and call GetPlatformNames a second time with celt set to the contents of pcActual.