InDesign SDK  20.5
 All Classes Namespaces Functions Variables Typedefs Enumerations Enumerator Friends Groups Pages
IURIUtils Class Referenceabstract

#include <IURIUtils.h>

Inheritance diagram for IURIUtils:
IPMUnknown

Public Types

enum  { kDefaultIID = IID_IURIUTILS }
 

Public Member Functions

virtual bool IDFileToURI (const IDFile &file, URI &uri) const =0
 
virtual bool URIToIDFile (const URI &uri, IDFile &file) const =0
 
virtual bool URIListToSysFileList (const URIList &uriList, SysFileList &sysFileList) const =0
 
virtual bool SysFileListToURIList (const SysFileList &sysFileList, URIList &uriList) const =0
 
virtual bool CloudAssetRefToURI (const std::string &assetRef, URI &uri) const =0
 
- Public Member Functions inherited from IPMUnknown
virtual IPMUnknownQueryInterface (PMIID interfaceID) const =0
 
virtual void AddRef () const =0
 
virtual void Release () const =0
 

Detailed Description

Utility interface that provides methods used to manipulate Uniform Resource Identifiers (URI).

See Also
IDFile
URI

Member Function Documentation

virtual bool IURIUtils::CloudAssetRefToURI (const std::string & assetRef,
URIuri 
) const
pure virtual

Convert the Cloud asset ref to a URI

Parameters
assetRef[IN] the asset ref to convert.
uri[OUT] Resulting URI.
Returns
kTrue if the conversion succeeds.
virtual bool IURIUtils::IDFileToURI (const IDFilefile,
URIuri 
) const
pure virtual

Converts an IDFile to an URI.

Parameters
file[IN] IDFile to convert.
uri[OUT] Resulting URI.
Returns
True if the conversion succeeds, else false.
virtual bool IURIUtils::SysFileListToURIList (const SysFileListsysFileList,
URIListuriList 
) const
pure virtual

Convert the URIList to a SysFileList

Parameters
sysFileList[IN] the list of sys files to convert.
uriList[OUT] the list of URIs
Returns
kTrue if the conversion succeeds.
virtual bool IURIUtils::URIListToSysFileList (const URIListuriList,
SysFileListsysFileList 
) const
pure virtual

Convert the sys file list to a URIList

Parameters
uriList[IN] the list of URIs to convert.
sysFileList[OUT] the list of IDFiles
Returns
kTrue if the conversion succeeds.
virtual bool IURIUtils::URIToIDFile (const URIuri,
IDFilefile 
) const
pure virtual

Converts an URI to an IDFile.

Parameters
uri[IN] URI to convert.
file[OUT] Resulting IDFile.
Returns
True if the conversion succeeds, else false.