Share via


IVsCfgProvider2.GetPlatformNames Method

Returns one or more platform names.

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

Syntax

'Declaration
Function GetPlatformNames ( _
    celt As UInteger, _
    <OutAttribute> rgbstr As String(), _
    <OutAttribute> pcActual As UInteger() _
) As Integer
int GetPlatformNames(
    uint celt,
    string[] rgbstr,
    uint[] pcActual
)
int GetPlatformNames(
    [InAttribute] unsigned int celt, 
    [OutAttribute] array<String^>^ rgbstr, 
    [OutAttribute] array<unsigned int>^ pcActual
)
abstract GetPlatformNames : 
        celt:uint32 * 
        rgbstr:string[] byref * 
        pcActual:uint32[] byref -> int
function GetPlatformNames(
    celt : uint, 
    rgbstr : String[], 
    pcActual : uint[]
) : int

Parameters

  • celt
    Type: System.UInt32

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

  • 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::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 nulla null reference (Nothing in Visual Basic), 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.

.NET Framework Security

See Also

Reference

IVsCfgProvider2 Interface

Microsoft.VisualStudio.Shell.Interop Namespace