IDocFetchProvider.AttachToDocument Method

Performs access-control checking on the document to be retrieved using either the user's current preferences or the information set in the portal Data Source editor. If read access is allowed, returns the IDocFetch object used to retrieve the document.

IDocFetch AttachToDocument(
   string sDocumentLocation,
   string Locale,
   string Signature,
   DocumentFormat fFormat,
   UserPrefs userPrefs,
   UserInfo userInfo
);

Parameters

sDocumentLocation: the backend-specific location of this document
Locale: the string code for the locale to be used
Signature: the signature of the document
fFormat: the DocumentFormat flag to indicate whether the document is being accessed for indexing or retrieval (clickthrough)
userPrefs: the requesting user's User Preference settings
userInfo: the requesting user's User Information settings

Return Value

an instance of the implementation of IDocFetch

Exceptions

Exception Type	Condition
NoLongerExistsException	if the document has been removed
NotAvailableException	if the document is temporarily unavailable
NotInitializedException	if the `IDocFetchProvider` is in an uninitialized state
AccessDeniedException	if access to this document is denied

IDocFetchProvider.AttachToDocument Method

Parameters

Return Value

Exceptions

See Also