IVsProjectTextImageProvider.OpenItemTextImage Method
Opens a text image for a given file.
Namespace: Microsoft.VisualStudio.Shell.Interop
Assembly: Microsoft.VisualStudio.Shell.Interop (in Microsoft.VisualStudio.Shell.Interop.dll)
Syntax
'Declaration
Function OpenItemTextImage ( _
pszMkDocument As String, _
grfMode As UInteger, _
<OutAttribute> ByRef ppTextImage As VsTextImage _
) As Integer
int OpenItemTextImage(
string pszMkDocument,
uint grfMode,
out VsTextImage ppTextImage
)
int OpenItemTextImage(
[InAttribute] String^ pszMkDocument,
[InAttribute] unsigned int grfMode,
[OutAttribute] VsTextImage^% ppTextImage
)
abstract OpenItemTextImage :
pszMkDocument:string *
grfMode:uint32 *
ppTextImage:VsTextImage byref -> int
function OpenItemTextImage(
pszMkDocument : String,
grfMode : uint,
ppTextImage : VsTextImage
) : int
Parameters
pszMkDocument
Type: String[in] Pointer to a string containing the file name and path.
grfMode
Type: UInt32[in] Integer. The mode in which to open the image—read only or read/write. A value from the __VSPTIP_MODE enumeration.
ppTextImage
Type: Microsoft.VisualStudio.TextManager.Interop.VsTextImage%[out] Pointer to the created IVsTextImage interface.
Return Value
Type: Int32
If the method succeeds, it returns S_OK. If it fails, it returns an error code.
Remarks
COM Signature
From vsshell.idl:
[C++]
HRESULT IVsProjectTextImageProvider::OpenItemTextImage(
[in] LPCOLESTR pszMkDocument,
[in] VSPTIP_MODE grfMode
);
.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.