IVsParseCommandLine.GetParam Method

Returns a parameter by index.

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

Syntax

'Declaration
Function GetParam ( _
    iIndex As Integer, _
    <OutAttribute> ByRef pbstrParam As String _
) As Integer
'Usage
Dim instance As IVsParseCommandLine
Dim iIndex As Integer
Dim pbstrParam As String
Dim returnValue As Integer

returnValue = instance.GetParam(iIndex, _
    pbstrParam)

int GetParam(
    int iIndex,
    out string pbstrParam
)

int GetParam(
    [InAttribute] int iIndex, 
    [OutAttribute] String^% pbstrParam
)

abstract GetParam : 
        iIndex:int * 
        pbstrParam:string byref -> int

function GetParam(
    iIndex : int, 
    pbstrParam : String
) : int

Parameters

iIndex
Type: System.Int32
[in] Index for the parameter to return.

pbstrParam
Type: System.String%
[out] Pointer to a string containing the parameter.

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

.NET Framework Security

Full trust for the immediate caller. This member cannot be used by partially trusted code. For more information, see Using Libraries from Partially Trusted Code.