#include <Uri16.h>
Link against:
inetprotutil.lib
Interface status: |
deprecated |
Deprecated in 9.1 6.0
|
class TUriC16;
Description
Dependencies : TUriComponent. Comments : Provides non-modifying functionality on the components of a uri object as defined
in RFC2396. There are 5 components; scheme, authority, path, query and fragment.
The object holds descriptor pointers to the parsed uri components and a descriptor pointer to the uri. It is non-owning. It
uses 16-bit descriptors.
The functionality provided by this API allows the uri components to be extracted from the parsed uri, checked for their presence
in the uri and be compared with those in another TUriC16 object.
Members
Defined in TUriC16
:
Construction and destruction
Interface status: |
deprecated |
Deprecated in 9.1 |
protected: IMPORT_C TUriC16();
Description
Constructor.
Interface status: |
deprecated |
Inherited from: TUriC16 |
IMPORT_C HBufC* GetFileNameL() const;
Pre-Condition
Object is fully constructed.
Description
Generates a fully-qualified filename from a file URI object.
The form of the returned filename depends on the file location, as follows:
-
public file on removable media drive: The fully-qualified filename is resolved by finding the first drive on which the file
exists. If the file does not exist, this will Leave with KErrNotFound
file:///ext-media/path/to/file/name.ext -> f:\path\to\file\name.ext
(where f: is the first drive found containing "\path\to\file\name.ext")
-
private file on fixed drive:
file:///private/c/path/to/file/name.ext -> c:\private\0x1001234f\path\to\file\name.ext
(where 0x1001234f is the SID of the current application)
-
private file on removable media drive:
file:///private/ext-media/path/to/file/name.ext -> h:\private\0x1001234f\path\to\file\name.ext
(where h: is the first drive found containing "\private\0x1001234f\path\to\file\name.ext")
The returned file name is not guaranteed to exist except where specified above.
Be warned that this method may be slow when resolving special paths (like "/ext-media")
Return value
HBufC16 *
|
A descriptor containing the fully-qualified filename.
|
|
Leave codes
KErrNotSupported |
URI does not specify a local file
|
KErrNotFound |
If the URI indicates the file is on removable media and the file does not exist on any.
|
|
GetFileNameL(TUriFileName)const
Interface status: |
deprecated |
Inherited from: TUriC16 |
IMPORT_C HBufC* GetFileNameL(TUriFileName aType) const;
Pre-Condition
Object is fully constructed.
Description
This creates a file name from the URI, changing the network path separator (/) to the local file system path separator (\).
If called with EUriFileNamePath, this will generate a file name containing the path relative to the drive. Any parameters
in the URI are stripped off:
http://www.foo.com/dir/file/name.ext;param1;param2 -> \dir\file\name.ext
If called with EUriFileNameTail, this will generate a just the name, with no directories or drive. Any parameters in the URI
are stripped off:
http://www.foo.com/dir/file/name.ext;param1;param2 -> name.ext
EUriFileNamePath and EUriFileNameTail can be used for any hierarchical URI (http, ftp, file) and may have unexpected behaviour
when called on any other type of URI.
If called with EUriFileNameFull, this will convert the URI into a fully-qualified filename. this is only valid for file URIs
and will Leave if called on any other type of URI. The form of the returned filename is described in GetFileNameL with no
arguments.
Parameters
TUriFileName aType |
specifies what part of the filename is to be converted. The default is (EUriFileNameFull).
|
|
Return value
HBufC16 *
|
A descriptor containing the desired filename components.
|
|
Leave codes
KErrNotSupported |
The URI scheme cannot be converted into the desired type
|
|
Extract(TUriComponent)const
Interface status: |
deprecated |
Deprecated in 9.1 |
IMPORT_C const TDesC16& Extract(TUriComponent aComponent) const;
Description
Retrieves the specified component in the uri.
Parameters
Return value
const TDesC16 & |
A constant reference to a descriptor pointer to the specified component.
|
|
UriWithoutFragment(TPtrC16 &)const
Interface status: |
deprecated |
Deprecated in 9.1 |
IMPORT_C void UriWithoutFragment(TPtrC16 &aUriNoFrag) const;
Description
Retrieves the uri without the fragment component.
Parameters
TPtrC16 &aUriNoFrag |
An output parameter which is set the non-reference version of the uri.
|
|
IsPresent(TUriComponent)const
Interface status: |
deprecated |
Deprecated in 9.1 |
IMPORT_C TBool IsPresent(TUriComponent aComponent) const;
Description
Indicates whether the specified component is present in the uri.
Parameters
Return value
TBool
|
A boolean value of ETrue if the desired component is present, or EFalse if the desired component is not present.
|
|
Interface status: |
deprecated |
Deprecated in 9.1 |
IMPORT_C TBool IsSchemeValid() const;
Description
Checks to see if the scheme is valid. If there is no scheme then the return value indicates an invalid scheme (EFalse).
Return value
TBool
|
A boolean value of ETrue if the scheme is valid, or EFalse if the scheme is not.
|
|
Compare(const TUriC16 &,TUriComponent)const
Interface status: |
deprecated |
Deprecated in 9.1 |
IMPORT_C TInt Compare(const TUriC16 &aUri, TUriComponent aComponent) const;
Description
Compares the specified component against the one in the uri passed in.
Parameters
const TUriC16 &aUri |
The uri to compare components against.
|
TUriComponent aComponent |
The enum specifying the component to compare.
|
|
Return value
TInt
|
An integer value of zero if the components are the same, any other value if the components are not the same.
|
|
Interface status: |
deprecated |
Deprecated in 9.1 |
IMPORT_C const TDesC16& UriDes() const;
Description
Retrieves the descriptor for the entire uri.
Return value
const TDesC16 & |
A const reference to a descriptor pointer to the uri.
|
|
Interface status: |
deprecated |
Deprecated in 9.1 -- provided for compatibility |
IMPORT_C TInt Validate() const;
Description
Ensures that all components of the URI are valid. If the method returns KUriUtilsErrInvalidUri then one or more components
are not valid. It is possible for URIs declared valid by this method to be, on detailed inspection, invalid.
Return value
TInt
|
KErrNone for vaild URIs, KUriUtilsErrInvalidUri for invalid URIs or KErrNotSupported.
|
|
Equivalent(const TUriC16 &)const
Interface status: |
deprecated |
Deprecated in 9.1 -- provided for compatibility |
IMPORT_C TInt Equivalent(const TUriC16 &aUri) const;
Description
Compares the given URI to determine if it is equivalent to this URI. It is possible for URIs declared NOT equivalent by this
method to be equvalent to a level not checked by this method.
Parameters
const TUriC16 &aUri |
Contains URI to compare
|
|
Return value
TInt
|
ETrue if the two URIs are equivalent otherwise EFalse
|
|
DisplayFormL(TUriComponent)const
Interface status: |
deprecated |
Deprecated in 9.1 - provided for compatibility |
IMPORT_C HBufC* DisplayFormL(TUriComponent aComponent=EUriComplete) const;
Description
Create a new HBufC descriptor containing the desired component or the full URI.
Parameters
TUriComponent aComponent |
The component to convert into Unicode (EUriScheme - EUriFragment), or the full URI (EUriComplete -- the default).
|
|
Return value
HBufC16 *
|
The descriptor containing the desired component.
|
|
Interface status: |
deprecated |
Inherited from: TUriC16 |
protected: TPtrC16 iComponent[EUriMaxComponents];
Description
The array of descriptor pointers to the uri components.
Interface status: |
deprecated |
Inherited from: TUriC16 |
protected: TPtrC16 iUriDes;
Description
The descriptor pointer to the uri.