InetUtils Namespace Reference

Allows string resource sharing. More...

Functions
TCHAR *	GetStringField (UINT32 nIndex, UINT32 nCompositeStringID)
String_256	MakeURL (const String_256 &rRelativePath, const String_256 &rRootURL)
	Allows us to obtain the URL of a file knowing its relative path (from the main clipart index file) and the root URL. The URL is necessary to download the file.
String_256	MakeLocalPath (const String_256 &rRelPath)
BOOL	GetTempInetDir (String_256 *pTempDir)
	Get path to the internet cache directory used to download web clipart files.
BOOL	GetAppDataPath (String_256 *pPath)
BOOL	GetAppCachePath (String_256 *pPath)
BOOL	DeleteDirectoryTree (const String_256 &rPath)
	remove a directory tree from the hard drive

---

Detailed Description

Allows string resource sharing.

Author:

Adrian_Stoicar (Xara Group Ltd) <camelotdev@xara.com>

Date:

3/01/97

Parameters:

nCompositeStringID

- ID of the composite string [INPUTS] nIndex - relative position of the field within the composite string

Returns:

a pointer to a buffer containing the field, NULL if the string is not valid/composite

Note: The composite string is limited to 1024 characters

---

Function Documentation

BOOL InetUtils::DeleteDirectoryTree (  const String_256 &  rPath  )

remove a directory tree from the hard drive Author: Adrian_Stoicar (Xara Group Ltd) <camelotdev@xara.com> Date: 1712/96 Parameters: reference  to String_256 containing the path to the root directory [INPUTS] of the tree to be removed. Returns: TRUE if successful, FALSE in case of total or partial failure (some of the files are locked etc.) See also: PathNameEx::RemoveRecursively() Definition at line 3153 of file sgliboil.cpp. { PathNameEx dirPath(rPath); return dirPath.Remove(); }}

BOOL InetUtils::GetAppCachePath (  String_256 *  pPath  )

Definition at line 3123 of file sgliboil.cpp. { if (!GetAppDataPath(pPath)) return FALSE; *pPath += String_256(_R(IDS_CACHEPATH)); // _R(IDS_CACHEPATH) == "Cache\\" return TRUE; }

BOOL InetUtils::GetAppDataPath (  String_256 *  pPath  )

Definition at line 3095 of file sgliboil.cpp. { #if defined(__WXMSW__) if (!SUCCEEDED(SHGetFolderPath(NULL, CSIDL_LOCAL_APPDATA | CSIDL_FLAG_CREATE, NULL, 0, static_cast<TCHAR *>(*pPath)))) return FALSE; #else #pragma error( "No equiverlent for SHGetFolderPath" ) #endif *pPath += wxT("\\"); *pPath += String_256(PRODUCT_MANUFACTURER); // PRODUCT_MANUFACTURER == "Xara" *pPath += wxT("\\"); *pPath += String_256(PROGRAM_NAME); // PROGRAM_NAME == "Xara X" || "Xara X (debug)" *pPath += wxT("\\"); return TRUE; }

TCHAR * InetUtils::GetStringField (  UINT32  nIndex, UINT32  nCompositeStringID )

Definition at line 2979 of file sgliboil.cpp. { PORTNOTETRACE("dialog","GetStringField - do nothing"); #ifndef EXCLUDE_FROM_XARALX TCHAR rgtchBuff[1024]; BOOL bLoad = ::LoadString(AfxGetResourceHandle(), nCompositeStringID, rgtchBuff, sizeof(rgtchBuff)); ERROR3IF(!bLoad, "Failed to load string from resource"); TCHAR* szField = _tcstok(rgtchBuff, _T("|")); for (UINT32 i = 0; i < nIndex && szField; i++) szField = _tcstok(NULL, _T("|")); return szField; #else return NULL; #endif }

BOOL InetUtils::GetTempInetDir (  String_256 *  pTempDir  )

Get path to the internet cache directory used to download web clipart files. > BOOL InetUtils::GetTempInetDir(String_256* pTempDir) Author: Adrian_Stoicar (Xara Group Ltd) <camelotdev@xara.com> (rewritten by Jonathan) Date: 1712/96 (rewritten 31 Jan 2001) Parameters: pTempDir  (out) - string returning the path to the OS temporary internet [INPUTS] Returns: TRUE if successful, FALSE otherwise Definition at line 3071 of file sgliboil.cpp. { #if defined(__WXMSW__) if (!SUCCEEDED(SHGetFolderPath(NULL, CSIDL_INTERNET_CACHE | CSIDL_FLAG_CREATE, NULL, 0, static_cast<TCHAR *>(*pTempDir)))) return FALSE; #else #pragma error( "No equiverlent for SHGetFolderPath" ) #endif *pTempDir += wxT("\\"); return TRUE; }

String_256 InetUtils::MakeLocalPath (  const String_256 &  rRelPath  )

Definition at line 3049 of file sgliboil.cpp. { String_256 strAppDataPath; GetAppDataPath(&strAppDataPath); if (strAppDataPath.IsEmpty()) // failed to get the path for some reason return strAppDataPath; PathNameEx appDataPath(strAppDataPath); String_256 strLocalPath = appDataPath.GetLocation(TRUE); strLocalPath += String_256(_R(IDS_CACHEPATH)); strLocalPath += rRelPath; return strLocalPath; }

String_256 InetUtils::MakeURL (  const String_256 &  rRelativePath, const String_256 &  rRootURL )

Allows us to obtain the URL of a file knowing its relative path (from the main clipart index file) and the root URL. The URL is necessary to download the file. Author: Adrian_Stoicar (Xara Group Ltd) <camelotdev@xara.com> Date: 15/12/96 Params: rRelativePath (in) - const reference to string holding a relative file path (no leading slash), ex. "clipart\\drawings\\xarainfo\\xaraclip.txt" rRootURL (in) - const reference to string holding the root clipart URL on our web site, currently "http://www.xara.com/" Returns: URL of file on our site as a String_256 object. Note that this has no lvalue and should only be used as an initializer for a local string. Definition at line 3017 of file sgliboil.cpp. { String_256 strURL = rRootURL; INT32 nCharCount = rRelativePath.Length(); if (camStrstr( (const TCHAR *)strURL, _T("file://") ) ) strURL += rRelativePath; else for (INT32 i = 0; i < nCharCount; i++) { // Walk down the relative path string, appending characters to the URL as we go along // Backslashes are converted to normal slashes if (rRelativePath[i] == _T('\\')) strURL += _T('/'); else strURL += camTolower( rRelativePath[i] ); } return strURL; }

---