Catalyst Fire Ignition Documentation
Document
Attempts to retrieve the physical file related to a DocumentMetadata
Definition
Namespace: Ignition.DocumentManagement
Assembly: CatalystFire.Ignition (in CatalystFire.Ignition.dll) Version: 12.0.3454
True if the file was retrieved successfully; otherwise false
Assembly: CatalystFire.Ignition (in CatalystFire.Ignition.dll) Version: 12.0.3454
C#
public bool TryGetPhysicalFile(
DocumentMetadata documentMetadata,
out PhysicalFile fileShim
)VB
Public Function TryGetPhysicalFile (
documentMetadata As DocumentMetadata,
<OutAttribute> ByRef fileShim As PhysicalFile
) As BooleanC++
public:
virtual bool TryGetPhysicalFile(
DocumentMetadata^ documentMetadata,
[OutAttribute] PhysicalFile^% fileShim
) sealedF#
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
BooleanTrue if the file was retrieved successfully; otherwise false