documentForUrl( )

Returns a document for a URL.

Interface

PODSDocumentMgr

IDL definition

PODSDocument documentForUrl(
  PODSString url,
  out PODSBoolean handled
);

JavaScript synopsis

Not applicable

C synopsis

PODSDocument* PODSdocumentForUrl(
  PODSDocumentMgr* docmgr,
  PODSString str,
  PODSBoolean* handled
);

Parameters

docmgr The PODSDocumentMgr object.
str [in] The URL for the document.
handled [out] Indicates whether the request was handled successfully: PODS_TRUE on success; PODS_FALSE otherwise. You may return handled as PODS_TRUE while returning a null PODSDocument. Returning handled as PODS_TRUE merely indicates that no further processing is needed.

Returns

PODSDocument object for specified URL. May be NULL.

Remarks

Your document manager should implement this method or documentForSubmission( ).

The PODSDocumentMgr implementation of documentForUrl( ) walks through all the registered document sources until a document with a matching URL is found, while the PODSDocumentSrc implementation only checks the specified document source.