IVsCfgProvider2.GetCfgNames(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 configuration names.

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

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

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

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

Parameters

celt

UInt32

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

pcActual

UInt32[]

[out, optional] Pointer to a count of the actual number of property 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::GetCfgNames(  
   [in] ULONG celt,  
   [in, out, size_is(celt)] BSTR rgbstr[],  
   [out, optional] ULONG *pcActual  
);  

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