nsILocalFile:getRelativeDescriptor

From MDC

« XPCOM API Reference

Contents 1 Summary 2 Parameters 3 Return Values 4 Remarks 5 See Also

[edit] Summary

This method returns a cross-platform representation of a relative file path.

 ACString getRelativeDescriptor(
   in nsILocalFile aFromFile
 );

[edit] Parameters

aFromFile

[in] The file from which the returned descriptor is relative. There is no defined result if this param is null.

[edit] Return Values

An opaque string value with undefined character encoding. This string is not intended for display to users.

[edit] Remarks

The result returned from this method may be used with setRelativeDescriptor to initialize a nsILocalFile instance.

[edit] See Also

nsILocalFile, setRelativeDescriptor