INTEGRATION: CWS fwkpostbeta1 (1.3.42); FILE MERGED

2005/02/14 09:42:39 sb 1.3.42.1: #119209# Added documentation about potential problems.

1 files changed, 28 insertions, 2 deletions

diff --git a/svtools/inc/urihelper.hxx b/svtools/inc/urihelper.hxx
index 473749663eff..8a9f2ad142fd 100644
--- a/svtools/inc/urihelper.hxx
+++ b/svtools/inc/urihelper.hxx
@@ -2,9 +2,9 @@
  *
  *  $RCSfile: urihelper.hxx,v $
  *
- *  $Revision: 1.3 $
+ *  $Revision: 1.4 $
  *
- *  last change: $Author: rt $ $Date: 2005-01-11 13:10:57 $
+ *  last change: $Author: kz $ $Date: 2005-03-21 13:30:20 $
  *
  *  The Contents of this file are made available subject to the terms of
  *  either of the following licenses
@@ -94,6 +94,19 @@ class UniString;
 //============================================================================
 namespace URIHelper {
 
+/**
+   @ATT
+   Calling this function with defaulted arguments rMaybeFileHdl = Link() and
+   bCheckFileExists = true often leads to results that are not intended:
+   Whenever the given rTheBaseURIRef is a file URL, the given rTheRelURIRef is
+   relative, and rTheRelURIRef could also be smart-parsed as a non-file URL
+   (e.g., the relative URL "foo/bar" can be smart-parsed as "http://foo/bar"),
+   then SmartRel2Abs called with rMaybeFileHdl = Link() and bCheckFileExists =
+   true returns the non-file URL interpretation.  To avoid this, either pass
+   some non-null rMaybeFileHdl if you want to check generated file URLs for
+   existence (see URIHelper::GetMaybeFileHdl), or use bCheckFileExists = false
+   if you want to generate file URLs without checking for their existence.
+*/
 UniString
 SmartRel2Abs(INetURLObject const & rTheBaseURIRef,
              ByteString const & rTheRelURIRef,
@@ -108,6 +121,19 @@ SmartRel2Abs(INetURLObject const & rTheBaseURIRef,
              bool bRelativeNonURIs = false,
              INetURLObject::FSysStyle eStyle = INetURLObject::FSYS_DETECT);
 
+/**
+   @ATT
+   Calling this function with defaulted arguments rMaybeFileHdl = Link() and
+   bCheckFileExists = true often leads to results that are not intended:
+   Whenever the given rTheBaseURIRef is a file URL, the given rTheRelURIRef is
+   relative, and rTheRelURIRef could also be smart-parsed as a non-file URL
+   (e.g., the relative URL "foo/bar" can be smart-parsed as "http://foo/bar"),
+   then SmartRel2Abs called with rMaybeFileHdl = Link() and bCheckFileExists =
+   true returns the non-file URL interpretation.  To avoid this, either pass
+   some non-null rMaybeFileHdl if you want to check generated file URLs for
+   existence (see URIHelper::GetMaybeFileHdl), or use bCheckFileExists = false
+   if you want to generate file URLs without checking for their existence.
+*/
 UniString
 SmartRel2Abs(INetURLObject const & rTheBaseURIRef,
              UniString const & rTheRelURIRef,