Project::GetAttachmentPath (Interface: Project)
 
Gets the full path of the attachment folder of a project detail.
 
BSTR GetAttachmentPath (
    SHORT sIndex,
    VARIANT_BOOL bCreate
)
 
Parameters
sIndex
[in] The index of the project detail.

Remarks
This number is a 0-based index, i.e. it starts from 0.
Each project detail has a sequence number that is shown in the dialog of your Venice installation. This number can be used to reference a project detail but does not have to be equal to the index that has to be used here. When deleting project details sequence numbers are not renumbered and therefore gaps can occur. The SDK internally uses indexes where no gaps are allowed. The method IndexFromSeqNum returns the index to be used for a given sequence number.
bCreate
[in] True if you want the attachment folder to be created if it does not exist, otherwise false.
 
Return value
A BSTR containing the full path of the attachment folder of the given project detail.
 
Remarks
If no project detail is found with the given parameter sIndex an exception is thrown. You can use GetDetail to check whether an index is valid, in which case it returns the sequence number of the detail otherwise -1.
 
See Also
CreateProject
Handling projects using the SDK
PrepareProject
CancelProject
 
Samples
 
C++
 
// Retrieve the attachment folder for the first project detail, creating it if it does not exist.
CString strPath = pProject->GetAttachmentPath (0, VARIANT_TRUE);

// Process strPath

C#
 
// Retrieve the attachment folder for the first project detail, creating it if it does not exist.
string sPath = oProject.GetAttachmentPath (0, true);

// Process sPath

VBS
 
' Retrieve the attachment folder for the first project detail, creating it if it does not exist.
Dim sPath

sPath = oProject.GetAttachmentPath (0, True)

' Process sPath

VB.NET
 
' Retrieve the attachment folder for the first project detail, creating it if it does not exist.
Dim sPath As String

sPath = oProject.GetAttachmentPath (0, True)

' Process sPath