back to content

sign up free version control plan

ISAWHAppObject::GetProjectGeneralInfo

Description

Retrieves the general information of a project.

Syntax

long GetProjectGeneralInfo(
        BSTR ProjectName,
        VARIANT_BOOL* IsDeleted,
        long* SubProjectNotDeleted,
        long* SubProjectsDeleted,
        long* FileNotDeleted,
        long* FilesDeleted,
        long* RemoteVersionLow,
        long* RemoteVersionHigh,
        DATE* RemoteDateTime,
        BSTR* CreationComment,
        ISAWHDeletedItemGeneralInfoSet* DeletedItemGeneralInfoSet,
        VARIANT_BOOL* Cancelled,
        BSTR* ResultDescription
);

Parameters

ProjectName
[in] Specifies the full name of the project.

IsDeleted
[out] Returns whether the project is deleted.

SubProjectsNotDeleted
[out] Returns the number of undeleted subprojects within the project.

SubProjectsDeleted
[out] Returns the number of deleted subprojects in the project.

FilesNotDeleted
[out] Returns the number of undeleted files in the project.

FilesDeleted
[out] Returns the number of deleted files in the project.

RemoteVersionLow
[out] Returns the low-order 32 bits of the server project's latest version number.

RemoteVersionHigh
[out] Returns the high-order 32 bits of the server project's latest version number.

Note: RemoteVersionLow and RemoteVersionHigh form a single 64-bit version number.

RemoteDateTime
[out] Returns the date/time of the latest project version on the server.

CreationComment
[out] Returns the comment of the project.

DeletedItemGeneralInfoSet
[out] Returns the general information about the deleted items in the project.

Cancelled
[out] If the method fails, returns whether the operation is cancelled.

ResultDescription
[out] Returns the description of the return value. If the method succeeds, returns 'Completed'. If the method fails, returns the description of the error.

Return Value

If the method succeeds, returns 0. If the method fails, returns other error codes.

See Also

• ISAWHDeletedItemGeneralInfoSet Interface

Sample

VB Sample:

Dim WithEvents sdkObject As SAWHSDKLib.SAWHAppObject

Set sdkObject = New SAWHSDKLib.SAWHAppObject

Private Sub GetProjectGeneralInfo_Click()

	Dim Cancelled As Boolean
	Dim ResultDescription As String
	Dim ProjectName As String
	Dim IsDeleted As Boolean
	Dim SubProjectNotDeleted As Long
	Dim SubProjectsDeleted As Long
	Dim FileNotDeleted As Long
	Dim FilesDeleted As Long
	Dim RemoteVersionLow As Long
	Dim RemoteVersionHigh As Long
	Dim RemoteDateTime As Date
	Dim CreationComment As String
	Dim DeletedItemGeneralInfoSet As New SAWHDeletedItemGeneralInfoSet

	ProjectName = "$/ProjectName"

	Dim ResultValue As Long
	ResultValue = sdkObject.GetProjectGeneralInfo(ProjectName, IsDeleted, SubProjectNotDeleted, SubProjectsDeleted, FileNotDeleted, FilesDeleted, RemoteVersionLow, RemoteVersionHigh, RemoteDateTime, CreationComment, DeletedItemGeneralInfoSet, Cancelled, ResultDescription)

	If ResultValue <> 0 Then
		MsgBox ("Failed to get the project general info.")
	End If

	Dim Count As Long
	Count = DeletedItemGeneralInfoSet.GetCount
	Dim Index As Long
	For Index = 0 To Count - 1

		Dim DeletedItemGeneralInfo As New SAWHDeletedItemGeneralInfo
		DeletedItemGeneralInfoSet.Get Index, DeletedItemGeneralInfo

		Dim ItemName As String
		ItemName = DeletedItemGeneralInfo.ItemName

		Dim IsProject As Boolean
		IsProject = DeletedItemGeneralInfo.IsProject

		Dim ItemIdLow As Long
		ItemIdLow = DeletedItemGeneralInfo.ItemIdLow

		Dim ItemIdHigh As Long
		ItemIdHigh = DeletedItemGeneralInfo.ItemIdHigh

	Next

End Sub