ISession Interface Reference

The MiKTeX session interface. More...

import "MiKTeX208-session.idl";

Inheritance diagram for ISession:

ISession2

List of all members.

Public Member Functions

HRESULT RegisterRootDirectories ([in] BSTR rootDirectories)
 Register MiKTeX root directories.
HRESULT FindPkFile ([in] BSTR fontName,[in] BSTR mode,[in] LONG dpi,[out] BSTR *path,[out, retval] VARIANT_BOOL *found)
 Find a Pk file.
HRESULT GetErrorInfo ([out, retval] ErrorInfo *errorInfo)
 Get information about the last error.
HRESULT GetMiKTeXSetupInfo ([out, retval] MiKTeXSetupInfo *setupInfo)
 Get information about the MiKTeX setup.
HRESULT GetRootDirectory ([in] LONG rootIdx,[out, retval] BSTR *rootDirectory)
 Get a configured root directory.


Detailed Description

The MiKTeX session interface.

This interface provides MiKTeX core functionality.


Member Function Documentation

HRESULT ISession::FindPkFile ( [in] BSTR  fontName,
[in] BSTR  mode,
[in] LONG  dpi,
[out] BSTR *  path,
[out, retval] VARIANT_BOOL *  found 
)

Find a Pk file.

Parameters:
[in] fontName The name of the font (e.g. "cmr10").
[in] mode The METAFONT mode to be used (e.g. "ljfour").
[in] dpi The resolution to be used (e.g. 600).
[out] path The fully qualified path to the Pk file.
Returns:
Returns VARIANT_TRUE, if the Pk file exists.

HRESULT ISession::GetErrorInfo ( [out, retval] ErrorInfo errorInfo  ) 

Get information about the last error.

Returns:
Returns an error information record.

HRESULT ISession::GetMiKTeXSetupInfo ( [out, retval] MiKTeXSetupInfo setupInfo  ) 

Get information about the MiKTeX setup.

Returns:
Returns an MiKTeX setup info record.

HRESULT ISession::GetRootDirectory ( [in] LONG  rootIdx,
[out, retval] BSTR *  rootDirectory 
)

Get a configured root directory.

Parameters:
[in] rootIdx Index of the requested root directory.
Returns:
Returns the requested root directory.

HRESULT ISession::RegisterRootDirectories ( [in] BSTR  rootDirectories  ) 

Register MiKTeX root directories.

Parameters:
[in] rootDirectories A semicolon-separated list of path names.


The documentation for this interface was generated from the following file:

Generated on Sun Sep 27 19:23:33 2009 for MiKTeX by  doxygen 1.5.7.1