Catalyst Fire Ignition Documentation
Document
Attempts to retrieve a file by an entity that references a the file's 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(
IHasDocumentMetadata attachedDocumentMetadataObject,
out PhysicalFile fileShim
)VB
Public Function TryGetPhysicalFile (
attachedDocumentMetadataObject As IHasDocumentMetadata,
<OutAttribute> ByRef fileShim As PhysicalFile
) As BooleanC++
public:
virtual bool TryGetPhysicalFile(
IHasDocumentMetadata^ attachedDocumentMetadataObject,
[OutAttribute] PhysicalFile^% fileShim
) sealedF#
abstract TryGetPhysicalFile :
attachedDocumentMetadataObject : IHasDocumentMetadata *
fileShim : PhysicalFile byref -> bool
override TryGetPhysicalFile :
attachedDocumentMetadataObject : IHasDocumentMetadata *
fileShim : PhysicalFile byref -> bool Parameters
- attachedDocumentMetadataObject IHasDocumentMetadata
- The entity that references the document metadata whose 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