MINETRES Class Reference

MicroImages Network Resource class. More...

#include <mi32/minetres.h>

List of all members.

Public Types

enum  DISPLAYTYPE {
  DISPLAYTYPE_Invalid = 0, DISPLAYTYPE_Network, DISPLAYTYPE_Domain, DISPLAYTYPE_Server,
  DISPLAYTYPE_Share, DISPLAYTYPE_Directory, DISPLAYTYPE_Generic
}
enum  USAGE { USAGE_Invalid = 0, USAGE_Container, USAGE_Connectable }

Public Member Functions

 ~MINETRES ()
ERRVALUE BuildChildList (MILIST< MINETRES > &ChildList)
const MISTRINGGetDescription () const
const MISTRINGGetDisplayName () const
DISPLAYTYPE GetDisplayType () const
const MISTRINGGetRemoteName () const
USAGE GetUsage () const

Static Public Member Functions

static ERRVALUE BuildMainList (MILIST< MINETRES > &MainList)
static ERRVALUE BuildServerList (MISTRINGLIST &ServerList)
static ERRVALUE ConstructFromHost (const MISTRING &HostPath, MINETRES *&pNetResRet)
static void ResetServerList ()

Detailed Description

MicroImages Network Resource class.

To use this class, start by calling MINETRES::BuildMainList(). The returned list of items may then be iterated through to determine their type and usage and to build their child lists using BuildChildList().

Use of this class in Windows (X or native) requires the 'mpr.lib' library.


Member Enumeration Documentation

Item "display type" values.

Enumerator:
DISPLAYTYPE_Invalid 
DISPLAYTYPE_Network 
DISPLAYTYPE_Domain 
DISPLAYTYPE_Server 
DISPLAYTYPE_Share 
DISPLAYTYPE_Directory 
DISPLAYTYPE_Generic 

Item "usage" values.

Enumerator:
USAGE_Invalid 
USAGE_Container 
USAGE_Connectable 

Constructor & Destructor Documentation

MINETRES::~MINETRES (  ) 

Destructor.


Member Function Documentation

ERRVALUE MINETRES::BuildChildList ( MILIST< MINETRES > &  ChildList  ) 

Build list of child items for this item.

Parameters:
ChildList List of child items returned
static ERRVALUE MINETRES::BuildMainList ( MILIST< MINETRES > &  MainList  )  [static]

Build main item list from "root" of "network neighborhood".

Parameters:
MainList List of network resource items returned
static ERRVALUE MINETRES::BuildServerList ( MISTRINGLIST ServerList  )  [static]

Build list of server names.

Parameters:
ServerList Names of servers/hosts returned, will be in form of \hostname
static ERRVALUE MINETRES::ConstructFromHost ( const MISTRING HostPath,
MINETRES *&  pNetResRet 
) [static]

Construct from server host path.

Parameters:
HostPath Host path, may be just name or \hostname
pNetResRet MINETRES instance returned if successful, NULL if not
const MISTRING& MINETRES::GetDescription (  )  const [inline]

Get description for display in list.

const MISTRING& MINETRES::GetDisplayName (  )  const [inline]

Get name to display in list.

DISPLAYTYPE MINETRES::GetDisplayType (  )  const

Get display type for resource.

const MISTRING& MINETRES::GetRemoteName (  )  const [inline]
USAGE MINETRES::GetUsage (  )  const

Get resource usage.

static void MINETRES::ResetServerList (  )  [static]

Reset known list of servers.


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

Generated on Sun Oct 7 21:33:38 2012 for TNTsdk 2012 by  doxygen 1.6.1