DocumentRepositoryTryGetPhysicalFile(DocumentMetadata, PhysicalFile) Method

Attempts to retrieve the physical file related to a DocumentMetadata

Namespace: Ignition.DocumentManagement
Assembly: CatalystFire.Ignition (in CatalystFire.Ignition.dll) Version: 12.0.28229

Syntax

C++

Copy

public bool TryGetPhysicalFile(
	DocumentMetadata documentMetadata,
	out PhysicalFile fileShim
)

Public Function TryGetPhysicalFile ( 
	documentMetadata As DocumentMetadata,
	<OutAttribute> ByRef fileShim As PhysicalFile
) As Boolean

public:
virtual bool TryGetPhysicalFile(
	DocumentMetadata^ documentMetadata, 
	[OutAttribute] PhysicalFile^% fileShim
) sealed

abstract TryGetPhysicalFile : 
        documentMetadata : DocumentMetadata * 
        fileShim : PhysicalFile byref -> bool 
override TryGetPhysicalFile : 
        documentMetadata : DocumentMetadata * 
        fileShim : PhysicalFile byref -> bool

Parameters

documentMetadata DocumentMetadata: The DocumentMetadata whose corresponding physical file should be retrieved
fileShim PhysicalFile: The retrieved file if successful; otherwise null

Return Value

Boolean
True if the file was retrieved successfully; otherwise false

Reference

DocumentRepository Class

TryGetPhysicalFile Overload

Ignition.DocumentManagement Namespace