IVsStructuredFileIO.GetFormatInfo Method

Returns the format information for the format index.

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

Syntax

'Declaration
Function GetFormatInfo ( _
    nFormatIndex As UInteger, _
    <OutAttribute> puiCodePage As UInteger() _
) As Integer
'Usage
Dim instance As IVsStructuredFileIO
Dim nFormatIndex As UInteger
Dim puiCodePage As UInteger()
Dim returnValue As Integer

returnValue = instance.GetFormatInfo(nFormatIndex, _
    puiCodePage)

int GetFormatInfo(
    uint nFormatIndex,
    uint[] puiCodePage
)

int GetFormatInfo(
    [InAttribute] unsigned int nFormatIndex, 
    [OutAttribute] array<unsigned int>^ puiCodePage
)

abstract GetFormatInfo : 
        nFormatIndex:uint32 * 
        puiCodePage:uint32[] byref -> int

function GetFormatInfo(
    nFormatIndex : uint, 
    puiCodePage : uint[]
) : int

Parameters

nFormatIndex
Type: System.UInt32
[in] Integer containing the format index.

puiCodePage
Type: array<System.UInt32[]
[out, optional] Pointer to CodePage.

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 IVsStructuredFileIO::GetFormatInfo(
   [in] ULONG nFormatIndex,
   [out, optional] UINT *puiCodePage
);

.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.