IVsParseCommandLine.GetParam(Int32, String) Method

Definition

Namespace:

Microsoft.VisualStudio.Shell.Interop

Assembly:

Microsoft.VisualStudio.Interop.dll

Package:

Microsoft.VisualStudio.Interop v17.12.40391

Returns a parameter by index.

public:
 int GetParam(int iIndex, [Runtime::InteropServices::Out] System::String ^ % pbstrParam);

int GetParam(int iIndex, [Runtime::InteropServices::Out] std::wstring const & & pbstrParam);

public int GetParam (int iIndex, out string pbstrParam);

abstract member GetParam : int * string -> int

Public Function GetParam (iIndex As Integer, ByRef pbstrParam As String) As Integer

Parameters

iIndex

Int32

[in] Index for the parameter to return.

pbstrParam

String

[out] Pointer to a string containing the parameter.

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 IVsParseCommandLine::GetParam(  
   [in] int iIndex,   
   [out, retval] BSTR* pbstrParam  
);