Helix Plan SDK
The Helix Plan SDK can be used to integrate the Helix Plan Server with other systems. It gives access to most things in the server database and allows hooking into document management check ins to allow changes to metadata and file contents on all check ins. Please check out Release Notes for changes since the last version of the SDK.
Helix Plan SDK Overview
The current version of the SDK allows reading and writing to the server database. This is accomplished by loading a dll that exposes various functions for reading and manipulating the project database.
The Helix Plan SDK tries to be backwards compatible where possible. This accomplished by downloading an implementation of the SDK from the server when it's upgraded. This allows you to update your server without rebuilding the applications that uses the SDK. To use new functionality it is required to update to a new version of the SDK interface that exposes the new functionality.
The SDK is implemented by impersonating a client with special privileges. This allows for some sanity checks, but it is still possible to destroy the project database, so you should develop and test your application on a separate development server. For details see Developing with Helix Plan SDK.
Because the is SDK implemented purely by communicating with the server it is not currently possible to extend functionality in the Helix Plan Client application.
Developing with Helix Plan SDK
Development Environment Connecting to a Database
Development Environment
To use the SDK you need to include HPMSdk.h header file in the code that you want to use the SDK in. You should also add HPMSdk.c to your application or module. You should put the HPMSdk.dll in the same directory as your application or set the directory where the DLL is stored with the HPMInit._pLibraryPath parameter. When a session is connected the SDK will create the directory "VersionsSDK" in the directory of the process the SDK is running from or in the directory specified by the SessionOpen._pWorkingDirectory parameter. You should make sure the process has write permissions to this directory. In this directory the SDK will download the SDK Implementation dll that implements the SDK functions for a particular version of the Helix Plan Server. This setup allows you to upgrade the server without rebuilding the integration components that use the SDK unless you want new functionality. There are also a Java, a .NET and a C++ wrapper for the SDK. No separate documentation is available for these, but they are automatically generated from the C headers so the C documentation still applies, but with some mechanism being different. Check out the samples to see a basic Java, .NET and C++ implementation.
Connecting to a Database
To connect to a server with the SDK you need to create a special SDK user in the database. This user can only be created by the "Administrator" user. You need one user for every session you want to connect to the server. If you connect with the same user as another session that session will be dropped from the server.
To be able to create SDK users in the database you need to have a license that has SDK support enabled. For information on how to obtain such as license, contact Perforce Support.
When doing development you should use a test server. Don't develop with your live server as you might inadvertently destroy the database.
When you have a development server setup you can connect to the database with SessionOpen, but not before you have initialized the SDK with HPMInit.
If you develop a solution that requires more than one SDK session, e.g. a web integration, you should use SessionOpenVirtual to use the SDK's builtin session pool.
See Also
HPM SDK Basic Types
Basic types used in the SDK.
| Type | Description |
|---|---|
| HPMUInt8 | Unsigned 8 bit integer type. |
| HPMInt8 | Signed 8 bit integer type. |
| HPMUInt16 | Unsigned 16 bit integer type. |
| HPMInt16 | Signed 16 bit integer type. |
| HPMUInt32 | Unsigned 32 bit integer type. |
| HPMInt32 | Signed 32 bit integer type. |
| HPMUInt64 | Unsigned 64 bit integer type. |
| HPMInt64 | Signed 64 bit Integer type. |
| HPMFP32 | 32 bit floating point type. |
| HPMFP64 | 64 bit floating point type. |
| HPMUniqueID | Used to specify a unique database identifier. Resources, projects, tasks and other items are specified with this type. |
| HPMError | Used as a return type for values. Signed 32 bit integer type. |
| HPMAsciChar | This is the character type that some basic strings use. 8 bit wide. |
| HPMChar | This is the character type that most strings use. |
| HPMString | Pointer to a HPMChar string that is used to specify strings in the SDK. |
| HPMUserContext | A user context used for specifying context by the SDK user. |
Comments
These are the basic types that are used to communicate with the SDK.
ManagedComplexTypes
HPMBoolean
NodeTypeMap
"HPMChar*=HPMString"
NodeBasicTypes
HPMUInt8 HPMInt8 HPMUInt16 HPMInt16 HPMUInt32 HPMInt32 HPMUInt64 HPMInt64 HPMFP32 HPMFP64 HPMError
NodeNativeTypeMap
"HPMString=String,Utf8Value,string" "HPMInt32=Number,Int32Value,number" "HPMUInt32=Number,Uint32Value,number" "HPMInt64=BigInt,Int64Value,bigint" "HPMUInt64=BigInt,Uint64Value,bigint" "HPMUInt8=Uint8Array,Data,Uint8Array" "HPMInt8=Int8Array,Data,Int8Array" "HPMUInt16=Number,Uint32Value,number" "HPMInt16=Number,Int32Value,number" "HPMFP32=Number,FloatValue,number" "HPMFP64=Number,DoubleValue,number"
JavaNativeTypeMap
"HPMString=String,jstring,L" "HPMInt32=int,jint,I" "HPMUInt32=int,jint,I" "HPMInt64=long,jlong,J" "HPMUInt64=long,jlong,J" "HPMUInt8=byte,jbyte,B" "HPMInt8=byte,jbyte,B" "HPMUInt16=short,jshort,S" "HPMInt16=short,jshort,S" "HPMFP32=float,jfloat,F" "HPMFP64=double,jdouble,D"
EHPMSDK
Misc SDK enums.
enum EHPMSDK {
EHPMSDK_Version = 33702402,
};
Values
EHPMSDK_Version
The version of the SDK.
EHPMError
One of these values will always be returned when calling a function in the SDK.
enum EHPMError {
EHPMError_NoError = 0,
EHPMError_DllNotFound = 1,
EHPMError_DllInvalid = 2,
EHPMError_NewVersionOfSDKRequired = 3,
EHPMError_CouldNotConnectToHost = 4,
EHPMError_GeneralLoginError = 5,
EHPMError_FailedToConnectToDatabase = 6,
EHPMError_DatabaseDoesNotExist = 7,
EHPMError_DatabaseNotOnline = 8,
EHPMError_PasswordOrResourceInvalid = 9,
EHPMError_LicenseInvalid = 10,
EHPMError_SyncError = 11,
EHPMError_OtherError = 12,
EHPMError_ConnectionLost = 13,
EHPMError_InvalidID = 14,
EHPMError_PasswordRequired = 15,
EHPMError_CallbackAlreadyExists = 16,
EHPMError_CallbackDoesNotExist = 17,
EHPMError_BlockTimeout = 18,
EHPMError_ResourceNotMemberOfProject = 19,
EHPMError_DataNotYetAvailable = 20,
EHPMError_ConversionNotSupported = 21,
EHPMError_IndexOutOfRange = 22,
EHPMError_FunctionalityNotInitialized = 23,
EHPMError_AlreadyInitialized = 24,
EHPMError_OperationAlreadyInProgress = 25,
EHPMError_AccessDenied = 26,
EHPMError_FileDoesNotExist = 27,
EHPMError_LicenseViolation = 28,
EHPMError_ParseError = 29,
EHPMError_InvalidCustomSettingsType = 30,
EHPMError_NotAvailableInClientSDK = 31,
EHPMError_OnlyAvailableInClientSDK = 32,
EHPMError_Deprecated = 33,
EHPMError_OnlyAvailableInQAProject = 34,
EHPMError_InvalidSessionKeySize = 35,
EHPMError_InvalidIdentifier = 36,
EHPMError_SessionPoolNotInitialized = 37,
EHPMError_SessionPoolSessionNotAvailable = 38,
EHPMError_SessionPoolNotAllowed = 39,
EHPMError_SessionPoolNotAvailableInClientSDK = 40,
EHPMError_LoginDisabled = 41,
EHPMError_Partitioned = 42,
EHPMError_WorkingDirectoryNotAvailableInClientSDK = 43,
EHPMError_NewVersionOfServerRequired = 44,
EHPMError_IDNoLongerExists = 45,
EHPMError_NotValidOnTaskWithProxy = 46,
EHPMError_FullIdentifierNotAvailaibleInTranslation = 47,
EHPMError_IdentifierNotAvailaibleInTranslation = 48,
EHPMError_SDKNotAllowedToSetAuthOrCredential = 49,
EHPMError_ImageFormatNotSupported = 50,
EHPMError_CropAreaOutOfBounds = 51,
EHPMError_NoVersionControlHistory = 52,
EHPMError_TimeZoneOrder = 53,
EHPMError_ServerTimedOut = 54,
EHPMError_CouldNotLoadImpDll = 55,
EHPMError_SecureConnectionRefused = 56,
EHPMError_SecureConnectionNotTrusted = 57,
EHPMError_Certificate = 58,
EHPMError_ServerDoesNotSupportSecureConnection = 59,
EHPMError_CertificateSettingsNotApplicableInClientSDK = 60,
EHPMError_DateTimeOutOfRange = 61,
EHPMError_CouldNotCreateSDKInterface = 62,
EHPMError_ServerVersionMismatch = 63,
EHPMError_ServerDoesNotSupportPlatform = 64,
EHPMError_ServerTimeMismatch = 65,
EHPMError_InvalidDashboardPageLayout = 66,
EHPMError_InvalidDashboardConfiguration = 67,
EHPMError_UserNotMemberOfProject = 68,
EHPMError_DefaultQAWorkflowCannotBeDeleted = 69,
EHPMError_DefaultQAWorkflowMustBeVisibleInQA = 70,
EHPMError_NotAvailableInQAProject = 71,
EHPMError_BoardTemplateInvalid = 72,
EHPMError_ReadLockNotAvailableOnVirtualSession = 73,
EHPMError_ReadLockSet = 74,
EHPMError_InvalidHelixPlanURL = 75,
EHPMError_NoHelixPlanTaskFoundInURL = 76,
EHPMError_GUIDInURLNotValidForThisDatabase = 77,
EHPMError_InvalidImpersonateID = 78,
EHPMError_InvalidMilestones = 79,
EHPMError_EmptyString = 80,
EHPMError_ResourceIsProjectMemberDueToGroup = 81,
EHPMError_ResourceAlreadyMemberOfProject = 82,
EHPMError_TaskAllocationPerecentOutOfBounds = 83,
EHPMError_ConnectionAlreadyExists = 84,
EHPMError_ImpersonationNotAvailableOnImpersonatedVirtualSession = 85,
EHPMError_PasswordRulesViolation = 86,
};
Values
EHPMError_NoError
Indicates that the function was successful.
EHPMError_DllNotFound
The SDK dll could not be found in the current path.
EHPMError_DllInvalid
The SDK dll did not contain the expected functions. This could be due to an old dll being used with a new SDK header file.
EHPMError_NewVersionOfSDKRequired
This operation cannot be performed with this version of the SDK, you need to recompile your program with the newest version of the SDK.
EHPMError_CouldNotConnectToHost
The connection to the server was unsuccessful.
EHPMError_GeneralLoginError
Unspecified login error.
EHPMError_FailedToConnectToDatabase
Internal error occurred when trying to login to the database on the server.
EHPMError_DatabaseDoesNotExist
The database specified does not exist on the server.
EHPMError_DatabaseNotOnline
The database specified is not online and cannot be connected to.
EHPMError_PasswordOrResourceInvalid
The resource was not found or the password was incorrect when logging in.
EHPMError_LicenseInvalid
The license has expired, too many resources have been created on the server or the SDK module is not enabled in the license.
EHPMError_SyncError
An error occurred when the client was downloading the database.
EHPMError_OtherError
Unspecified error.
EHPMError_ConnectionLost
The connection to the server has been lost, it's up to the user of the SDK to try to connect again.
EHPMError_InvalidID
The unique identifier specified to the function is not valid.
EHPMError_PasswordRequired
A password must be specified at least one character long.
EHPMError_CallbackAlreadyExists
The callback with the same function pointer and context has already been registered.
EHPMError_CallbackDoesNotExist
The specified callback does not exist.
EHPMError_BlockTimeout
A blocking operation timed out. This usually happens if the connection to the server was lost, it could also happen if an operation takes longer that 120 seconds to process on the server. When this happens you should not assume that the function finished or did not finish.
EHPMError_ResourceNotMemberOfProject
The resource specified was not a member of the project where the operation was performed. This usually happens when you try to set a resource to some task property and the resource isn't a member of that project.
EHPMError_DataNotYetAvailable
The data requested was not yet available. You should wait for a callback signifying that the data is available or poll the function until the requested data is returned.
EHPMError_ConversionNotSupported
The data cannot be retrieved in the requested format because the conversion isn't supported.
EHPMError_IndexOutOfRange
The index supplied to the function was out of range.
EHPMError_FunctionalityNotInitialized
The function called needs to have its functionality initialized before this function can be called.
EHPMError_AlreadyInitialized
The functionality has already been initialized.
EHPMError_OperationAlreadyInProgress
An operation is already in progress and you must wait until it is finished before calling this function.
EHPMError_AccessDenied
Access was denied by the server.
EHPMError_FileDoesNotExist
The file does not exist.
EHPMError_LicenseViolation
The command would have caused a license violation and was aborted.
EHPMError_ParseError
Failed to parse the string that was sent into the function. Additional information might be available through UtilGetLastErrorDescription.
EHPMError_InvalidCustomSettingsType
The custom settings type specified was not valid for this function.
EHPMError_NotAvailableInClientSDK
The called functions is not available in the client SDK.
EHPMError_OnlyAvailableInClientSDK
The called functions is only available in the client SDK.
EHPMError_Deprecated
The function called has been deprecated in this version of the SDK. Check SDK release notes for more information.
EHPMError_OnlyAvailableInQAProject
The called function is only available for items residing in a QA project.
EHPMError_InvalidSessionKeySize
The session key provided is too large or too small.
EHPMError_InvalidIdentifier
The authentication method identifier provided is invalid (empty or too long).
EHPMError_SessionPoolNotInitialized
The session pool could not be initialized.
EHPMError_SessionPoolSessionNotAvailable
No available sessions in the session pool.
EHPMError_SessionPoolNotAllowed
This operation is not allowed on a virtual session.
EHPMError_SessionPoolNotAvailableInClientSDK
The session pool is not available in the client SDK.
EHPMError_LoginDisabled
The login for the resource has been disabled.
EHPMError_Partitioned
Unable to complete authentication due to network problems
EHPMError_WorkingDirectoryNotAvailableInClientSDK
The working directory is not available in the client SDK.
EHPMError_NewVersionOfServerRequired
The application was developed with a version of the SDK, that requires that the server is updated to a newer version.
EHPMError_IDNoLongerExists
The identifier specified in the command never existed or has been deleted since the command was sent to server.
EHPMError_NotValidOnTaskWithProxy
The operation cannot be performed on a task that has a proxy.
EHPMError_FullIdentifierNotAvailaibleInTranslation
The full translation identifier is not available in the translation.
EHPMError_IdentifierNotAvailaibleInTranslation
The translation identifier is not available in the translation.
EHPMError_SDKNotAllowedToSetAuthOrCredential
The SDK is not allowed to set authentication provider or credential check provider
EHPMError_ImageFormatNotSupported
Image format not supported by SDK.
EHPMError_CropAreaOutOfBounds
The specified crop area is larger than the original image.
EHPMError_NoVersionControlHistory
No version control history exist.
EHPMError_TimeZoneOrder
Not possible to set timezone start before or equal to previous timezone end or to set timezone end before timezone start.
EHPMError_ServerTimedOut
Connection to server timed out.
EHPMError_CouldNotLoadImpDll
Could not load downloaded SDK implementation dll.
EHPMError_SecureConnectionRefused
Secure connection refused.
EHPMError_SecureConnectionNotTrusted
Secure connection not trusted.
EHPMError_Certificate
Certificate error. A more detailed description can be found with UtilGetLastErrorDescription.
EHPMError_ServerDoesNotSupportSecureConnection
Server does not support SSL.
EHPMError_CertificateSettingsNotApplicableInClientSDK
The certificate settings are not applicable in the client SDK.
EHPMError_DateTimeOutOfRange
The provided date time parameter is out of range.
EHPMError_CouldNotCreateSDKInterface
Could not create the SDK interface from the downloaded SDK implementation dll.
EHPMError_ServerVersionMismatch
A version mismatch was found in the SDK implementation dll.
EHPMError_ServerDoesNotSupportPlatform
The server does not support your SDK platform or architecture.
EHPMError_ServerTimeMismatch
The server time differs a lot from time the time on this computer. Connection is not allowed.
EHPMError_InvalidDashboardPageLayout
The dashboard page layout was invalid. Ensure the number of columns matches the layout type.
EHPMError_InvalidDashboardConfiguration
The dashboard configuration was invalid. Additional information might be available through UtilGetLastErrorDescription.
EHPMError_UserNotMemberOfProject
The SDK user running the command is not member of the project that the command requested. See also HPMResourceProperties::m_SDKSyncMethod.
EHPMError_DefaultQAWorkflowCannotBeDeleted
The default QA workflow cannot be deleted.
EHPMError_DefaultQAWorkflowMustBeVisibleInQA
The default QA workflow must be visible in the QA section.
EHPMError_NotAvailableInQAProject
The called function is not available for QA projects.
EHPMError_BoardTemplateInvalid
The template is invalid or does not exist.
EHPMError_ReadLockNotAvailableOnVirtualSession
Read lock not available on virtual sessions.
EHPMError_ReadLockSet
A read lock is already set.
EHPMError_InvalidHelixPlanURL
The URL provided is not a valid Helix Plan URL.
EHPMError_NoHelixPlanTaskFoundInURL
No Helix Plan task was found in the URL.
EHPMError_GUIDInURLNotValidForThisDatabase
The database GUID found the Helix Plan URL is not valid for this database.
EHPMError_InvalidImpersonateID
The ID set with ResourceImpersonate is no longer valid.
EHPMError_InvalidMilestones
The milestones are invalid.
EHPMError_EmptyString
Empty string is not allowed.
EHPMError_ResourceIsProjectMemberDueToGroup
The resource specified is a project member due to its group membership.
EHPMError_ResourceAlreadyMemberOfProject
The resource specified is already a member of the project.
EHPMError_TaskAllocationPerecentOutOfBounds
The task resource allocation percent was set out of bounds.
EHPMError_ConnectionAlreadyExists
The connection between the two tasks already exists.
EHPMError_ImpersonationNotAvailableOnImpersonatedVirtualSession
Impersonation not available on virtual session with fixed impersonation.
EHPMError_PasswordRulesViolation
The password did not follow the security policy rules. SesHPMSecurityPolicySettings
EHPMDateFormat
Date formats. Currently only used for HPMResourceGlobalSettings::m_DateFormat
enum EHPMDateFormat {
EHPMDateFormat_NewVersionOfSDKRequired = 0,
EHPMDateFormat_YYYY_MM_DD_ISO8601 = 1,
EHPMDateFormat_MM_DD_YYYY = 2,
EHPMDateFormat_DD_MM_YYYY = 3,
EHPMDateFormat_YYYY_MMM_DD = 4,
EHPMDateFormat_MMM_DD_YYYY = 5,
EHPMDateFormat_DD_MMM_YYYY = 6,
EHPMDateFormat_WEEKDAY_YY_MM_DD = 7,
EHPMDateFormat_WEEKDAY_MM_DD_YY = 8,
EHPMDateFormat_WEEKDAY_DD_MM_YY = 9,
EHPMDateFormat_FromLanguage = 10,
};
Values
EHPMDateFormat_NewVersionOfSDKRequired
The date format did not exist when this SDK was created. Upgrade to a newer version of the SDK to be able to use this format.
EHPMDateFormat_YYYY_MM_DD_ISO8601
ISO 8601 format
EHPMDateFormat_MM_DD_YYYY
MM-DD-YYYY format
EHPMDateFormat_DD_MM_YYYY
DD-MM-YYYY format
EHPMDateFormat_YYYY_MMM_DD
YYYY-MMM-DD format
EHPMDateFormat_MMM_DD_YYYY
MMM-DD-YYYY format
EHPMDateFormat_DD_MMM_YYYY
DD-MMM-YYYY format
EHPMDateFormat_WEEKDAY_YY_MM_DD
Weekday-YY-MM-YY format
EHPMDateFormat_WEEKDAY_MM_DD_YY
Weekday-MM-DD-YY format
EHPMDateFormat_WEEKDAY_DD_MM_YY
Weekday-DD-MM-YY format
EHPMDateFormat_FromLanguage
The date format is taken from the current set language
See Also
HPMResourceGlobalSettings, EHPMResourceGlobalSettingsFlag
EHPMPeriodicityType
Periodicity type. This enum specifies different types of periodicity. Used by HPMProjectHistoryAutoSaveSettings and HPMProjectEmailSettings.
enum EHPMPeriodicityType {
EHPMPeriodicityType_NewVersionOfSDKRequired = 0,
EHPMPeriodicityType_Never = 1,
EHPMPeriodicityType_Daily = 2,
EHPMPeriodicityType_Weekly = 3,
};
Values
EHPMPeriodicityType_NewVersionOfSDKRequired
The periodicity type did not exist when this SDK was created. Upgrade to a newer version of the SDK to be able to use this type.
EHPMPeriodicityType_Never
Disabled.
EHPMPeriodicityType_Daily
Daily periodicity.
EHPMPeriodicityType_Weekly
Weekly periodicity.
See Also
HPMProjectHistoryAutoSaveSettings, HPMProjectEmailSettings
EHPMWallGroupingType
Wall grouping mode. Used by HPMTaskWallPosition.
enum EHPMWallGroupingType {
EHPMWallGroupingType_NewVersionOfSDKRequired = 0,
EHPMWallGroupingType_DefaultColumn = 1,
EHPMWallGroupingType_CustomColumn = 2,
EHPMWallGroupingType_CustomGroups = 3,
};
Values
EHPMWallGroupingType_NewVersionOfSDKRequired
The grouping type did not exist when this SDK was created. Upgrade to a newer version of the SDK to be able to use this grouping type.
EHPMWallGroupingType_DefaultColumn
The specified grouping is one of the EHPMProjectDefaultColumn enum.
EHPMWallGroupingType_CustomColumn
The specified grouping is the hash of a custom column.
EHPMWallGroupingType_CustomGroups
The specified grouping is a custom grouping.
See Also
EHPMResourceGroupingType
Resource grouping type type used for HPMResourceDefinition::m_Type, HPMResourceReference::m_ResourceType
enum EHPMResourceGroupingType {
EHPMResourceGroupingType_NewVersionOfSDKRequired = 0,
EHPMResourceGroupingType_Resource = 1,
EHPMResourceGroupingType_ResourceGroup = 2,
EHPMResourceGroupingType_AllProjectMembers = 3,
};
Values
EHPMResourceGroupingType_NewVersionOfSDKRequired
The resource grouping type did not exist when this SDK was created. Upgrade to a newer version of the SDK to be able to use this grouping type.
EHPMResourceGroupingType_Resource
The resource grouping is a resource.
EHPMResourceGroupingType_ResourceGroup
The resource grouping is a resource group.
EHPMResourceGroupingType_AllProjectMembers
The resource grouping is all members of the project.
See Also
HPMResourceDefinition, HPMProjectDetailedAccessRule, HPMProjectWorkflowObject
EHPMCustomSettingsType
Custom settings type used for GlobalGetCustomSettingsValue, ProjectGetCustomSettingsValue, ResourceGetCustomSettingsValue, ProjectResourceGetCustomSettingsValue, GlobalSetCustomSettingsValue, ProjectSetCustomSettingsValue, ResourceSetCustomSettingsValue and ProjectResourceSetCustomSettingsValue
enum EHPMCustomSettingsType {
EHPMCustomSettingsType_NewVersionOfSDKRequired = 0,
EHPMCustomSettingsType_Admin = 1,
EHPMCustomSettingsType_Normal = 2,
EHPMCustomSettingsType_Custom = 3,
};
Values
EHPMCustomSettingsType_NewVersionOfSDKRequired
The setting type did not exist when this SDK was created. Upgrade to a newer version of the SDK to be able to use this settings type.
EHPMCustomSettingsType_Admin
The setting refers to the administrative settings.
EHPMCustomSettingsType_Normal
The setting refers to the normal settings. For a resource this is personal options. For a project this is the settings that main project managers can set from the project view.
EHPMCustomSettingsType_Custom
The setting refers to a custom dialog initiated directly from a client dll.
See Also
GlobalGetCustomSettingsValue, ProjectGetCustomSettingsValue, ResourceGetCustomSettingsValue, ProjectResourceGetCustomSettingsValue, GlobalSetCustomSettingsValue, ProjectSetCustomSettingsValue, ResourceSetCustomSettingsValue, ProjectResourceSetCustomSettingsValue
EHPMReportViewType
Report view type used for HPMReport::m_ViewType
enum EHPMReportViewType {
EHPMReportViewType_NewVersionOfSDKRequired = 0,
EHPMReportViewType_BugsReportedByMe = 1,
EHPMReportViewType_AllBugsInProject = 2,
EHPMReportViewType_MyWork = 3,
EHPMReportViewType_ScheduleMainProject = 4,
EHPMReportViewType_GlobalResourceAllocation = 5,
EHPMReportViewType_GlobalFind = 6,
EHPMReportViewType_ProjectHistory = 7,
EHPMReportViewType_AgileMainProject = 8,
EHPMReportViewType_AgileBacklog = 9,
};
Values
EHPMReportViewType_NewVersionOfSDKRequired
The view type did not exist when this SDK was created. Upgrade to a newer version of the SDK to be able to use this view type.
EHPMReportViewType_BugsReportedByMe
View bugs reported by me.
EHPMReportViewType_AllBugsInProject
View all bugs in project.
EHPMReportViewType_MyWork
View my work.
EHPMReportViewType_ScheduleMainProject
View project as task scheduling.
EHPMReportViewType_GlobalResourceAllocation
View resource allocation.
EHPMReportViewType_GlobalFind
View global find in all projects.
EHPMReportViewType_ProjectHistory
View project history.
EHPMReportViewType_AgileMainProject
View project as agile.
EHPMReportViewType_AgileBacklog
View agile backlog.
See Also
EHPMReportFlag
Report flags used for HPMReport::m_Flags
enum EHPMReportFlag {
EHPMReportFlag_None = 0,
EHPMReportFlag_ContinueToFindWhileInReportMode = 8,
};
Values
EHPMReportFlag_None
TBD
EHPMReportFlag_ContinueToFindWhileInReportMode
When the report is active users can continue to use Find.
See Also
EHPMColumnType
Column type used for HPMColumn::m_ColumnType
enum EHPMColumnType {
EHPMColumnType_NewVersionOfSDKRequired = 0,
EHPMColumnType_DefaultColumn = 1,
EHPMColumnType_CustomColumn = 2,
};
Values
EHPMColumnType_NewVersionOfSDKRequired
The column type did not exist when this SDK was created. Upgrade to a newer version of the SDK to be able to use this column type.
EHPMColumnType_DefaultColumn
The specified column is one of the EHPMProjectDefaultColumn enum.
EHPMColumnType_CustomColumn
The specified column is the hash of a custom column.
See Also
EHPMProjectDefaultColumn, HPMColumn
EHPMFindSelectionType
Selection type used for HPMFindCondition::m_Type
enum EHPMFindSelectionType {
EHPMFindSelectionType_NewVersionOfSDKRequired = 0,
EHPMFindSelectionType_Column = 1,
EHPMFindSelectionType_Fixed = 2,
};
Values
EHPMFindSelectionType_NewVersionOfSDKRequired
The selection type did not exist when this SDK was created. Upgrade to a newer version of the SDK to be able to use this selection type.
EHPMFindSelectionType_Column
The specified column is the hash of a custom column.
EHPMFindSelectionType_Fixed
The specified column us one of EHPMFilterType enum.
See Also
EHPMFilterType
Filter type used for HPMFindCondition::m_SelectionID
enum EHPMFilterType {
EHPMFilterType_NewVersionOfSDKRequired = 0,
EHPMFilterType_None = 1,
EHPMFilterType_Incompleted = 2,
EHPMFilterType_Completed = 3,
EHPMFilterType_InProgress = 4,
EHPMFilterType_Overdue = 5,
EHPMFilterType_NotStartedYet = 6,
EHPMFilterType_ResourcesOverallocation = 7,
EHPMFilterType_ResourcesUnderallocation = 8,
EHPMFilterType_ResourcesGaps = 9,
EHPMFilterType_ResourcesWorkingNow = 10,
EHPMFilterType_ResourcesFreeNow = 11,
EHPMFilterType_OutOfOffice = 12,
EHPMFilterType_NotAssigned = 13,
EHPMFilterType_MilestoneOverdue = 14,
EHPMFilterType_AreMilestone = 15,
EHPMFilterType_AreMilestonePast = 16,
EHPMFilterType_AreMilestoneFuture = 17,
EHPMFilterType_AreSprints = 18,
EHPMFilterType_AreBacklogItems = 19,
EHPMFilterType_HaveAgileStatusNotDone = 20,
EHPMFilterType_HaveAgileStatusInProgress = 21,
EHPMFilterType_HaveAgileStatusCompleted = 22,
EHPMFilterType_HaveAgileStatusBlocked = 23,
EHPMFilterType_HaveAgileStatusDeleted = 24,
EHPMFilterType_VacationTasks = 25,
EHPMFilterType_UserStories = 26,
EHPMFilterType_AssignedToMe = 27,
EHPMFilterType_CanStartNow = 28,
EHPMFilterType_IsOngoingWork = 29,
EHPMFilterType_IsArchived = 30,
EHPMFilterType_IsDeleted = 31,
EHPMFilterType_IsLeaf = 32,
EHPMFilterType_AreBoards = 33,
EHPMFilterType_InCurrentSprint = 34,
};
Values
EHPMFilterType_NewVersionOfSDKRequired
The filter type did not exist when this SDK was created. Upgrade to a newer version of the SDK to be able to use this filter type.
EHPMFilterType_None
No filter.
EHPMFilterType_Incompleted
Scheduled tasks with status 'Incomplete'
EHPMFilterType_Completed
Scheduled tasks with status 'Completed'.
EHPMFilterType_InProgress
Scheduled tasks with status 'In progress'.
EHPMFilterType_Overdue
Scheduled tasks with status 'Overdue'.
EHPMFilterType_NotStartedYet
Scheduled tasks with status 'Not started yet'.
EHPMFilterType_ResourcesOverallocation
Resource allocation zones that are over allocated.
EHPMFilterType_ResourcesUnderallocation
Resource allocation zones that are under allocated.
EHPMFilterType_ResourcesGaps
Resource allocation zones that have planning gaps.
EHPMFilterType_ResourcesWorkingNow
Resource allocation zones that are allocated now.
EHPMFilterType_ResourcesFreeNow
Resource allocation zones that are not allocated now.
EHPMFilterType_OutOfOffice
Resource allocation zones that are out of office.
EHPMFilterType_NotAssigned
Tasks/items that are not assigned.
EHPMFilterType_MilestoneOverdue
Tasks/items that are milestone overdue.
EHPMFilterType_AreMilestone
All milestones.
EHPMFilterType_AreMilestonePast
Past milestones.
EHPMFilterType_AreMilestoneFuture
Future milestones.
EHPMFilterType_AreSprints
All sprints.
EHPMFilterType_AreBacklogItems
All backlog items.
EHPMFilterType_HaveAgileStatusNotDone
Agile items with status 'Not done'.
EHPMFilterType_HaveAgileStatusInProgress
Agile items with status 'In progress'.
EHPMFilterType_HaveAgileStatusCompleted
Agile items with status 'Completed'.
EHPMFilterType_HaveAgileStatusBlocked
Agile items with status 'Blocked'.
EHPMFilterType_HaveAgileStatusDeleted
Agile items with status 'Deleted'.
EHPMFilterType_VacationTasks
Vacation tasks.
EHPMFilterType_UserStories
Items with status user stories.
EHPMFilterType_AssignedToMe
Bugs assigned to me.
EHPMFilterType_CanStartNow
Tasks that can start now.
EHPMFilterType_IsOngoingWork
Tasks that are ongoing.
EHPMFilterType_IsArchived
Tasks that are archived.
EHPMFilterType_IsDeleted
Tasks that are deleted.
EHPMFilterType_IsLeaf
Tasks that don't have children
EHPMFilterType_AreBoards
All boards.
EHPMFilterType_InCurrentSprint
Tasks that are in current sprint.
See Also
EHPMListIcon
Icons used in lists.
enum EHPMListIcon {
EHPMListIcon_NewVersionOfSDKRequired = 0,
EHPMListIcon_Default = 1,
EHPMListIcon_WhiteBox = 2,
EHPMListIcon_GreenBox = 3,
EHPMListIcon_YellowBox = 4,
EHPMListIcon_RedBox = 5,
EHPMListIcon_BlueBox = 6,
EHPMListIcon_MagentaBox = 7,
EHPMListIcon_OrangeBox = 8,
EHPMListIcon_Check = 9,
EHPMListIcon_RedDot = 10,
EHPMListIcon_BlueFace = 11,
EHPMListIcon_GreyFace = 12,
EHPMListIcon_OrangeFace = 13,
EHPMListIcon_GoldFace = 14,
EHPMListIcon_Locked = 15,
EHPMListIcon_Unlocked = 16,
EHPMListIcon_ReOpenBug = 17,
EHPMListIcon_NewBug = 18,
EHPMListIcon_AssignedBug = 19,
EHPMListIcon_FixedBug = 20,
EHPMListIcon_VerifiedBug = 21,
EHPMListIcon_ClosedBug = 22,
EHPMListIcon_Group = 23,
EHPMListIcon_GreyGroup = 24,
EHPMListIcon_LightGreyGroup = 25,
EHPMListIcon_GreenCircle = 26,
EHPMListIcon_YellowCircle = 27,
EHPMListIcon_RedCircle = 28,
EHPMListIcon_BlueCircle = 29,
EHPMListIcon_MagentaCircle = 30,
EHPMListIcon_OrangeCircle = 31,
EHPMListIcon_YesBox = 32,
EHPMListIcon_NoBox = 33,
EHPMListIcon_QuestionBox = 34,
EHPMListIcon_Project = 35,
EHPMListIcon_DeletedResource = 36,
EHPMListIcon_Workflow = 37,
EHPMListIcon_Progress = 38,
EHPMListIcon_Step = 39,
EHPMListIcon_Pipeline = 40,
EHPMListIcon_Report = 41,
EHPMListIcon_VeryHighPriorityBox = 42,
EHPMListIcon_HighPriorityBox = 43,
EHPMListIcon_MediumPriorityBox = 44,
EHPMListIcon_LowPriorityBox = 45,
EHPMListIcon_VeryLowPriorityBox = 46,
EHPMListIcon_DisabledBox = 47,
EHPMListIcon_Plus = 48,
EHPMListIcon_NoIcon = 49,
EHPMListIcon_WarningTriangleRed = 50,
EHPMListIcon_WarningTriangleYellow = 51,
EHPMListIcon_ExclamationMark = 52,
EHPMListIcon_Information = 53,
EHPMListIcon_Pause = 54,
EHPMListIcon_Stop = 55,
};
Values
EHPMListIcon_NewVersionOfSDKRequired
The bug status icon did not exist when this SDK was created. Upgrade to a newer version of the SDK to be able to use this status icon.
EHPMListIcon_Default
Default icon. Currently resolves to EHPMListIcon_RedDot.
EHPMListIcon_WhiteBox
White box icon.
EHPMListIcon_GreenBox
Green box icon.
EHPMListIcon_YellowBox
Yellow box icon.
EHPMListIcon_RedBox
Red box icon.
EHPMListIcon_BlueBox
Blue box icon.
EHPMListIcon_MagentaBox
Magenta box icon.
EHPMListIcon_OrangeBox
Orange box icon.
EHPMListIcon_Check
Check mark icon.
EHPMListIcon_RedDot
Red dot icon.
EHPMListIcon_BlueFace
Blue face icon.
EHPMListIcon_GreyFace
Grey face icon.
EHPMListIcon_OrangeFace
Orange face icon.
EHPMListIcon_GoldFace
Gold face icon.
EHPMListIcon_Locked
Locked icon.
EHPMListIcon_Unlocked
Unlocked icon.
EHPMListIcon_ReOpenBug
Re-open bug icon.
EHPMListIcon_NewBug
New bug icon.
EHPMListIcon_AssignedBug
Assigned bug icon.
EHPMListIcon_FixedBug
Fixed bug icon.
EHPMListIcon_VerifiedBug
Verified bug icon.
EHPMListIcon_ClosedBug
Closed bug icon.
EHPMListIcon_Group
Group icon.
EHPMListIcon_GreyGroup
Grey group icon.
EHPMListIcon_LightGreyGroup
Light grey icon.
EHPMListIcon_GreenCircle
Green circle icon.
EHPMListIcon_YellowCircle
Yellow circle icon.
EHPMListIcon_RedCircle
Red circle icon.
EHPMListIcon_BlueCircle
Blue circle icon.
EHPMListIcon_MagentaCircle
Magenta circle icon.
EHPMListIcon_OrangeCircle
Orange circle icon.
EHPMListIcon_YesBox
Yes box icon.
EHPMListIcon_NoBox
No box icon.
EHPMListIcon_QuestionBox
Question box icon.
EHPMListIcon_Project
Project icon.
EHPMListIcon_DeletedResource
Deleted resource icon.
EHPMListIcon_Workflow
Workflow icon.
EHPMListIcon_Progress
Progress icon.
EHPMListIcon_Step
Step icon.
EHPMListIcon_Pipeline
Pipeline icon.
EHPMListIcon_Report
Report icon.
EHPMListIcon_VeryHighPriorityBox
Very high priority box icon.
EHPMListIcon_HighPriorityBox
High priority box icon.
EHPMListIcon_MediumPriorityBox
Medium priority box icon.
EHPMListIcon_LowPriorityBox
Low priority box icon.
EHPMListIcon_VeryLowPriorityBox
Very low priority icon.
EHPMListIcon_DisabledBox
Disabled box icon.
EHPMListIcon_Plus
Plus icon.
EHPMListIcon_NoIcon
No icon.
EHPMListIcon_WarningTriangleRed
Red warning triangle icon.
EHPMListIcon_WarningTriangleYellow
Yellow warning triangle icon.
EHPMListIcon_ExclamationMark
Exclamation mark icon.
EHPMListIcon_Information
Information icon.
EHPMListIcon_Pause
Pause icon.
EHPMListIcon_Stop
Stop icon.
See Also
HPMReport, HPMProjectWorkflowObject, HPMProjectWorkflowProperties, HPMProjectCustomColumnsColumnDropListItem
EHPMReportSortGroupOrderType
Sort group order used for HPMReportSortGroupProperties::m_OrderType
enum EHPMReportSortGroupOrderType {
EHPMReportSortGroupOrderType_NewVersionOfSDKRequired = 0,
EHPMReportSortGroupOrderType_None = 1,
EHPMReportSortGroupOrderType_Primary = 2,
EHPMReportSortGroupOrderType_Secondary = 3,
};
Values
EHPMReportSortGroupOrderType_NewVersionOfSDKRequired
The sort/group order type did not exist when this SDK was created. Upgrade to a newer version of the SDK to be able to use this type.
EHPMReportSortGroupOrderType_None
Use if HPMReportSortGroupProperties has no sort group/criteria.
EHPMReportSortGroupOrderType_Primary
Use if HPMReportSortGroupProperties is the primary sort/group criteria.
EHPMReportSortGroupOrderType_Secondary
Use if HPMReportSortGroupProperties is the secondary sort/group criteria.
See Also
EHPMTimesheetField
The timesheet field type.
enum EHPMTimesheetField {
EHPMTimesheetField_NewVersionOfSDKRequired = 0,
EHPMTimesheetField_DayID = 1,
EHPMTimesheetField_HighestRowID = 2,
EHPMTimesheetField_ActivityTypeID = 3,
EHPMTimesheetField_ProjectID = 4,
EHPMTimesheetField_TaskID = 5,
EHPMTimesheetField_StartedTime = 6,
EHPMTimesheetField_FinishedTime = 7,
EHPMTimesheetField_DurationTime = 8,
EHPMTimesheetField_Comment = 9,
EHPMTimesheetField_Deleted = 10,
};
Values
EHPMTimesheetField_NewVersionOfSDKRequired
The field did not exist when this SDK was created. Upgrade to a newer version of the SDK to be able to use this type.
EHPMTimesheetField_DayID
Day id field.
EHPMTimesheetField_HighestRowID
Highest row id field.
EHPMTimesheetField_ActivityTypeID
Activity type id field.
EHPMTimesheetField_ProjectID
Project id field.
EHPMTimesheetField_TaskID
Task id field.
EHPMTimesheetField_StartedTime
Started time field.
EHPMTimesheetField_FinishedTime
Finished time field.
EHPMTimesheetField_DurationTime
Duration time field.
EHPMTimesheetField_Comment
Comment field.
EHPMTimesheetField_Deleted
Is deleted field.
See Also
HPMChangeCallbackData_TimesheetRowChange
EHPMOptionalBoolean
Used to specify optional parameters.
enum EHPMOptionalBoolean {
EHPMOptionalBoolean_NotSet = 0,
EHPMOptionalBoolean_On = 1,
EHPMOptionalBoolean_Off = 2,
};
Values
EHPMOptionalBoolean_NotSet
The value is not set.
EHPMOptionalBoolean_On
The value is true/on/set.
EHPMOptionalBoolean_Off
The value is false/off/not set.
HPMUntranslatedString
Used to define an untranslated string.
struct HPMUntranslatedString {
HPMInt32 m_Dummy;
} HPMUntranslatedString;
Members
m_Dummy
Dummy variable. Not used
HPMBinaryBuffer
Stores binary data.
struct HPMBinaryBuffer {
HPMUInt32 m_nBytes;
const HPMUInt8 * m_pBytes;
} HPMBinaryBuffer;
Members
m_nBytes
The number of bytes of data.
m_pBytes
The binary data.
See Also
CommunicationChannelRegister, CommunicationChannelEnum
HPMResourceDefinition
Used to define lists of resources.
struct HPMResourceDefinition {
HPMInt32 m_GroupingType;
HPMUniqueID m_ID;
} HPMResourceDefinition;
Members
m_GroupingType
The grouping type. Can be one of EHPMResourceGroupingType.
m_ID
The unique identifier of the resource or resource group.
See Also
HPMResourceDefinitionList
Used to specify a list of resources.
struct HPMResourceDefinitionList {
HPMUInt32 m_nResources;
const HPMResourceDefinition * m_pResources;
} HPMResourceDefinitionList;
Members
m_nResources
The number of resources defined.
m_pResources
Pointer to a list of resources to define. See HPMResourceDefinition.
See Also
HPMWorkPass
Defines a work pass.
struct HPMWorkPass {
HPMUInt32 m_Start;
HPMUInt32 m_End;
} HPMWorkPass;
Members
m_Start
The start of the pass.
m_End
The end of the pass.
Comments
Times are defined as 1 + Half hours since midnight. To disable the pass set both start and end to 0.
See Also
HPMWorkDay, HPMCustomWorkHoursDay
HPMWorkDay
Defines a work Day.
struct HPMWorkDay {
HPMWorkPass m_WorkPasses[3];
} HPMWorkDay;
Members
m_WorkPasses
You can set up to three work passes for a day. See HPMWorkPass for details on work passes.
Comments
A work day is defined as three work passes.
See Also
HPMWorkPass, HPMTaskVacationOptions, HPMWorkingHours
HPMWorkingDays
Working days used in in ProjectCalendarGetWorkingDays, ProjectCalendarSetWorkingDays
struct HPMWorkingDays {
HPMInt32 m_bWorkDay[7];
} HPMWorkingDays;
Members
m_bWorkDay
The working week. m_bWorkDay[0] is Monday. A day is a working day if set to 1, a non working day if set to 0.
See Also
ProjectCalendarGetWorkingDays, ProjectCalendarSetWorkingDays
HPMCustomWorkDay
Work day status for a specific date.
struct HPMCustomWorkDay {
HPMUInt64 m_Date;
HPMInt32 m_bWorkDay;
} HPMCustomWorkDay;
Members
m_Date
The specific date for the working day status. Expressed as the number of micro seconds since 1970 UTC.
m_bWorkDay
Set to 1 if this day is a working day, 0 otherwise.
See Also
HPMCustomWorkingDays
Changed working days used in in ProjectCalendarGetCustomWorkingDays, ProjectCalendarSetCustomWorkingDays
struct HPMCustomWorkingDays {
HPMUInt32 m_nChangedDays;
const HPMCustomWorkDay * m_pChangedDays;
} HPMCustomWorkingDays;
Members
m_nChangedDays
The number of days to specify changed working day status for.
m_pChangedDays
Pointer to a list of HPMCustomWorkDay to specify changed working day status for.
See Also
ProjectCalendarGetCustomWorkingDays, ProjectCalendarSetCustomWorkingDays
HPMCustomWorkHoursDay
Changed working hours for a specific date.
struct HPMCustomWorkHoursDay {
HPMUInt64 m_Date;
HPMWorkPass m_WorkPasses[3];
} HPMCustomWorkHoursDay;
Members
m_Date
The specific date for the working hours. Expressed as the number of micro seconds since 1970 UTC.
m_WorkPasses
You can set up to three work passes for a day. See HPMWorkPass for details on work passes.
See Also
HPMCustomWorkingHours
Specific days to set working hours for used in ProjectCalendarGetCustomWorkingHours, ProjectCalendarSetCustomWorkingHours
struct HPMCustomWorkingHours {
HPMUInt32 m_nChangedDays;
const HPMCustomWorkHoursDay * m_pChangedDays;
} HPMCustomWorkingHours;
Members
m_nChangedDays
The number of days with changed working hours.
m_pChangedDays
Pointer to a list of HPMCustomWorkHoursDay to specify changed working hours for.
See Also
ProjectCalendarGetCustomWorkingHours, ProjectCalendarSetCustomWorkingHours
HPMWorkingHours
Working days used in ProjectCalendarGetWorkingDays, ProjectCalendarSetWorkingDays
struct HPMWorkingHours {
HPMWorkDay m_WorkDays[7];
} HPMWorkingHours;
Members
m_WorkDays
Used to specify work passes for the days of the week. See HPMWorkDay.
See Also
ProjectCalendarGetWorkingDays, ProjectCalendarSetWorkingDays
HPMHoliday
Holiday definition.
struct HPMHoliday {
HPMUInt64 m_Date;
const HPMUntranslatedString * m_pName;
} HPMHoliday;
Members
m_Date
The date to set a holiday for. Expressed as the number of micro seconds since 1970 UTC.
m_pName
The name of the holiday.
See Also
HPMHolidayYear
Year that has number of holidays defined.
struct HPMHolidayYear {
HPMInt32 m_Year;
HPMUInt32 m_nDays;
const HPMHoliday * m_pDays;
} HPMHolidayYear;
Members
m_Year
The year to set holidays for.
m_nDays
The number of holidays.
m_pDays
Pointer to a list of HPMHoliday to set as holidays.
See Also
HPMHolidays
Holidays used in ProjectCalendarGetHolidays, ProjectCalendarSetHolidays
struct HPMHolidays {
const HPMUntranslatedString * m_pCountry;
HPMUInt32 m_nYears;
const HPMHolidayYear * m_pYears;
} HPMHolidays;
Members
m_pCountry
The name of the country where the holidays are celebrated.
m_nYears
The number of years that holidays are defined for.
m_pYears
Pointer to a list of HPMHolidayYear to holidays for.
See Also
ProjectCalendarGetHolidays, ProjectCalendarSetHolidays
HPMCalendarDayInfo
Calendar information used in ProjectGetCalendarDayInfo
struct HPMCalendarDayInfo {
HPMInt32 m_bWorkingDay;
HPMInt32 m_bHoliday;
HPMInt32 m_bCompensatedHoliday;
HPMInt32 m_WorkingHours;
HPMInt32 m_bOriginatesFromVacationTask;
} HPMCalendarDayInfo;
Members
m_bWorkingDay
Set to 1 if day is a working day, 0 otherwise.
m_bHoliday
Set to 1 if day is a holiday, 0 otherwise.
m_bCompensatedHoliday
Set to 1 if day is a compensated, 0 otherwise.
m_WorkingHours
The number of working hours, expressed as half hours.
m_bOriginatesFromVacationTask
If a vacation task has affected the calendar in any way for this day this will be set to 1, 0 otherwise.
See Also
HPMMD5Checksum
Defines a MD5 checksum.
struct HPMMD5Checksum {
HPMUInt8 m_Checksum[16];
} HPMMD5Checksum;
Members
m_Checksum
The MD5 checksum data
See Also
HPMCustomSettingValue
Defines the value of a custom setting.
struct HPMCustomSettingValue {
HPMInt32 m_bIsDefault;
HPMInt32 m_bSecretValue;
const HPMChar * m_pValue;
} HPMCustomSettingValue;
Members
m_bIsDefault
Set to true when the requested value is the default value. If set to false when setting a value, the value is removed.
m_bSecretValue
If set the value will only be sent to the server and other SDK clients, not to normal clients. Not valid when getting values.
m_pValue
The value of the custom setting to get or set.
See Also
GlobalGetCustomSettingsValue, GlobalSetCustomSettingsValue ResourceGetCustomSettingsValue, ResourceSetCustomSettingsValue ProjectGetCustomSettingsValue, ProjectSetCustomSettingsValue ProjectResourceGetCustomSettingsValue, ProjectResourceSetCustomSettingsValue
HPMSDKInternalData
Defines SDK internal data.
struct HPMSDKInternalData {
HPMInt32 m_bSecret;
HPMUInt32 m_nData;
const HPMUInt8 * m_pData;
} HPMSDKInternalData;
Members
m_bSecret
If set the data will only be sent to the server and other SDK clients, not to normal clients. Not valid when getting data.
m_nData
The number of bytes of data defined.
m_pData
The data defined.
See Also
GlobalGetSDKInternalData, GlobalSetSDKInternalData ResourceGetSDKInternalData, ResourceSetSDKInternalData ProjectGetSDKInternalData, ProjectSetSDKInternalData ProjectResourceGetSDKInternalData, ProjectResourceSetSDKInternalData, TaskGetSDKInternalData, TaskSetSDKInternalData TaskGetCommentSDKInternalData, TaskSetCommentSDKInternalData TaskRefGetSDKInternalData, TaskRefSetSDKInternalData
HPMCustomStatisticsField
Used to define a statistics field.
struct HPMCustomStatisticsField {
HPMInt32 m_FieldID;
HPMUInt32 m_FieldData;
} HPMCustomStatisticsField;
Members
m_FieldID
The field ID. Can be one of EHPMStatisticsField. EHPMStatisticsField_CustomStatisticsSampler is not valid for this member.
m_FieldData
Extra data to identify the field. If m_FieldID is EHPMStatisticsField_CustomColumn this parameter should be the column hash for the custom column.
See Also
HPMProjectCustomStatisticsSampler, HPMProjectCustomStatisticsSampler, EHPMStatisticsField, HPMStatisticsCustomStatisticsFrequency
HPMVariantData
Used to represent variant data.
struct HPMVariantData {
HPMInt32 m_Dummy;
} HPMVariantData;
Members
m_Dummy
Dummy variable. Not used
HPMTaskField
Used to define a task field.
struct HPMTaskField {
HPMInt32 m_FieldID;
HPMUInt32 m_FieldData;
} HPMTaskField;
Members
m_FieldID
The field to specify data for. Can be one of EHPMTaskField.
m_FieldData
The field data to specify data for. If m_FieldID is EHPMTaskField_CustomColumnData this member is the column hash of the custom column data.
See Also
HPMTaskFieldData
Used to define the data for a task field.
struct HPMTaskFieldData {
HPMTaskField m_TaskField;
const HPMVariantData * m_pVariantData;
} HPMTaskFieldData;
Members
m_TaskField
The task field type.
m_pVariantData
A variant to specify the data. Use the VariantDecode_* and VariantEncode_* functions to manipulate this member.
See Also
HPMColumn
Used to define a column.
struct HPMColumn {
HPMInt32 m_ColumnType;
HPMUInt32 m_ColumnID;
} HPMColumn;
Members
m_ColumnType
Column identification type. Cane be one of EHPMColumnType.
m_ColumnID
If m_ColumnType is EHPMColumnType_DefaultColumn this value can be one of EHPMProjectDefaultColumn, otherwise if m_ColumnType is EHPMColumnType_CustomColumn it's the hash of the custom column. This together with m_ColumnType defines the order of the columns.
See Also
EHPMColumnType, HPMFindCriteriaDataHeader HPMReportSortGroupProperties
HPMColumnData
Used to hold the data items returned from UtilGetColumnData.
struct HPMColumnData {
HPMUInt32 m_nDataItems;
const HPMUInt32 * m_pDataItems;
HPMInt32 m_bFirstItemIsNotSet;
} HPMColumnData;
Members
m_nDataItems
The number of data items.
m_pDataItems
Pointer to a list of data items.
m_bFirstItemIsNotSet
Set to true when the first item in the list is the 'Not set' item
See Also
HPMColumnDescription
Used to hold the data items returned from UtilGetColumnDescription.
struct HPMColumnDescription {
HPMInt32 m_Type;
HPMInt32 m_CriteriaDataType;
HPMInt32 m_bFloatingPoint;
HPMInt32 m_bReadOnly;
HPMInt32 m_TaskFieldID;
HPMInt64 m_MinValue;
HPMInt64 m_MaxValue;
HPMInt32 m_MaxDecimals;
} HPMColumnDescription;
Members
m_Type
The type of the column. Will be one of EHPMValueType.
m_CriteriaDataType
The criteria data type of the column. Will be one of EHPMFindCriteriaDataType.
m_bFloatingPoint
Set to 1 if this is a floating point column, 0 otherwise.
m_bReadOnly
Set to 1 if this is read only, 0 otherwise.
m_TaskFieldID
The corresponding task field in EHPMTaskField.
m_MinValue
The min value of this column. Both m_MinValue and m_MaxValue set to 0 if not applicable.
m_MaxValue
The max value of this column. Both m_MinValue and m_MaxValue set to 0 if not applicable.
m_MaxDecimals
The max number of decimals for this column. Set to 0 for integers and for floating point columns that has infinite decimals.
See Also
HPMColumnTextOptions
Column text options used in TaskRefGetColumnText.
struct HPMColumnTextOptions {
HPMInt32 m_bForDisplay;
HPMInt32 m_bMyWork;
HPMInt32 m_bDisplayUnits;
HPMInt32 m_bExpandResources;
HPMInt32 m_bOnlyFirstResource;
HPMInt32 m_bNeedFullProjectPath;
HPMInt32 m_bNeedSprintInSubProjectPath;
HPMInt32 m_bSeparateSubProjectPath;
HPMUniqueID m_ForResource;
} HPMColumnTextOptions;
Members
m_bForDisplay
Set to 1 if this text is for display, 0 if intended for search.
m_bMyWork
Set to 1 if this is intended for my work.
m_bDisplayUnits
Set to 1 to display units where applicable.
m_bExpandResources
Set to 1 to expand resource groups to resources in Resource, Resource tag, Originally created by and Watch columns.
m_bOnlyFirstResource
Set to 1 to only show first resource in Resource, Resource tag, Originally created by and Watch columns.
m_bNeedFullProjectPath
Set to 1 to display full project path.
m_bNeedSprintInSubProjectPath
If set to 1 subproject path ends with the first encountered sprint.
m_bSeparateSubProjectPath
If set to 1 subproject path is displayed with description.
m_ForResource
Set to resource that this text will be displayed for.
See Also
HPMCustomColumnInfo
Used to define a column.
struct HPMCustomColumnInfo {
HPMInt32 m_ColumnType;
HPMInt32 m_ColumnID;
} HPMCustomColumnInfo;
Members
m_ColumnType
Column identification type. Cane be one of EHPMColumnType.
m_ColumnID
If m_ColumnType is EHPMColumnType_DefaultColumn this value can be one of EHPMProjectDefaultColumn, otherwise if m_ColumnType is EHPMColumnType_CustomColumn it's the hash of the custom column. This together with m_ColumnType defines the order of the columns.
See Also
EHPMColumnType, HPMFindCriteriaDataHeader HPMReportSortGroupProperties
HPMFindCondition
Holds filter conditions in HPMFindContext.
struct HPMFindCondition {
HPMInt32 m_SelectionType;
HPMInt32 m_SelectionID;
HPMColumn m_Column;
} HPMFindCondition;
Members
m_SelectionType
Can be one of EHPMFindSelectionType.
m_SelectionID
If m_SelctionType is EHPMFindSelectionType_Fixed this value can be one of EHPMFilterType, otherwise if m_SelctionType is EHPMFindSelectionType_Column it is the hash of the custom column.
m_Column
Column type.
HPMFindContextData
Used to store a compiled find context.
struct HPMFindContextData {
HPMInt32 m_Dummy;
} HPMFindContextData;
Members
m_Dummy
Dummy variable. Not used
HPMFindContext
Find context used in UtilPrepareFindContext.
struct HPMFindContext {
HPMUInt32 m_nConditions;
const HPMFindCondition * m_pConditions;
HPMUInt32 m_nMilestones;
const HPMUniqueID * m_pMilestones;
HPMUInt32 m_nPipelinesAndWorkflows;
const HPMUniqueID * m_pPipelinesAndWorkflows;
HPMInt32 m_bSeparateSubProjectPath;
} HPMFindContext;
Members
m_nConditions
Number of find conditions.
m_pConditions
Pointer to a list of find conditions. See HPMFindCondition.
m_nMilestones
The number of milestones that the find results should be tagged to.
m_pMilestones
Pointer to a list of unique identifiers pointing to the milestones that the find results should be tagged to.
m_nPipelinesAndWorkflows
The number of pipelines and workflows that the find results should be tagged to.
m_pPipelinesAndWorkflows
Pointer to a list of unique identifiers pointing to the pipelines and workflows that the find results should be tagged to.
m_bSeparateSubProjectPath
If set to 1 subproject path is included in find.
See Also
HPMWorkflowObjectIdentifier
Used to specify a workflow id together with an workflow object id to identify an workflow and a workflow object together.
struct HPMWorkflowObjectIdentifier {
HPMUInt32 m_WorkflowID;
HPMUInt32 m_WorkflowObjectID;
} HPMWorkflowObjectIdentifier;
Members
m_WorkflowID
The workflow identifier.
m_WorkflowObjectID
The workflow object identifier.
See Also
TaskGetCreatedFromWorkflowObject
HPMWorkflowStatusTransitInfo
Holds information about the last enter or exit from a workflow status.
struct HPMWorkflowStatusTransitInfo {
HPMUniqueID m_ResourceID;
HPMUInt64 m_Time;
} HPMWorkflowStatusTransitInfo;
Members
m_ResourceID
The unique identifier of the resource that last exited the status.
m_Time
The time when the status was last exited or entered. Expressed as the number of micro seconds since 1970 UTC.
See Also
TaskGetLastExitWorkflowStatus, TaskGetLastEnterWorkflowStatus
HPMFindCriteriaDataListItem
Used to define an item in a find criteria item list.
struct HPMFindCriteriaDataListItem {
HPMInt32 m_ID;
HPMUInt32 m_Data;
} HPMFindCriteriaDataListItem;
Members
m_ID
The ID for the item. The type of id is dependent on the column type set in HPMFindCriteriaDataHeader::m_ColumnID.
m_Data
Optional data field for the list item. Currently set to 0 for all types except when HPMFindCriteriaDataHeader::m_ColumnID is set to EHPMProjectDefaultColumn_PipelineAndWorkflow. It is then set to HPMProjectWorkflowObject::m_ObjectID;
See Also
HPMFindCriteriaTypeDroplist, HPMFindCriteriaTypeMultiSelectDroplist
HPMFindCriteriaData
Used to represent criteria data. Use the CriteriaDataEncode_* and CriteriaDataDecode_* to manipulate it.
struct HPMFindCriteriaData {
HPMInt32 m_Dummy;
} HPMFindCriteriaData;
Members
m_Dummy
Dummy variable. Not used
See Also
Comments
Use UtilGetFindCriteriaDataTypeFromData to determine which CriteriaDataDecode_* function to use.
HPMFindCriteriaConnection
Used to define a connection between find criteria.
struct HPMFindCriteriaConnection {
HPMUInt32 m_ID;
HPMInt32 m_ConnectFrom;
HPMInt32 m_ConnectTo;
} HPMFindCriteriaConnection;
Members
m_ID
The unique identifier of the find criteria this find criteria is connected to.
m_ConnectFrom
The site on the start object that the connection is made from. See EHPMFindCriteriaConnectionSite.
m_ConnectTo
The site on the end object that the connection is made to. See EHPMFindCriteriaConnectionSite.
See Also
HPMFindCriteria
Defines a find criteria.
struct HPMFindCriteria {
HPMUInt32 m_ID;
HPMInt32 m_PositionX;
HPMInt32 m_PositionY;
HPMInt32 m_Type;
HPMUInt32 m_Flags;
const HPMChar * m_CriteriaString;
const HPMFindCriteriaData * m_pCriteriaData;
HPMUInt32 m_nConnectedToCriterias;
const HPMFindCriteriaConnection * m_pConnectedToCriterias;
} HPMFindCriteria;
Members
m_ID
The unique id of the find criteria.
m_PositionX
The X position this object is displayed on when editing the find criteria.
m_PositionY
The Y position this object is displayed on when editing the find criteria.
m_Type
Type of find criteria. See EHPMFindCriteriaType
m_Flags
Flags for find criteria options. See EHPMFindCriteriaFlag.
m_CriteriaString
The string that defines the criteria, e.g. Resources: "John Smith".
m_pCriteriaData
The criteria data. Use the CriteriaDataDecode_* and CriteriaDataEncode_* functions to manipulate this member.
m_nConnectedToCriterias
Number of find criteria this find criteria is connected to.
m_pConnectedToCriterias
Pointer to a list of find criteria for this find criteria is connected to. See HPMFindCriteriaConnection.
See Also
HPMFindCriteriaConnection, HPMFindCriteriaData, UtilGetFindCriteriaDataTypeFromData, UtilGetFindCriteriaDataTypeFromColumn
HPMFindCriteriaDataHeader
The header for the different criteria types.
struct HPMFindCriteriaDataHeader {
HPMColumn m_Column;
HPMInt32 m_Operator;
} HPMFindCriteriaDataHeader;
Members
m_Column
The column used in the find criteria.
m_Operator
The operator for the find criteria. Can be one of EHPMFindCriteriaOperator.
See Also
HPMFindCriteria, HPMFindCriteriaData, HPMFindCriteriaTypeText, HPMFindCriteriaTypeInteger, HPMFindCriteriaTypeFloat, HPMFindCriteriaTypeGeneralCondition, HPMFindCriteriaTypeDate, HPMFindCriteriaTypeDroplist, HPMFindCriteriaTypeMultiSelectDroplist, HPMFindCriteriaDataListItem
HPMFindCriteriaTypeText
Used if the find criteria is of a text type.
struct HPMFindCriteriaTypeText {
HPMFindCriteriaDataHeader m_Header;
const HPMChar * m_Text;
} HPMFindCriteriaTypeText;
Members
m_Header
The find criteria data header.
m_Text
The text to use for the condition.
See Also
HPMFindCriteria, HPMFindCriteriaDataHeader, CriteriaDataEncode_HPMTaskFindCriteriaTypeText, CriteriaDataDecode_HPMTaskFindCriteriaTypeText |
HPMFindCriteriaTypeInteger
Used if the find criteria is of an integer type.
struct HPMFindCriteriaTypeInteger {
HPMFindCriteriaDataHeader m_Header;
HPMInt64 m_Number;
HPMInt64 m_ToNumber;
} HPMFindCriteriaTypeInteger;
Members
m_Header
The find criteria data header.
m_Number
The number to use in the condition.
m_ToNumber
The number to use as the end if the condition is a range. m_Number will be used as the starting point.
See Also
HPMFindCriteria, HPMFindCriteriaData, HPMFindCriteriaDataHeader, CriteriaDataEncode_HPMTaskFindCriteriaTypeInteger, CriteriaDataDecode_HPMTaskFindCriteriaTypeInteger |
HPMFindCriteriaTypeFloat
Used if the find criteria is of a float type.
struct HPMFindCriteriaTypeFloat {
HPMFindCriteriaDataHeader m_Header;
HPMFP64 m_Number;
HPMFP64 m_ToNumber;
} HPMFindCriteriaTypeFloat;
Members
m_Header
The find criteria data header.
m_Number
The number to use in the condition.
m_ToNumber
The number to use as the end if the condition is a range. m_Number will be used as the starting point.
See Also
HPMFindCriteria, HPMFindCriteriaData, HPMFindCriteriaDataHeader, CriteriaDataEncode_HPMTaskFindCriteriaTypeFloat, CriteriaDataDecode_HPMTaskFindCriteriaTypeFloat
HPMFindCriteriaTypeGeneralCondition
Used if the find criteria is of a general condition type.
struct HPMFindCriteriaTypeGeneralCondition {
HPMFindCriteriaDataHeader m_Header;
} HPMFindCriteriaTypeGeneralCondition;
Members
m_Header
The find criteria data header.
See Also
HPMFindCriteria, HPMFindCriteriaData, HPMFindCriteriaDataHeader, CriteriaDataEncode_HPMTaskFindCriteriaTypeGeneralCondition, CriteriaDataDecode_HPMTaskFindCriteriaTypeGeneralCondition |
HPMFindCriteriaTypeDate
Used if the find criteria is of a date type.
struct HPMFindCriteriaTypeDate {
HPMFindCriteriaDataHeader m_Header;
HPMUInt64 m_Date;
HPMUInt64 m_ToDate;
HPMInt32 m_Range;
const HPMChar * m_Text;
} HPMFindCriteriaTypeDate;
Members
m_Header
The find criteria data header.
m_Date
The date to use in the condition.
m_ToDate
The date to use as the end if the condition is a range. m_Date will be used as the starting point.
m_Range
If HPMFindCriteriaDataHeader::m_Operator is one of the operators containing a condition with X days, weeks, months or years, this will be set to the X number.
m_Text
If HPMFindCriteriaDataHeader::m_Operator is EHPMFindCriteriaOperator::_Contains this is set to the free text to use in the condition
See Also
HPMFindCriteria, HPMFindCriteriaData, HPMFindCriteriaDataHeader, CriteriaDataEncode_HPMTaskFindCriteriaTypeDate, CriteriaDataDecode_HPMTaskFindCriteriaTypeDate |
HPMFindCriteriaTypeDroplist
Used if the find criteria is a of a droplist type
struct HPMFindCriteriaTypeDroplist {
HPMFindCriteriaDataHeader m_Header;
HPMUInt32 m_nListItems;
const HPMFindCriteriaDataListItem * m_pListItems;
} HPMFindCriteriaTypeDroplist;
Members
m_Header
The find criteria data header.
m_nListItems
The number of list items.
m_pListItems
Pointer to a list of list items for this criteria. See HPMFindCriteriaDataListItem.
See Also
HPMFindCriteria, HPMFindCriteriaData, HPMFindCriteriaDataHeader, CriteriaDataEncode_HPMTaskFindCriteriaTypeDroplist, CriteriaDataDecode_HPMTaskFindCriteriaTypeDroplist |
HPMFindCriteriaTypeMultiSelectDroplist
Used if the find criteria is of a multi select droplist type. The items together with the HPMFindCriteriaDataHeader::m_Operator sets the condition.
struct HPMFindCriteriaTypeMultiSelectDroplist {
HPMFindCriteriaDataHeader m_Header;
HPMUInt32 m_nListItems;
const HPMFindCriteriaDataListItem * m_pListItems;
} HPMFindCriteriaTypeMultiSelectDroplist;
Members
m_Header
The find criteria data header.
m_nListItems
The number of list items.
m_pListItems
Pointer to a list of list items for this criteria. See HPMFindCriteriaDataListItem.
See Also
HPMFindCriteria, HPMFindCriteriaData, HPMFindCriteriaDataHeader, CriteriaDataEncode_HPMTaskFindCriteriaTypeMultiSelectDroplist, CriteriaDataDecode_HPMTaskFindCriteriaTypeMultiSelectDroplist
HPMReportEmailProperties
Defines email properties in HPMReport.
struct HPMReportEmailProperties {
HPMInt32 m_PeriodicityType;
HPMInt32 m_DayOfWeek;
HPMInt32 m_HourOfDay;
HPMResourceDefinitionList m_RecipientList;
} HPMReportEmailProperties;
Members
m_PeriodicityType
The periodicity of when to send project reports. Can be one of EHPMPeriodicityType.
m_DayOfWeek
The weekday to send the project report. 0 -> 6 = Mon -> Sunday. Only valid if HPMReportEmailProperties::m_PeriodicityType is set to EHPMPeriodicityType_Weekly.
m_HourOfDay
The number of half hours past midnight to send project reports. 0 -> 47 (number of half hours from midnight).
m_RecipientList
List of resources that will receive the email. See HPMResourceDefinitionList.
HPMReportSortGroupProperties
Defines sorting and grouping properties in HPMReport.
struct HPMReportSortGroupProperties {
HPMColumn m_Column;
HPMInt32 m_OrderType;
HPMInt32 m_bDescending;
} HPMReportSortGroupProperties;
Members
m_Column
The column used for sorting.
m_OrderType
The order type of the sorting or grouping. Can be one of EHPMReportSortGroupOrderType.
m_bDescending
Set if the report should be sorted in descending order, otherwise it will be sorted in ascending order. Not used for grouping.
HPMReport
Used to define a report in HPMReports.
struct HPMReport {
HPMUniqueID m_ReportID;
HPMUInt64 m_ReportGUID;
const HPMChar * m_pName;
HPMUniqueID m_ProjectID;
HPMUniqueID m_ResourceID;
HPMUInt32 m_Flags;
HPMUInt32 m_Icon;
HPMUInt32 m_nColumnsShowing;
const HPMColumn * m_pColumnsShowing;
HPMUInt32 m_nColumnsOrdering;
const HPMColumn * m_pColumnsOrdering;
HPMReportEmailProperties m_EmailProperties;
HPMResourceDefinitionList m_ShareResourceList;
HPMUInt32 m_nSortColumns;
const HPMReportSortGroupProperties * m_pSortColumns;
HPMReportSortGroupProperties m_GroupByColumnMain;
HPMReportSortGroupProperties m_GroupByColumnSub;
HPMUInt32 m_nFindCriterias;
const HPMFindCriteria * m_pFindCriterias;
} HPMReport;
Members
m_ReportID
The unique identifier of this report.
m_ReportGUID
A GUID that is unique across all resources and projects. Set to zero to generate a new GUID automatically when creating a new report.
m_pName
The name of the report.
m_ProjectID
The project this report was created in.
m_ResourceID
Resource ID of user that created report.
m_Flags
Flags for different view options. See EHPMReportFlag.
m_Icon
Icon for the reports. Can be one of EHPMListIcon.
m_nColumnsShowing
Number of columns showing for this report.
m_pColumnsShowing
Pointer to a list of columns showing for this report. See HPMColumn.
m_nColumnsOrdering
Number of columns in the order they should be shown for this report.
m_pColumnsOrdering
Pointer to a list of columns in the order they should be shown for this report. See HPMColumn.
m_EmailProperties
Email properties for this report. See HPMReportEmailProperties.
m_ShareResourceList
List of resources that this report is shared with. See HPMResourceDefinitionList.
m_nSortColumns
Number of sort columns.
m_pSortColumns
Pointer to a list of sort columns. See HPMReportSortGroupProperties.
m_GroupByColumnMain
The main column used for grouping. The column criteria data type has to be EHPMFindCriteriaDataType_List or EHPMFindCriteriaDataType_ConditionalList. See UtilGetFindCriteriaDataTypeFromColumn.
m_GroupByColumnSub
The sub column used for grouping. The column criteria data type has to be EHPMFindCriteriaDataType_List or EHPMFindCriteriaDataType_ConditionalList. See UtilGetFindCriteriaDataTypeFromColumn.
m_nFindCriterias
Number of find criterias for this report.
m_pFindCriterias
Pointer to a list of find criterias for this report. See HPMFindCriteria.
See Also
HPMReportEmailProperties, HPMResourceDefinitionList, HPMReportSortGroupProperties, HPMColumn, HPMFindCriteria
HPMReports
Used to define the reports for a project.
struct HPMReports {
HPMUInt32 m_nReports;
const HPMReport * m_pReports;
} HPMReports;
Members
m_nReports
The number of reports for this project.
m_pReports
Pointer to a list of reports for this project. See HPMReport.
See Also
HPMReport, ProjectGetReports, ProjectSetReports, GlobalGetReports, GlobalSetReports
HPMEnabledAction
Used to define enabled actions on a state.
struct HPMEnabledAction {
HPMInt32 m_FunctionType;
} HPMEnabledAction;
Members
m_FunctionType
The enabled action. Can currently only be EHPMProjectDetailedAccessRuleFunctionType_DeleteTask.
See Also
HPMWorkflowProgressionState
Used for defining requirements to reach a workflow state.
struct HPMWorkflowProgressionState {
HPMUInt32 m_StatusID;
HPMUInt32 m_nRequiredFields;
HPMTaskField const * m_pRequiredFields;
HPMUInt32 m_TransitionFlags;
HPMUInt32 m_nEnabledActions;
HPMEnabledAction const * m_pEnabledActions;
} HPMWorkflowProgressionState;
Members
m_StatusID
The status ID of the state.
m_nRequiredFields
The number of required fields that need to be filled in to reach this state.
m_pRequiredFields
Pointer to a list of the required fields that need to be set to reach this state.
m_TransitionFlags
The transition flags required for progressing to this state. Can be EHPMProjectWorkflowObjectFlag_Transition_ResourcesCanEditAllFieldsThatMustBeSetForThisTransition or EHPMProjectWorkflowObjectFlag_WorkflowStatus_ActionsAreEnabledOnPreviousStatus.
m_nEnabledActions
The number of required fields that need to be filled in to reach this state.
m_pEnabledActions
Pointer to a list of the enabled actions on this state.
See Also
HPMWorkflowProgressionStructure
Used for defining a workflow progression structure obtained from a workflow, status and resource.
struct HPMWorkflowProgressionStructure {
HPMUInt32 m_nProgressionStates;
const HPMWorkflowProgressionState * m_pProgressionStates;
} HPMWorkflowProgressionStructure;
Members
m_nProgressionStates
The number of reachable states the workflow progression structure.
m_pProgressionStates
Pointer to a list of states defining the workflow progression. See HPMWorkflowProgressionState.
See Also
HPMWorkflowProgressionState, ProjectUtilGetWorkflowProgression
HPMCommunicationChannelPacket
Used to store SDK named communication channel packets
struct HPMCommunicationChannelPacket {
HPMUInt32 m_nBytes;
const HPMUInt8 * m_pBytes;
HPMUInt32 m_Flags;
} HPMCommunicationChannelPacket;
Members
m_nBytes
The number of bytes of data to send or receive.
m_pBytes
The data to send or receive.
m_Flags
Settings for the packet. Can be any combination of EHPMPacketFlag.
See Also
CommunicationChannelSendPacket, EHPMChangeCallbackOperation_CommunicationChannelPacketReceived
HPMTimesheetConfigRow
Definition of a non project time row for timesheets.
struct HPMTimesheetConfigRow {
HPMUInt32 m_RowID;
const HPMUntranslatedString * m_pRowName;
} HPMTimesheetConfigRow;
Members
m_RowID
The activity identifier of the row.
m_pRowName
The name of the row.
See Also
HPMTimesheetActivity
Structure that holds timesheet data posts.
struct HPMTimesheetActivity {
HPMInt32 m_RowID;
HPMInt32 m_ActivityID;
HPMUniqueID m_ProjectID;
HPMUniqueID m_TaskID;
HPMUInt32 m_Started;
HPMUInt32 m_Duration;
const HPMChar * m_Comment;
} HPMTimesheetActivity;
Members
m_RowID
The row id of the activity.
m_ActivityID
The activity id of the activity.
m_ProjectID
The unique identifier of the project for activities in projects.
m_TaskID
The unique identifier of the task task activities.
m_Started
The start time of the activity. Expressed in seconds since midnight. The max value is 86340.
m_Duration
The duration time of the activity. Expressed in seconds. The max value is 86340.
m_Comment
Comment describing the activity.
See Also
HPMChangeCallbackData_ResourceGetTimesheetDayResponse, HPMChangeCallbackData_TimesheetGetDateRangeResponse
HPMTimesheetDay
Structure that holds timesheet data for a timesheet day.
struct HPMTimesheetDay {
HPMUniqueID m_DayID;
HPMUniqueID m_ResourceID;
HPMUInt64 m_Day;
HPMUInt32 m_nActivities;
const HPMTimesheetActivity * m_pActivities;
} HPMTimesheetDay;
Members
m_DayID
The unique identifier of the timesheet day.
m_ResourceID
The unique identifier of the resource the timesheet day data is reported for.
m_Day
The day that the data is reported for. Expressed as the number of microseconds since 1970 UTC.
m_nActivities
The number of timesheet activities.
m_pActivities
Pointer to a list of HPMTimesheetActivity timesheet activities.
See Also
HPMChangeCallbackData_ResourceGetTimesheetDayResponse, HPMChangeCallbackData_TimesheetGetDateRangeResponse
HPMUniqueEnum
Used for enumerating unique id's in a database.
struct HPMUniqueEnum {
HPMUInt32 m_nIDs;
const HPMUniqueID * m_pIDs;
} HPMUniqueEnum;
Members
m_nIDs
The number of unique id's in the array.
m_pIDs
Pointer to a list unique database identifiers.
HPMColumnList
Columns list.
struct HPMColumnList {
HPMInt32 m_nColumns;
HPMColumn const * m_pColumns;
} HPMColumnList;
Members
m_nColumns
Number of columns.
m_pColumns
List of columns.
HPMBoardElementDefinition
Board element definition for HPMBoardConfiguration.
struct HPMBoardElementDefinition {
HPMUniqueID m_LocalObjectID;
HPMUniqueID m_ID;
HPMString m_Name;
HPMFP64 m_Position;
} HPMBoardElementDefinition;
Members
m_LocalObjectID
Local id that will be returned when element is created. Must be specified during board creation
m_ID
ID that will be returned when board is created.
m_Name
The name the element will have.
m_Position
The position element will have. All lanes in board and all columns in parent lane are sorted in order by their position. We use HPMFP64 type instead on index ordering here to minimize the chance when two users are moving element to the same position.
See Also
HPMBoardConfiguration, TaskBoardCreateLane TaskBoardCreateColumn, TaskBoardUpdateElement
HPMTimesheetConfig
Used to configure and customize timesheets.
struct HPMTimesheetConfig {
HPMInt32 m_DefaultActivityType;
HPMUInt32 m_DefaultStarted;
HPMUInt32 m_DefaultDuration;
HPMInt32 m_bHideStartFinish;
HPMUInt32 m_nRows;
const HPMTimesheetConfigRow * m_pRows;
} HPMTimesheetConfig;
Members
m_DefaultActivityType
The default activity type for new rows. One of the available HPMTimesheetConfigRow::m_RowIDs.
m_DefaultStarted
The default started time for new rows. Expressed in seconds since midnight. The max value is 86340.
m_DefaultDuration
The default duration time for new rows. Expressed in seconds. The max value is 86340.
m_bHideStartFinish
Set to 1 to hide start and finish when reporting time.
m_nRows
The number of number of rows available in non project time.
m_pRows
Pointer to a list of HPMTimesheetConfigRow non project time rows.
See Also
GlobalSetTimesheetConfig, GlobalGetTimesheetConfig
HPMTimesheetLock
Holds project's timesheet lock info.
struct HPMTimesheetLock {
HPMUInt64 m_LockDate;
HPMInt32 m_bLocked;
} HPMTimesheetLock;
Members
m_LockDate
The end date that the lock effects. Expressed as the number of microseconds since 1970 UTC.
m_bLocked
Set to 1 if resources cannot change timesheets before m_LockDate, 0 otherwise.
See Also
ProjectSetTimesheetLock, ProjectGetTimesheetLock
HPMDynamicCustomSettingsContext
Used to identify a dynamic custom settings context.
struct HPMDynamicCustomSettingsContext {
HPMInt32 m_Dummy;
} HPMDynamicCustomSettingsContext;
Members
m_Dummy
Unused dummy member
HPMRightClickContext
Used to identify a right click context.
struct HPMRightClickContext {
HPMInt32 m_Dummy;
} HPMRightClickContext;
Members
m_Dummy
Unused dummy member
HPMDynamicCustomSettingsValue
Used to define the value of a dynamic custom setting.
struct HPMDynamicCustomSettingsValue {
const HPMChar * m_pPath;
const HPMChar * m_pValue;
} HPMDynamicCustomSettingsValue;
Members
m_pPath
The path of the value.
m_pValue
The value.
HPMDynamicCustomSettingsValues
Used to define several dynamic custom setting values.
struct HPMDynamicCustomSettingsValues {
HPMInt32 m_nValues;
const HPMDynamicCustomSettingsValue * m_pValues;
} HPMDynamicCustomSettingsValues;
Members
m_nValues
The number of custom settings values.
m_pValues
Pointer to a list of custom settings values. See HPMDynamicCustomSettingsValue.
HPMDynamicCustomSettingsPaths
Used to define paths of dynamic custom settings.
struct HPMDynamicCustomSettingsPaths {
HPMInt32 m_nPaths;
const HPMString * m_pPaths;
} HPMDynamicCustomSettingsPaths;
Members
m_nPaths
The number of custom settings value paths.
m_pPaths
Pointer to a list of custom settings value paths. See HPMString.
HPMChatRoom
Used to define and identify a chat room.
struct HPMChatRoom {
HPMResourceDefinition m_ChatResource1;
HPMResourceDefinition m_ChatResource2;
} HPMChatRoom;
Members
m_ChatResource1
Resource or resource group in the chat room. See HPMResourceDefinition.
m_ChatResource2
Resource or resource group in the chat room. See HPMResourceDefinition.
Comments
The two resources in the chat room identifies the chat room and is used for routing the chat message. If the chat room is used for resource group communication, set m_ChatResource1.m_GroupingType to EHPMResourceGroupingType_ResourceGroup and m_ChatResource1.m_ID to the id of the resource group. m_ChatResource2 is not used for resource group chats.
See Also
HPMChatMessage
Used to store historic chat messages.
struct HPMChatMessage {
HPMInt64 m_ID;
const HPMChar * m_pMessage;
} HPMChatMessage;
Members
m_ID
The id of the chat message.
m_pMessage
The chat message. See the comments section on HPMTaskComment for supported text formatting tags.
See Also
HPMLastAssignedInWorkflowStatus
Used to store historic chat messages.
struct HPMLastAssignedInWorkflowStatus {
HPMUInt32 m_WorkflowID;
HPMUInt32 m_WorkflowObjectID;
HPMResourceDefinitionList m_LastAssignedList;
} HPMLastAssignedInWorkflowStatus;
Members
m_WorkflowID
TBD
m_WorkflowObjectID
TBD
m_LastAssignedList
TBD
See Also
HPMLastAssignedInWorkflowStatuses
Used to store historic chat messages.
struct HPMLastAssignedInWorkflowStatuses {
HPMUInt32 m_nLastAssignedList;
const HPMLastAssignedInWorkflowStatus * m_pLastAssignedList;
} HPMLastAssignedInWorkflowStatuses;
Members
m_nLastAssignedList
The number of resources defined.
m_pLastAssignedList
Pointer to a list of resources to define. See HPMLastAssignedInWorkflowStatus.
See Also
HPMProjectCustomColumnsColumnDropListItem
Used for specifying drop list items in a HPMProjectCustomColumnsColumn object.
struct HPMProjectCustomColumnsColumnDropListItem {
const HPMChar * m_pName;
HPMUInt32 m_Icon;
HPMUInt32 m_Id;
HPMUInt32 m_nAutoAssignResources;
const HPMResourceDefinition * m_pAutoAssignResources;
} HPMProjectCustomColumnsColumnDropListItem;
Members
m_pName
The name of the drop list item. Displayed to user.
m_Icon
An icon for the drop list item. Can be one of EHPMListIcon.
m_Id
The identifier for the drop list item. Every item should have a unique identifier.
m_nAutoAssignResources
The number of resources to auto assign.
m_pAutoAssignResources
Pointer to a list of resources to auto assign. See HPMResourceDefinition.
See Also
HPMProjectCustomColumnsColumn, EHPMListIcon
HPMProjectCustomColumnsColumnSDKData
Used for SDK custom data in a HPMProjectCustomColumnsColumn object.
struct HPMProjectCustomColumnsColumnSDKData {
const HPMChar * m_pKey;
HPMUInt32 m_nValue;
const HPMUInt8 * m_pValue;
} HPMProjectCustomColumnsColumnSDKData;
Members
m_pKey
The key for the SDK data. Preferable of format: "com.company.integrationx"
m_nValue
The number of bytes in the value
m_pValue
The value for key
See Also
HPMProjectCustomColumnsColumn,
HPMProjectCustomColumnsColumn
Used for specifying a custom column in HPMProjectCustomColumns, and UtilGetColumnHash.
struct HPMProjectCustomColumnsColumn {
HPMUInt32 m_Hash;
HPMUInt32 m_Type;
const HPMChar * m_pName;
HPMUInt32 m_AccessRights;
const HPMChar * m_pUnit;
HPMUInt32 m_nDropListItems;
const HPMProjectCustomColumnsColumnDropListItem * m_pDropListItems;
HPMUInt32 m_nSDKData;
const HPMProjectCustomColumnsColumnSDKData * m_pSDKData;
HPMUInt32 m_Flags;
HPMUInt32 m_bHidden;
} HPMProjectCustomColumnsColumn;
Members
m_Hash
The hash of the column. This hash is only used when getting properties of a column it is not used for setting properties or creating a column. To calculate the hash of a column you can use UtilGetColumnHash.
m_Type
The type of column. Can be one of EHPMProjectCustomColumnsColumnType.
m_pName
The name of the column.
m_AccessRights
The access rights for the column. Can be one of EHPMProjectCustomColumnsColumnAccessRights
m_pUnit
The unit for data in the column.
m_nDropListItems
The number of drop list items for the column. Only valid if m_Type is set to EHPMProjectCustomColumnsColumnType_DropList.
m_pDropListItems
Pointer to a list of drop list items. See HPMProjectCustomColumnsColumnDropListItem. Only valid if m_Type is set to EHPMProjectCustomColumnsColumnType_DropList.
m_nSDKData
The number of SDK data for the column.
m_pSDKData
Pointer to a list of SDK data. See HPMProjectCustomColumnsColumnSDKData.
m_Flags
Flags. Can be any of EHPMProjectCustomColumnsColumnFlag.
m_bHidden
Is column hidden
See Also
HPMProjectCustomColumns, EHPMProjectCustomColumnsColumnType, EHPMProjectCustomColumnsColumnAccessRights, HPMProjectCustomColumnsColumnDropListItem, UtilGetColumnHash
HPMProjectCustomColumnChange
Used for specifying a changed column in HPMProjectCustomColumnChanges
struct HPMProjectCustomColumnChange {
HPMProjectCustomColumnsColumn m_Column;
HPMUInt32 m_OriginalHash;
} HPMProjectCustomColumnChange;
Members
m_Column
The new custom column data.
m_OriginalHash
The original hash. You need to specify the original hash of the column for data to be correctly moved to the new hash. Failure to do so correctly could cause data corruption. If the old column is not found the change will be ignored.
See Also
HPMStringPosition
Used to store a string position in an opaque way. This is needed to account for character encoding differences between different platforms (UTF-8 vs UTF-16).
struct HPMStringPosition {
HPMInt32 m_Dummy;
} HPMStringPosition;
Members
m_Dummy
Dummy variable. Not used
See Also
HPMFunctionColumnToken, HPMFunctionColumnTokens
HPMFunctionColumnToken
Used to define a function column token.
struct HPMFunctionColumnToken {
HPMInt32 m_TokenType;
HPMInt32 m_Operator;
HPMInt32 m_Function;
HPMInt32 m_Parenthesis;
HPMColumn m_Column;
HPMFP64 m_Value;
HPMChar const * m_pInvalid;
HPMStringPosition const * m_pStringPosition;
} HPMFunctionColumnToken;
Members
m_TokenType
The type of the token. Can be one of EHPMProjectFunctionColumnToken (Operator, Function, Parenthesis, Column, Numeric, Invalid).
m_Operator
Operator token value. Used only if m_TokenType is EHPMProjectFunctionColumnToken_Operator.
m_Function
Function token value. Used only if m_TokenType is EHPMProjectFunctionColumnToken_Function.
m_Parenthesis
Parenthesis value. Used only if m_TokenType is EHPMProjectFunctionColumnToken_Parenthesis.
m_Column
Column value. Used only if m_TokenType is EHPMProjectFunctionColumnToken_Column.
m_Value
Numeric value. Used only if m_TokenType is EHPMProjectFunctionColumnToken_Numeric.
m_pInvalid
Invalid column name. Used only if m_TokenType is EHPMProjectFunctionColumnToken_Invalid.
m_pStringPosition
String position of token in original expression string.
See Also
EHPMProjectFunctionColumnOperator, EHPMProjectFunctionColumnParenthesis, EHPMProjectFunctionColumnToken, HPMFunctionColumnTokens EHPMProjectFunctionColumnFunction, HPMStringPosition
HPMFunctionColumnTokens
Used to define function column tokens.
struct HPMFunctionColumnTokens {
HPMUInt32 m_nTokens;
HPMFunctionColumnToken const * m_pTokens;
} HPMFunctionColumnTokens;
Members
m_nTokens
The number of tokens.
m_pTokens
Pointer to a list of tokens. See HPMFunctionColumnToken.
See Also
HPMProjectFunctionColumnExpression
Used to define a function column expression.
struct HPMProjectFunctionColumnExpression {
HPMUInt32 m_ColumnHash;
HPMFunctionColumnTokens m_Tokens;
} HPMProjectFunctionColumnExpression;
Members
m_ColumnHash
The hash of the function custom column.
m_Tokens
List of tokens for the hash. See HPMFunctionColumnTokens.
See Also
HPMFunctionColumnToken, HPMFunctionColumnTokens, ProjectGetFunctionColumnExpression
HPMProjectColumnMetaData
Used to define column meta data.
struct HPMProjectColumnMetaData {
const HPMChar * m_pDetailedDescription;
const HPMVariantData * m_pDefaultValue;
HPMResourceDefinitionList m_EditableBy;
HPMUInt32 m_Flags;
HPMUInt32 m_bHasDefaultValue;
} HPMProjectColumnMetaData;
Members
m_pDetailedDescription
The detailed description for the column.
m_pDefaultValue
The default value for the column.
m_EditableBy
The list of resources or resource groups that have edit rights for column on tasks.
m_Flags
Flags for the column.
m_bHasDefaultValue
If set the column has a default value in m_pDefaultValue that can be decoded. Only valid for ProjectGetColumnMetaData.
See Also
ProjectGetColumnMetaData, ProjectSetColumnMetaData
HPMProjectCustomColumnMetaData
Used to store meta data for a custom column.
struct HPMProjectCustomColumnMetaData {
HPMUInt32 m_ColumnHash;
HPMProjectColumnMetaData m_MetaData;
} HPMProjectCustomColumnMetaData;
Members
m_ColumnHash
The hash of the column.
m_MetaData
The meta data for the column. See HPMProjectColumnMetaData.
See Also
HPMProjectCustomColumnChanges
Used for specifying added/renamed/deleted custom columns
struct HPMProjectCustomColumnChanges {
HPMUniqueID m_ProjectID;
HPMUInt32 m_nAdded;
HPMProjectCustomColumnsColumn const * m_pAdded;
HPMUInt32 m_nChanged;
HPMProjectCustomColumnChange const * m_pChanged;
HPMUInt32 m_nRemoved;
HPMUInt32 const * m_pRemoved;
HPMUInt32 m_nExpressions;
HPMProjectFunctionColumnExpression const * m_pExpressions;
HPMUInt32 m_nMetaData;
HPMProjectCustomColumnMetaData const * m_pMetaData;
HPMInt32 m_bCreateInSubprojects;
HPMInt32 m_bRemoveInSubprojects;
HPMInt32 m_bRenameInSubprojects;
} HPMProjectCustomColumnChanges;
Members
m_ProjectID
The unique identifier of the project to change the column in.
m_nAdded
The number of columns added.
m_pAdded
Pointer to a list of columns that are added. See HPMProjectCustomColumnsColumn.
m_nChanged
The number of changed columns.
m_pChanged
Pointer to a list of changed columns. See HPMProjectCustomColumnChange.
m_nRemoved
The number of custom column hashes removed.
m_pRemoved
Pointer to a list of custom column hashes removed.
m_nExpressions
The number of changed expressions.
m_pExpressions
Pointer to a list of changed expressions. See HPMProjectFunctionColumnExpression.
m_nMetaData
The number of changed meta data.
m_pMetaData
Pointer to a list of changed meta data. See HPMProjectCustomColumnMetaData.
m_bCreateInSubprojects
If set to true then columns will be added in corresponding main/QA/backlog projects.
m_bRemoveInSubprojects
If set to true then columns will be removed in corresponding main/QA/backlog projects.
m_bRenameInSubprojects
If set to true then columns will be renamed in corresponding main/QA/backlog projects.
See Also
HPMProjectCustomColumnsColumn, HPMProjectFunctionColumnExpression HPMProjectCustomColumnChange, HPMProjectCustomColumnMetaData
HPMProjectFunctionColumnExpressions
Used to store function column expressions.
struct HPMProjectFunctionColumnExpressions {
HPMUInt32 m_nExpressions;
HPMProjectFunctionColumnExpression const * m_pExpressions;
} HPMProjectFunctionColumnExpressions;
Members
m_nExpressions
The number of function column expressions
m_pExpressions
Pointer to a list of function column expressions. See HPMProjectFunctionColumnExpression.
See Also
HPMProjectFunctionColumnExpression, ProjectUtilValidateLocalContextFunctionColumnExpressionChanges
HPMStringEnum
List of strings.
struct HPMStringEnum {
HPMUInt32 m_nStrings;
HPMString const * m_pStrings;
} HPMStringEnum;
Members
m_nStrings
Number of string.
m_pStrings
List of strings.
See Also
HPMBoardCardPositionPair
Board card position struct.
struct HPMBoardCardPositionPair {
HPMUniqueID m_TaskID;
HPMFP64 m_Position;
} HPMBoardCardPositionPair;
Members
m_TaskID
The ID of the task.
m_Position
The position the card will have.
See Also
HPMBoardCardPositionPairEnum
List of board card position pairs.
struct HPMBoardCardPositionPairEnum {
HPMUInt32 m_nPairs;
HPMBoardCardPositionPair const * m_pPairs;
} HPMBoardCardPositionPairEnum;
Members
m_nPairs
Number of card position pairs.
m_pPairs
List of card position pairs.
See Also
HPMBoardCardFlagsPair
Board card flags struct.
struct HPMBoardCardFlagsPair {
HPMUniqueID m_TaskID;
HPMUInt32 m_Flags;
} HPMBoardCardFlagsPair;
Members
m_TaskID
The ID of the task.
m_Flags
The flags for the card.
See Also
HPMBoardCardFlagsPairEnum
List of board card flags pairs.
struct HPMBoardCardFlagsPairEnum {
HPMUInt32 m_nPairs;
HPMBoardCardFlagsPair const * m_pPairs;
} HPMBoardCardFlagsPairEnum;
Members
m_nPairs
Number of card position pairs.
m_pPairs
List of card position pairs.
See Also
HPMResourceGroupProperties
Used for specifying the properties of a resource group.
struct HPMResourceGroupProperties {
const HPMChar * m_pName;
const HPMChar * m_pSortName;
HPMUInt32 m_Flags;
HPMUniqueID m_ProjectID;
} HPMResourceGroupProperties;
Members
m_pName
The name of the resource group
m_pSortName
If set this name is used for sorting instead of the user group name.
m_Flags
Resource group flags. Can be any combination of EHPMResourceGroupFlag.
m_ProjectID
If set this is the id of the project the resource group is restricted to.
See Also
ResourceGroupCreate, ResourceGroupSetProperties, ResourceGroupGetProperties
HPMResourceGroupInfo
Used for creating/editing group in DB.
struct HPMResourceGroupInfo {
HPMInt32 m_GroupID;
HPMResourceGroupProperties m_Properties;
HPMUInt32 m_nResourceIDs;
const HPMUniqueID * m_pResourceIDs;
} HPMResourceGroupInfo;
Members
m_GroupID
Id of the group
m_Properties
Properties of the group
m_nResourceIDs
Number of resources in group
m_pResourceIDs
Pointer to a list of resources IDs in group
See Also
HPMGlobalSecurityOptions
Security options for user authentication
struct HPMGlobalSecurityOptions {
HPMInt32 m_bAllowUseTokenSystem;
HPMInt32 m_bAllowUseSSO;
HPMInt32 m_bSSORequired;
} HPMGlobalSecurityOptions;
Members
m_bAllowUseTokenSystem
. True if token system allowed on server.
m_bAllowUseSSO
. True if SSO authentication allowed on server.
m_bSSORequired
. True if SSO authentication required on server.
See Also
HPMLanguage
Defines a language.
struct HPMLanguage {
HPMUInt16 m_LanguageID;
const HPMChar * m_pCustomLanguageID;
} HPMLanguage;
Members
m_LanguageID
The identifier of the base language. A language ID corresponds to the locale IDs that have been assigned by Microsoft. The default language, English - United Kingdom, is e.g. 0x0809
m_pCustomLanguageID
The id of the custom language if the base language has been extended.
See Also
ResourceSetPreferredLanguage, ResourceGetPreferredLanguage, ResourceSetLastUsedLanguage, ResourceGetLastUsedLanguage, ResourceGetEffectiveLanguage
HPMLanguages
Used to define a list of languages.
struct HPMLanguages {
HPMUInt32 m_nLanguages;
const HPMLanguage * m_pLanguages;
} HPMLanguages;
Members
m_nLanguages
The number of languages available to this application
m_pLanguages
Pointer to a list of languages available to this application. See HPMLanguage.
See Also
HPMLanguage, LocalizationGetLanguages
HPMUntranslatedStringParamListEntry
Used to define an untranslated string.
struct HPMUntranslatedStringParamListEntry {
const HPMVariantData * m_pVariantData;
} HPMUntranslatedStringParamListEntry;
Members
m_pVariantData
A variant to specify the data. Use the VariantDecode_* and VariantEncode_* functions to manipulate this member. Valid types are HPMInt32, HPMUInt32, HPMInt64, HPMUInt64, HPMFP32, HPMFP64, HPMString, HPMUntranslatedString
HPMUntranslatedStringParamList
Used to define a number of parameters to an untranslated string.
struct HPMUntranslatedStringParamList {
HPMUInt32 m_nParams;
const HPMUntranslatedStringParamListEntry * m_pParams;
} HPMUntranslatedStringParamList;
Members
m_nParams
The number of frequency entries.
m_pParams
Pointer to a list of HPMUntranslatedStringParamListEntry that specifies parameters for a untranslated string.
See Also
LocalizationGetLanguages
Gets all the localisation languages that are available to the SDK application.
HPMError LocalizationGetLanguages (
    void * _pSession,
    const HPMLanguages * * _pLanguages
    );
Parameters
_pSession
[in] A connected session. See SessionOpen.
_pLanguages
[out] Pointer to a pointer of a HPMLanguages object, representing the returned data.
Return Value
Returns an error code. See EHPMError.
Comments
The returned object must be freed with ObjectFree or a memory leak will result.
See Also
HPMSdkFunctions, ObjectFree, HPMLanguages
LocalizationGetLanguageName
Gets the name of a localisation language.
HPMError LocalizationGetLanguageName (
    void * _pSession,
    const HPMLanguage * _pLanguage,
    const HPMString * * _pLanguageName
    );
Parameters
_pSession
[in] A connected session. See SessionOpen.
_pLanguage
[in] The language to get the name of.
_pLanguageName
[out] Pointer to a pointer of a HPMString object, representing the returned data.
Return Value
Returns an error code. See EHPMError.
Comments
The returned object must be freed with ObjectFree or a memory leak will result.
See Also
HPMSdkFunctions, ObjectFree, HPMLanguage
LocalizationTranslateString
Translates an untranslated string into readable format.
HPMError LocalizationTranslateString (
    void * _pSession,
    const HPMLanguage * _pLanguage,
    const HPMUntranslatedString * _pUntranslatedString,
    const HPMString * * _pTranslatedString
    );
Parameters
_pSession
[in] A connected session. See SessionOpen.
_pLanguage
[in] The language to translate the string into.
_pUntranslatedString
[in] The string to translate.
_pTranslatedString
[out] Pointer to a pointer of a HPMString object, representing the returned data.
Return Value
Returns an error code. See EHPMError.
Comments
The returned object must be freed with ObjectFree or a memory leak will result.
See Also
HPMSdkFunctions, ObjectFree, HPMLanguage, HPMUntranslatedString
LocalizationGetDefaultLanguage
Gets the default Helix Plan language. Currently this is UK English.
HPMError LocalizationGetDefaultLanguage (
    void * _pSession,
    const HPMLanguage * * _pLanguage
    );
Parameters
_pSession
[in] A connected session. See SessionOpen.
_pLanguage
[out] Pointer to a pointer of a HPMLanguage object, representing the returned data.
Return Value
Returns an error code. See EHPMError.
Comments
The returned object must be freed with ObjectFree or a memory leak will result.
See Also
HPMSdkFunctions, ObjectFree, HPMLanguage
LocalizationCreateUntranslatedStringFromString
Puts a normal string into an untranslated string. This string cannot not be translated into other languages later, but is the same for all languages.
HPMError LocalizationCreateUntranslatedStringFromString (
    void * _pSession,
    const HPMChar * _pString,
    const HPMUntranslatedString * * _pUntranslatedString
    );
Parameters
_pSession
[in] A connected session. See SessionOpen.
_pString
[in] The string to put in the untranslated string.
_pUntranslatedString
[out] Pointer to a pointer of a HPMUntranslatedString object, representing the returned data.
Return Value
Returns an error code. See EHPMError.
Comments
The returned object must be freed with ObjectFree or a memory leak will result.
See Also
HPMSdkFunctions, ObjectFree, HPMUntranslatedString
LocalizationCreateUntranslatedStringFromTranslationID
Puts a translation identifier into an untranslated string.
HPMError LocalizationCreateUntranslatedStringFromTranslationID (
    void * _pSession,
    HPMUInt32 _TranslationID,
    HPMUntranslatedStringParamList const * _pParams,
    const HPMUntranslatedString * * _pUntranslatedString
    );
Parameters
_pSession
[in] A connected session. See SessionOpen.
_TranslationID
[in] The translation ID to put into the untranslated string.
_pParams
[in] Specifies a number of paramaters that should be used as params to the untranslated string.
_pUntranslatedString
[out] Pointer to a pointer of a HPMUntranslatedString object, representing the returned data.
Return Value
Returns an error code. See EHPMError.
Comments
The returned object must be freed with ObjectFree or a memory leak will result.
See Also
HPMSdkFunctions, ObjectFree, HPMUntranslatedString, LocalizationGetTranslationIDFromFullTranslationID
LocalizationGetTranslationIDFromFullTranslationID
Converts a full translation ID into an translation ID.
HPMError LocalizationGetTranslationIDFromFullTranslationID (
    void * _pSession,
    const HPMChar * _pFullTranslationID,
    HPMUInt32 * _pTranslationID
    );
Parameters
_pSession
[in] A connected session. See SessionOpen.
_pFullTranslationID
[in] The string identifying the full translation ID.
_pTranslationID
[out] Pointer to a variable representing the returned data.
Return Value
Returns an error code. See EHPMError.
Comments
A full translation ID is a string that uniquely identifies a translation element in the translation. A translation ID is a hash of this string that is used internally to store translation IDs.
See Also
HPMSdkFunctions, ObjectFree, HPMUntranslatedString
EHPMDashboardPageLayoutType
Layout type used for HPMDashboardPageLayout::m_Type.
enum EHPMDashboardPageLayoutType {
EHPMDashboardPageLayoutType_NewVersionOfSDKRequired = 0,
EHPMDashboardPageLayoutType_SingleColumn = 1,
EHPMDashboardPageLayoutType_TwoColumns = 2,
EHPMDashboardPageLayoutType_ThreeColumns = 3,
EHPMDashboardPageLayoutType_FourColumns = 4,
EHPMDashboardPageLayoutType_Highway = 5,
EHPMDashboardPageLayoutType_CenterLane = 6,
EHPMDashboardPageLayoutType_Sidewalk = 7,
};
Values
EHPMDashboardPageLayoutType_NewVersionOfSDKRequired
The value did not exist when this SDK was created. Upgrade to a newer version of the SDK to be able to use this type.
EHPMDashboardPageLayoutType_SingleColumn
Single column layout.
EHPMDashboardPageLayoutType_TwoColumns
Two column layout.
EHPMDashboardPageLayoutType_ThreeColumns
Three column layout.
EHPMDashboardPageLayoutType_FourColumns
Four column layout.
EHPMDashboardPageLayoutType_Highway
Four column layout (20%,30%,30%,20%).
EHPMDashboardPageLayoutType_CenterLane
Three column layout (30%,40%,30%).
EHPMDashboardPageLayoutType_Sidewalk
Two column layout (40%,60%).
See Also
EHPMDashboardChartResultDataType
Data type used for HPMDashboardChartResultSetElementInfo::m_Type.
enum EHPMDashboardChartResultDataType {
EHPMDashboardChartResultDataType_NewVersionOfSDKRequired = 0,
EHPMDashboardChartResultDataType_HPMString = 1,
EHPMDashboardChartResultDataType_HPMFP64 = 2,
EHPMDashboardChartResultDataType_HPMUInt64 = 3,
EHPMDashboardChartResultDataType_Binary = 4,
};
Values
EHPMDashboardChartResultDataType_NewVersionOfSDKRequired
The value did not exist when this SDK was created. Upgrade to a newer version of the SDK to be able to use this type.
EHPMDashboardChartResultDataType_HPMString
The result data is of the type string.
EHPMDashboardChartResultDataType_HPMFP64
The result data is of the type float.
EHPMDashboardChartResultDataType_HPMUInt64
The result data is of the type integer.
EHPMDashboardChartResultDataType_Binary
The result data is of the type binary.
See Also
HPMDashboardChartResultSetElementInfo
EHPMDashboardChartResultDataSubType
Sub data type used for HPMDashboardChartResultSetElementInfo::m_SubType.
enum EHPMDashboardChartResultDataSubType {
EHPMDashboardChartResultDataSubType_NewVersionOfSDKRequired = 0,
EHPMDashboardChartResultDataSubType_None = 1,
EHPMDashboardChartResultDataSubType_Normal = 2,
EHPMDashboardChartResultDataSubType_Time = 3,
EHPMDashboardChartResultDataSubType_RowIndex = 4,
EHPMDashboardChartResultDataSubType_UntranslatedString = 5,
};
Values
EHPMDashboardChartResultDataSubType_NewVersionOfSDKRequired
The value did not exist when this SDK was created. Upgrade to a newer version of the SDK to be able to use this type.
EHPMDashboardChartResultDataSubType_None
No sub type.
EHPMDashboardChartResultDataSubType_Normal
Interpret the value as a plain value of the data type.
EHPMDashboardChartResultDataSubType_Time
Interpret the value as a time value.
EHPMDashboardChartResultDataSubType_RowIndex
Interpret the value as a row index.
EHPMDashboardChartResultDataSubType_UntranslatedString
Interpret the value as a untranslated string.
See Also
HPMDashboardChartResultSetElementInfo
EHPMDashboardChartType
Chart types used for HPMDashboardChartPresentationConfig::m_Type.
enum EHPMDashboardChartType {
EHPMDashboardChartType_NewVersionOfSDKRequired = 0,
EHPMDashboardChartType_Bar = 1,
EHPMDashboardChartType_Pie = 2,
EHPMDashboardChartType_Line = 3,
EHPMDashboardChartType_Area = 4,
EHPMDashboardChartType_XY = 5,
EHPMDashboardChartType_Gauge = 6,
EHPMDashboardChartType_Table = 7,
EHPMDashboardChartType_ItemView = 8,
};
Values
EHPMDashboardChartType_NewVersionOfSDKRequired
The value did not exist when this SDK was created. Upgrade to a newer version of the SDK to be able to use this type.
EHPMDashboardChartType_Bar
Bar chart type.
EHPMDashboardChartType_Pie
Pie chart type.
EHPMDashboardChartType_Line
Line chart type.
EHPMDashboardChartType_Area
Area chart type.
EHPMDashboardChartType_XY
XY chart type.
EHPMDashboardChartType_Gauge
Gauge chart type.
EHPMDashboardChartType_Table
Table chart type.
EHPMDashboardChartType_ItemView
Item view chart type.
See Also
HPMDashboardChartPresentationConfig
EHPMDashboardChartOrientation
Chart orientation used for HPMDashboardChartResultSetElementInfo::m_Orientation.
enum EHPMDashboardChartOrientation {
EHPMDashboardChartOrientation_NewVersionOfSDKRequired = 0,
EHPMDashboardChartOrientation_Vertical = 1,
EHPMDashboardChartOrientation_Horizontal = 2,
};
Values
EHPMDashboardChartOrientation_NewVersionOfSDKRequired
The value did not exist when this SDK was created. Upgrade to a newer version of the SDK to be able to use this type.
EHPMDashboardChartOrientation_Vertical
Vertical orientation.
EHPMDashboardChartOrientation_Horizontal
Horizontal orientation.
See Also
HPMDashboardChartPresentationConfig
EHPMDashboardChartLegend
Legend settings used for HPMDashboardChartResultSetElementInfo::m_Legend.
enum EHPMDashboardChartLegend {
EHPMDashboardChartLegend_NewVersionOfSDKRequired = 0,
EHPMDashboardChartLegend_NotVisible = 1,
EHPMDashboardChartLegend_Visible = 2,
};
Values
EHPMDashboardChartLegend_NewVersionOfSDKRequired
The value did not exist when this SDK was created. Upgrade to a newer version of the SDK to be able to use this type.
EHPMDashboardChartLegend_NotVisible
Legend not visible.
EHPMDashboardChartLegend_Visible
Legend visible.
See Also
HPMDashboardChartPresentationConfig
EHPMDashboardChartLabel
Label settings used for HPMDashboardChartPresentationConfig::m_Label.
enum EHPMDashboardChartLabel {
EHPMDashboardChartLabel_NewVersionOfSDKRequired = 0,
EHPMDashboardChartLabel_NotVisible = 1,
EHPMDashboardChartLabel_Name = 2,
EHPMDashboardChartLabel_Value = 3,
EHPMDashboardChartLabel_Percentage = 4,
EHPMDashboardChartLabel_NameAndValue = 5,
EHPMDashboardChartLabel_NameAndPercentage = 6,
};
Values
EHPMDashboardChartLabel_NewVersionOfSDKRequired
The value did not exist when this SDK was created. Upgrade to a newer version of the SDK to be able to use this type.
EHPMDashboardChartLabel_NotVisible
Label not visible.
EHPMDashboardChartLabel_Name
Label displays name.
EHPMDashboardChartLabel_Value
Label displays value.
EHPMDashboardChartLabel_Percentage
Label displays percentage.
EHPMDashboardChartLabel_NameAndValue
Label displays name and value.
EHPMDashboardChartLabel_NameAndPercentage
Label displays name and percentage.
See Also
HPMDashboardChartPresentationConfig
EHPMDashboardChartGrouping
Grouping settings used for HPMDashboardChartPresentationConfig::m_Grouping.
enum EHPMDashboardChartGrouping {
EHPMDashboardChartGrouping_NewVersionOfSDKRequired = 0,
EHPMDashboardChartGrouping_None = 1,
EHPMDashboardChartGrouping_Stack = 2,
EHPMDashboardChartGrouping_StackPercentage = 3,
};
Values
EHPMDashboardChartGrouping_NewVersionOfSDKRequired
The value did not exist when this SDK was created. Upgrade to a newer version of the SDK to be able to use this type.
EHPMDashboardChartGrouping_None
No grouping.
EHPMDashboardChartGrouping_Stack
Stacked grouping.
EHPMDashboardChartGrouping_StackPercentage
Stacked percentage grouping.
See Also
HPMDashboardChartPresentationConfig
EHPMDashboardChartStatusVisibility
Status settings used for HPMDashboardChartPresentationConfig::m_StatusVisibility.
enum EHPMDashboardChartStatusVisibility {
EHPMDashboardChartStatusVisibility_NewVersionOfSDKRequired = 0,
EHPMDashboardChartStatusVisibility_NotVisible = 1,
EHPMDashboardChartStatusVisibility_Visible = 2,
};
Values
EHPMDashboardChartStatusVisibility_NewVersionOfSDKRequired
The value did not exist when this SDK was created. Upgrade to a newer version of the SDK to be able to use this type.
EHPMDashboardChartStatusVisibility_NotVisible
Status not visible.
EHPMDashboardChartStatusVisibility_Visible
Status visible.
See Also
HPMDashboardChartPresentationConfig
EHPMDashboardChartPresentationSettingEnabled
Enabled settings in HPMDashboardChartPresentationConfig, used for HPMDashboardChartPresentationConfig::m_Enabled
enum EHPMDashboardChartPresentationSettingEnabled {
EHPMDashboardChartPresentationSettingEnabled_None = 0,
EHPMDashboardChartPresentationSettingEnabled_Type = 1,
EHPMDashboardChartPresentationSettingEnabled_Legend = 2,
EHPMDashboardChartPresentationSettingEnabled_Labels = 4,
EHPMDashboardChartPresentationSettingEnabled_Grouping = 8,
EHPMDashboardChartPresentationSettingEnabled_Orientation = 16,
EHPMDashboardChartPresentationSettingEnabled_Bounds = 32,
EHPMDashboardChartPresentationSettingEnabled_IdealBurndown = 64,
EHPMDashboardChartPresentationSettingEnabled_AxisScaling = 128,
EHPMDashboardChartPresentationSettingEnabled_StatusVisibility = 256,
};
Values
EHPMDashboardChartPresentationSettingEnabled_None
No settings
EHPMDashboardChartPresentationSettingEnabled_Type
Type setting is enabled
EHPMDashboardChartPresentationSettingEnabled_Legend
Legend setting is enabled
EHPMDashboardChartPresentationSettingEnabled_Labels
Labels setting is enabled
EHPMDashboardChartPresentationSettingEnabled_Grouping
Grouping setting is enabled
EHPMDashboardChartPresentationSettingEnabled_Orientation
Orientation setting is enabled
EHPMDashboardChartPresentationSettingEnabled_Bounds
Bounds setting is enabled
EHPMDashboardChartPresentationSettingEnabled_IdealBurndown
Ideal burndown setting is enabled
EHPMDashboardChartPresentationSettingEnabled_AxisScaling
Axis scaling setting is enabled
EHPMDashboardChartPresentationSettingEnabled_StatusVisibility
Chart status visibility setting is enabled
See Also
HPMDashboardChartPresentationConfig
EHPMDashboardChartPresentationIdealBurndownFlags
Flags for HPMDashboardChartIdealBurndown, used for HPMDashboardChartIdealBurndown::m_Flags
enum EHPMDashboardChartPresentationIdealBurndownFlags {
EHPMDashboardChartPresentationIdealBurndownFlags_None = 0,
EHPMDashboardChartPresentationIdealBurndownFlags_Enabled = 1,
EHPMDashboardChartPresentationIdealBurndownFlags_OverrideValue = 2,
EHPMDashboardChartPresentationIdealBurndownFlags_OverrideUnit = 4,
};
Values
EHPMDashboardChartPresentationIdealBurndownFlags_None
No settings
EHPMDashboardChartPresentationIdealBurndownFlags_Enabled
Ideal burndown is enabled
EHPMDashboardChartPresentationIdealBurndownFlags_OverrideValue
Starting value override is enabled
EHPMDashboardChartPresentationIdealBurndownFlags_OverrideUnit
Starting unit override is enabled
See Also
HPMDashboardChartIdealBurndown
EHPMDashboardChartPresentationAxisScalingFlags
Flags for HPMDashboardChartIdealBurndown, used for HPMDashboardChartIdealBurndown::m_Flags
enum EHPMDashboardChartPresentationAxisScalingFlags {
EHPMDashboardChartPresentationAxisScalingFlags_None = 0,
EHPMDashboardChartPresentationAxisScalingFlags_Enabled = 1,
EHPMDashboardChartPresentationAxisScalingFlags_YMaxValue = 2,
EHPMDashboardChartPresentationAxisScalingFlags_YMinValue = 4,
};
Values
EHPMDashboardChartPresentationAxisScalingFlags_None
No settings
EHPMDashboardChartPresentationAxisScalingFlags_Enabled
Ideal burndown is enabled
EHPMDashboardChartPresentationAxisScalingFlags_YMaxValue
Starting value override is enabled
EHPMDashboardChartPresentationAxisScalingFlags_YMinValue
Starting unit override is enabled
See Also
HPMDashboardChartIdealBurndown
HPMDashboardPageLayoutChart
Used to store information about a chart in a page layout.
struct HPMDashboardPageLayoutChart {
HPMUniqueID m_ChartID;
} HPMDashboardPageLayoutChart;
Members
m_ChartID
The unique id of the chart that this layout entry is for.
See Also
DashboardPageGetLayout, DashboardPageSetLayout
HPMDashboardPageLayoutColumn
Used to store information about a column in a page layout
struct HPMDashboardPageLayoutColumn {
HPMUInt32 m_nCharts;
HPMDashboardPageLayoutChart const * m_pCharts;
} HPMDashboardPageLayoutColumn;
Members
m_nCharts
Number of charts in the column.
m_pCharts
Pointer to a list of charts in the column. See HPMDashboardPageLayoutChart.
See Also
DashboardPageGetLayout, DashboardPageSetLayout
HPMDashboardPageLayout
Used to store information about a page layout
struct HPMDashboardPageLayout {
HPMUInt32 m_Type;
HPMUInt32 m_nColumns;
HPMDashboardPageLayoutColumn const * m_pColumns;
} HPMDashboardPageLayout;
Members
m_Type
. The type of the layout. Can be one of EHPMDashboardPageLayoutType.
m_nColumns
The number of columns in the layout.
m_pColumns
Pointer to a list of columns in the layout. See HPMDashboardPageLayoutColumn.
See Also
DashboardPageGetLayout, DashboardPageSetLayout
HPMDashboardChartResultSetInfo
Data info for a chart.
struct HPMDashboardChartResultSetInfo {
HPMUInt32 m_ForecastingStart;
} HPMDashboardChartResultSetInfo;
Members
m_ForecastingStart
Forecasting start index
See Also
HPMDashboardChartBounds
Boundary values for a chart. Currently used if HPMDashboardChartPresentationConfig::m_Type is EHPMDashboardChartType_Gauge.
struct HPMDashboardChartBounds {
HPMFP64 m_Lower;
HPMFP64 m_Upper;
} HPMDashboardChartBounds;
Members
m_Lower
The lower bound of the chart.
m_Upper
The upper bound of the chart.
See Also
HPMDashboardChartPresentationConfig
HPMDashboardChartIdealBurndown
Ideal burndown settings. Only used if HPMDashboardChartPresentationConfig::m_Type is EHPMDashboardChartType_Line or EHPMDashboardChartType_Area.
struct HPMDashboardChartIdealBurndown {
HPMUInt32 m_Flags;
HPMFP64 m_StartValue;
HPMUInt32 m_StartUnit;
} HPMDashboardChartIdealBurndown;
Members
m_Flags
. Bit field controlling the ideal burndown line. Can be any combination of EHPMDashboardChartPresentationIdealBurndownFlags.
m_StartValue
The starting value of the ideal burndown line. Only used if start value override flag is set.
m_StartUnit
The starting unit (day, week etc) of the ideal burndown line. Only used if start unit override flag is set.
See Also
HPMDashboardChartPresentationConfig
HPMDashboardAxisScaling
Axis scaling settings. Only used if HPMDashboardChartPresentationConfig::m_Type is EHPMDashboardChartType_Line or EHPMDashboardChartType_Area or EHPMDashboardChartType_Bar.
struct HPMDashboardAxisScaling {
HPMUInt32 m_Flags;
HPMFP64 m_YMaxValue;
HPMFP64 m_YMinValue;
} HPMDashboardAxisScaling;
Members
m_Flags
. Bit field controlling the axis scaling. Can be any combination of EHPMDashboardChartPresentationAxisScalingFlags.
m_YMaxValue
The maximum value of the vertical axis. Only used if y max value override flag is set.
m_YMinValue
The minimum value of the vertical axis. Only used if y min override flag is set.
See Also
HPMDashboardChartPresentationConfig
HPMDashboardChartPresentationConfig
Presentation config for a chart.
struct HPMDashboardChartPresentationConfig {
HPMUInt32 m_Enabled;
HPMUInt32 m_Type;
HPMUInt32 m_Legend;
HPMUInt32 m_Labels;
HPMUInt32 m_Grouping;
HPMUInt32 m_Orientation;
HPMDashboardChartBounds m_Bounds;
HPMDashboardChartIdealBurndown m_IdealBurndown;
HPMChar const * m_pTheme;
HPMDashboardAxisScaling m_AxisScaling;
HPMUInt32 m_StatusVisibility;
} HPMDashboardChartPresentationConfig;
Members
m_Enabled
. Bit field showing what presentation configuration values are set. Can be any combination of EHPMDashboardChartPresentationSettingEnabled.
m_Type
. The type of the chart. Can be one of EHPMDashboardChartType.
m_Legend
. The legend settings of the chart. Can be one of EHPMDashboardChartLegend.
m_Labels
. The label settings of the chart. Can be one of EHPMDashboardChartLabel.
m_Grouping
. The grouping settings of the chart. Can be one of EHPMDashboardChartGrouping.
m_Orientation
. The orientation sttings of the chart. Can be one of EHPMDashboardChartOrientation.
m_Bounds
The bounds of the chart. See HPMDashboardChartBounds.
m_IdealBurndown
The ideal burndown. See HPMDashboardChartIdealBurndown.
m_pTheme
The current theme of the chart.
m_AxisScaling
Axis scaling. See HPMDashboardAxisScaling.
m_StatusVisibility
. The status visibility setting of the chart. Can be one of EHPMDashboardChartStatusVisibility.
See Also
HPMDashboardChartSubscription
Used to keep a reference to a chart subscription.
struct HPMDashboardChartSubscription {
HPMUniqueID m_ChartID;
HPMInt32 m_Dummy;
} HPMDashboardChartSubscription;
Members
m_ChartID
The unique id of the chart that this subscription is for.
m_Dummy
Unused dummy member
See Also
HPMDashboardChartResultSetValue
Row data value for a dimension or a measure. If HPMDashboardChartResultSetElementInfo::m_Type is
EHPMDashboardChartResultDataType_HPMString
EHPMDashboardChartResultDataType_HPMFP64
Use VariantDecode_HPMFP64. If the decoded value is infinity this indicates a null value.
EHPMDashboardChartResultDataType_HPMUInt64
EHPMDashboardChartResultDataType_Binary
Use VariantDecode_HPMBinaryBuffer. If HPMDashboardChartResultSetElementInfo::m_SubType is EHPMDashboardChartResultDataSubType_UntranslatedString and HPMDashboardChartResultSetElementInfo::m_Type is
EHPMDashboardChartResultDataType_Binary
Use VariantDecode_HPMUntranslatedString.
struct HPMDashboardChartResultSetValue {
HPMUInt32 m_Index;
HPMVariantData const * m_pVariantData;
HPMUInt32 m_KeyIndex;
} HPMDashboardChartResultSetValue;
Members
m_Index
The index of the dimension or measure row data.
m_pVariantData
A variant to specify the data. Use the VariantDecode_* and VariantEncode_* functions to manipulate this member. Valid types are HPMUInt64, HPMFP64, HPMString, HPMUntranslatedString and HPMBinaryBuffer
m_KeyIndex
The index of the dimension or measure key part.
See Also
HPMDashboardChartResultSetRow
Chart row data for a dimension or measure.
struct HPMDashboardChartResultSetRow {
HPMUInt32 m_nValues;
HPMDashboardChartResultSetValue const * m_pValues;
} HPMDashboardChartResultSetRow;
Members
m_nValues
The number of values.
m_pValues
Pointer to a list of HPMDashboardChartResultSetValue that specifies the data values for the row.
See Also
HPMDashboardChartResultSetValue
HPMDashboardChartResultSetElementInfo
Data info for a dimension or measure. |
struct HPMDashboardChartResultSetElementInfo {
HPMUInt32 m_Type;
HPMUInt32 m_SubType;
HPMUInt32 m_Index;
HPMFP64 m_ValueLimitLower;
HPMFP64 m_ValueLimitUpper;
HPMUntranslatedString const * m_pName;
} HPMDashboardChartResultSetElementInfo;
Members
m_Type
. The type of the dimension. Can be one of EHPMDashboardChartResultDataType.
m_SubType
. The sub type of the dimension. Can be one of EHPMDashboardChartResultDataSubType.
m_Index
The index of the dimension or measure.
m_ValueLimitLower
Lowe value limit. The value will be infinity to indicate that no limit is set.
m_ValueLimitUpper
Upper value limit. The value will be infinity to indicate that no limit is set.
m_pName
The name of the dimension or measure.
See Also
HPMDashboardChartResultSetDimensions
HPMDashboardChartResultSetMeasures
Dimension data for a dashboard chart.
struct HPMDashboardChartResultSetMeasures {
HPMUInt32 m_nMeasureInfos;
HPMDashboardChartResultSetElementInfo const * m_pMeasureInfos;
HPMUInt32 m_nRows;
HPMDashboardChartResultSetRow const * m_pRows;
} HPMDashboardChartResultSetMeasures;
Members
m_nMeasureInfos
The number of HPMDashboardChartResultSetElementInfo.
m_pMeasureInfos
Pointer to a list of HPMDashboardChartResultSetElementInfo that specifies the data info for the measures.
m_nRows
The number of rows.
m_pRows
Pointer to a HPMDashboardChartResultSetRow of strings contains the measure row data.
See Also
HPMDashboardChartResultSetElementInfo, HPMDashboardChartResultSetRow
HPMDashboardChartResultSetDimensions
Dimension data for a dashboard chart.
struct HPMDashboardChartResultSetDimensions {
HPMUInt32 m_nDimensionInfos;
HPMDashboardChartResultSetElementInfo const * m_pDimensionInfos;
HPMUInt32 m_nRows;
HPMDashboardChartResultSetRow const * m_pRows;
} HPMDashboardChartResultSetDimensions;
Members
m_nDimensionInfos
The number of HPMDashboardChartResultSetElementInfo.
m_pDimensionInfos
Pointer to a list of HPMDashboardChartResultSetElementInfo that specifies the data info for the dimensions.
m_nRows
The number of rows.
m_pRows
Pointer to a HPMDashboardChartResultSetRow of strings contains the dimension row data.
See Also
HPMDashboardChartResultSetElementInfo, HPMDashboardChartResultSetRow
HPMDashboardTaskIDs
Task identifiers for chart with EHPMDashboardChartType_ItemView type
struct HPMDashboardTaskIDs {
HPMUInt32 m_nTasks;
HPMUniqueID const * m_pTasks;
} HPMDashboardTaskIDs;
Members
m_nTasks
Number of tasks.
m_pTasks
List of unique task IDs.
See Also
HPMDashboardChartResultSet
Dashboard chart result set.
struct HPMDashboardChartResultSet {
HPMDashboardChartResultSetInfo m_Info;
HPMDashboardChartPresentationConfig m_Config;
HPMDashboardChartResultSetDimensions m_Dimensions;
HPMDashboardChartResultSetMeasures m_Measures;
HPMDashboardTaskIDs m_TasksIds;
} HPMDashboardChartResultSet;
Members
m_Info
Chart info for the chart.
m_Config
Presentation config for the chart.
m_Dimensions
The dimensions for the chart.
m_Measures
The measures for the chart.
m_TasksIds
Task IDs. Filled when HPMDashboardChartPresentationConfig::m_Type is EHPMDashboardChartType_ItemView.
See Also
HPMDashboardChartResultSetDimensions, HPMDashboardChartResultSetMeasures
HPMDashboardChartDataIdentifier
Data identifier that stores different id's depending on the usage. See the documentation where it is used.
struct HPMDashboardChartDataIdentifier {
HPMInt32 m_ID;
HPMInt32 m_IDData;
HPMUniqueID m_ContainerID;
} HPMDashboardChartDataIdentifier;
Members
m_ID
Id 1. Can be EHPMDashboardChartFilterProjectType, report id, EHPMProjectDefaultColumn or task reference id.
m_IDData
Id 2. Can be resource id or id data for column.
m_ContainerID
Container id. Can be project id.
See Also
HPMDashboardChartLimitByDataIdentifiers, HPMDashboardChartFilter, HPMDashboardChartMeasure, HPMDashboardChartDimension
EHPMDashboardChartLimitType
Limit type.
enum EHPMDashboardChartLimitType {
EHPMDashboardChartLimitType_NewVersionOfSDKRequired = 0,
EHPMDashboardChartLimitType_Identifiers = 1,
EHPMDashboardChartLimitType_Time = 2,
EHPMDashboardChartLimitType_NumericValue = 3,
};
Values
EHPMDashboardChartLimitType_NewVersionOfSDKRequired
The value did not exist when this SDK was created. Upgrade to a newer version of the SDK to be able to use this type.
EHPMDashboardChartLimitType_Identifiers
Limit by identifiers.
EHPMDashboardChartLimitType_Time
Limit by time.
EHPMDashboardChartLimitType_NumericValue
Limit by numeric value.
See Also
HPMDashboardChartLimit, HPMDashboardChartMeasure and HPMDashboardChartForecastingConfig HPMDashboardChartDimension
HPMDashboardChartLimitTime
Time limits
struct HPMDashboardChartLimitTime {
HPMUInt64 m_Start;
HPMUInt64 m_End;
} HPMDashboardChartLimitTime;
Members
m_Start
The start time expressed as micro seconds since 1970 UTC.
m_End
The end time expressed as micro seconds since 1970 UTC.
See Also
HPMDashboardChartLimitNumericValue
Numerical value limit
struct HPMDashboardChartLimitNumericValue {
HPMInt32 m_NumericValue;
} HPMDashboardChartLimitNumericValue;
Members
m_NumericValue
Numverical value limit
See Also
HPMDashboardChartLimitByDataIdentifiers
Data identifier limits
struct HPMDashboardChartLimitByDataIdentifiers {
HPMUInt32 m_nIdentifiers;
HPMDashboardChartDataIdentifier const * m_pIdentifiers;
} HPMDashboardChartLimitByDataIdentifiers;
Members
m_nIdentifiers
Number of identifiers in m_pIdentifiers
m_pIdentifiers
Indentifier limits
See Also
HPMDashboardChartLimit
Chart limits, used to limit or filter the chart configuration.
struct HPMDashboardChartLimit {
HPMUInt32 m_LimitType;
HPMDashboardChartLimitByDataIdentifiers m_LimitByDataIdentifiers;
HPMDashboardChartLimitTime m_LimitByTime;
HPMDashboardChartLimitNumericValue m_LimitByNumericValue;
} HPMDashboardChartLimit;
Members
m_LimitType
The type for this limit. See EHPMDashboardChartLimitType
m_LimitByDataIdentifiers
Only valid if m_LimitType is set to EHPMDashboardChartLimitType_Identifiers
m_LimitByTime
Only valid if m_LimitType is set to EHPMDashboardChartLimitType_Time
m_LimitByNumericValue
Only valid if m_LimitType is set to EHPMDashboardChartLimitType_NumericValue
See Also
HPMDashboardChartForecastingConfig HPMDashboardChartDimension HPMDashboardChartMeasure
EHPMDashboardChartSortDirection
Sort order, used for HPMDashboardChartItemViewConfig::m_SortDirection.
enum EHPMDashboardChartSortDirection {
EHPMDashboardChartSortDirection_NewVersionOfSDKRequired = 0,
EHPMDashboardChartSortDirection_Ascending = 1,
EHPMDashboardChartSortDirection_Descending = 2,
};
Values
EHPMDashboardChartSortDirection_NewVersionOfSDKRequired
The value did not exist when this SDK was created. Upgrade to a newer version of the SDK to be able to use this type.
EHPMDashboardChartSortDirection_Ascending
Ascending order
EHPMDashboardChartSortDirection_Descending
Descending order
See Also
HPMDashboardChartItemViewConfig
HPMDashboardChartItemViewConfig
Chart item view configuration, used for HPMDashboardChartComputationConfig::m_ItemViewConfig.
struct HPMDashboardChartItemViewConfig {
HPMUInt32 m_nVisibleColumns;
HPMColumn const * m_pVisibleColumns;
HPMColumn m_SortingColumn;
HPMUInt32 m_SortDirection;
} HPMDashboardChartItemViewConfig;
Members
m_nVisibleColumns
Number of visible columns
m_pVisibleColumns
Visible column list
m_SortingColumn
Sorting column
m_SortDirection
. Direction to use for sorting column.
See Also
HPMDashboardChartComputationConfig
EHPMDashboardChartFilterCategory
Chart filter category, used for HPMDashboardChartFilter::m_Category.
enum EHPMDashboardChartFilterCategory {
EHPMDashboardChartFilterCategory_NewVersionOfSDKRequired = 0,
EHPMDashboardChartFilterCategory_None = 1,
EHPMDashboardChartFilterCategory_Project = 2,
EHPMDashboardChartFilterCategory_Report = 3,
};
Values
EHPMDashboardChartFilterCategory_NewVersionOfSDKRequired
The value did not exist when this SDK was created. Upgrade to a newer version of the SDK to be able to use this type.
EHPMDashboardChartFilterCategory_None
No filter category.
EHPMDashboardChartFilterCategory_Project
Project filter.
EHPMDashboardChartFilterCategory_Report
Report filter.
See Also
EHPMDashboardChartFilterProjectType
Chart project type filter
enum EHPMDashboardChartFilterProjectType {
EHPMDashboardChartFilterProjectType_NewVersionOfSDKRequired = 0,
EHPMDashboardChartFilterProjectType_AllItems = 1,
EHPMDashboardChartFilterProjectType_Planning = 2,
EHPMDashboardChartFilterProjectType_Backlog = 3,
EHPMDashboardChartFilterProjectType_QA = 4,
};
Values
EHPMDashboardChartFilterProjectType_NewVersionOfSDKRequired
The value did not exist when this SDK was created. Upgrade to a newer version of the SDK to be able to use this type.
EHPMDashboardChartFilterProjectType_AllItems
Filter all project item types.
EHPMDashboardChartFilterProjectType_Planning
Filter planning view items.
EHPMDashboardChartFilterProjectType_Backlog
Filter backlog items.
EHPMDashboardChartFilterProjectType_QA
Filter QA items.
See Also
HPMDashboardChartFilter
Chart filter configuration.
struct HPMDashboardChartFilter {
HPMUInt32 m_Category;
HPMDashboardChartDataIdentifier m_Identifier;
HPMReport m_CompleteReport;
} HPMDashboardChartFilter;
Members
m_Category
. Filter category.
m_Identifier
Data identifier to filter. EHPMDashboardChartFilterCategory_Project: m_ContainerID = ProjectID, m_ID = EHPMDashboardChartFilterProjectType, // EHPMDashboardChartFilterCategory_Report: m_IDData = UserID, m_ContainerID = ProjectID, m_ID = ReportID
m_CompleteReport
Only valid for historic configs and when m_Category is set to EHPMDashboardChartFilterCategory_Report
See Also
HPMDashboardChartMeasure HPMDashboardChartComputationConfig DashboardUtilGetFilterAutoName DashboardUtilIsFilterValidForResource DashboardUtilIsComputationConfigValidForResource
EHPMDashboardChartForcastingDateRange
Chart forecasting date settings, used for HPMDashboardChartForecastingConfig::m_DateRange in connection with HPMDashboardChartForecastingConfig::m_DateLimit
enum EHPMDashboardChartForcastingDateRange {
EHPMDashboardChartForcastingDateRange_NewVersionOfSDKRequired = 0,
EHPMDashboardChartForcastingDateRange_None = 1,
EHPMDashboardChartForcastingDateRange_UntilDate = 2,
EHPMDashboardChartForcastingDateRange_UntilNextXDays = 3,
EHPMDashboardChartForcastingDateRange_UntilNextXWeeks = 4,
EHPMDashboardChartForcastingDateRange_UntilNextXMonths = 5,
EHPMDashboardChartForcastingDateRange_UntilNextXQuarters = 6,
EHPMDashboardChartForcastingDateRange_UntilNextXYears = 7,
};
Values
EHPMDashboardChartForcastingDateRange_NewVersionOfSDKRequired
The value did not exist when this SDK was created. Upgrade to a newer version of the SDK to be able to use this type.
EHPMDashboardChartForcastingDateRange_None
No forecasting date set.
EHPMDashboardChartForcastingDateRange_UntilDate
Forecast until set date.
EHPMDashboardChartForcastingDateRange_UntilNextXDays
Forecast next X days.
EHPMDashboardChartForcastingDateRange_UntilNextXWeeks
Forecast next X weeks.
EHPMDashboardChartForcastingDateRange_UntilNextXMonths
Forecast next X monts.
EHPMDashboardChartForcastingDateRange_UntilNextXQuarters
Forecast next X quarters.
EHPMDashboardChartForcastingDateRange_UntilNextXYears
Forecast next X years.
See Also
HPMDashboardChartForecastingConfig HPMDashboardChartLimitTime
EHPMDashboardChartForcastingVelocityMethod
Velocity method to use for forecasting, used for HPMDashboardChartForecastingConfig::m_VelocityMethod.
enum EHPMDashboardChartForcastingVelocityMethod {
EHPMDashboardChartForcastingVelocityMethod_NewVersionOfSDKRequired = 0,
EHPMDashboardChartForcastingVelocityMethod_None = 1,
EHPMDashboardChartForcastingVelocityMethod_WeightedAverage = 2,
EHPMDashboardChartForcastingVelocityMethod_Custom = 3,
};
Values
EHPMDashboardChartForcastingVelocityMethod_NewVersionOfSDKRequired
The value did not exist when this SDK was created. Upgrade to a newer version of the SDK to be able to use this type.
EHPMDashboardChartForcastingVelocityMethod_None
No forecasting velocity
EHPMDashboardChartForcastingVelocityMethod_WeightedAverage
Weighted average
EHPMDashboardChartForcastingVelocityMethod_Custom
Custom velocity from m_VelocityValue.
See Also
HPMDashboardChartForecastingConfig
HPMDashboardChartForecastingConfig
Chart forecasting configuration, used for HPMDashboardChartDimension::m_Forecasting, only used for time dimensions.
struct HPMDashboardChartForecastingConfig {
HPMUInt32 m_DateRange;
HPMDashboardChartLimit m_Limit;
HPMUInt32 m_VelocityMethod;
HPMFP32 m_VelocityMethodValue;
} HPMDashboardChartForecastingConfig;
Members
m_DateRange
The date range for the forecast. Can be one of EHPMDashboardChartForcastingDateRange.
m_Limit
Limits for forecast. Only EHPMDashboardChartLimitType_NumericValue and EHPMDashboardChartLimitType_Time valid here
m_VelocityMethod
Velocity for forecast. Can be one of EHPMDashboardChartForcastingVelocityMethod.
m_VelocityMethodValue
The velocity method value. If m_VelocityMethod is EHPMDashboardChartForcastingVelocityMethod_WeightedAverage the value is the number of days, decimals ignored, if it is EHPMDashboardChartForcastingVelocityMethod_Custom it is the true velocity value.
See Also
EHPMDashboardChartDimensionCategory
Chart dimension category, used for HPMDashboardChartDimension::m_Category.
enum EHPMDashboardChartDimensionCategory {
EHPMDashboardChartDimensionCategory_NewVersionOfSDKRequired = 0,
EHPMDashboardChartDimensionCategory_None = 1,
EHPMDashboardChartDimensionCategory_HistoricalData = 2,
EHPMDashboardChartDimensionCategory_ProjectColumnData = 3,
EHPMDashboardChartDimensionCategory_PipelinesKanbansAndWorkflows = 4,
EHPMDashboardChartDimensionCategory_Releases = 5,
EHPMDashboardChartDimensionCategory_Sprints = 6,
EHPMDashboardChartDimensionCategory_Users = 7,
EHPMDashboardChartDimensionCategory_Groups = 8,
EHPMDashboardChartDimensionCategory_Projects = 9,
};
Values
EHPMDashboardChartDimensionCategory_NewVersionOfSDKRequired
The value did not exist when this SDK was created. Upgrade to a newer version of the SDK to be able to use this type.
EHPMDashboardChartDimensionCategory_None
No category
EHPMDashboardChartDimensionCategory_HistoricalData
Historical data
EHPMDashboardChartDimensionCategory_ProjectColumnData
Project column
EHPMDashboardChartDimensionCategory_PipelinesKanbansAndWorkflows
Pipelines, Kanbans and Workflows
EHPMDashboardChartDimensionCategory_Releases
Releases
EHPMDashboardChartDimensionCategory_Sprints
Sprints
EHPMDashboardChartDimensionCategory_Users
Users
EHPMDashboardChartDimensionCategory_Groups
Groups
EHPMDashboardChartDimensionCategory_Projects
Projects
See Also
EHPMDashboardChartDimensionTimeRange
Chart historical data time range, used for HPMDashboardChartDimension::m_TimeRange, in connection with HPMDashboardChartDimension::m_Limit
enum EHPMDashboardChartDimensionTimeRange {
EHPMDashboardChartDimensionTimeRange_NewVersionOfSDKRequired = 0,
EHPMDashboardChartDimensionTimeRange_None = 1,
EHPMDashboardChartDimensionTimeRange_AutomaticFromData = 2,
EHPMDashboardChartDimensionTimeRange_DateRange = 3,
EHPMDashboardChartDimensionTimeRange_LastXDays = 4,
EHPMDashboardChartDimensionTimeRange_LastXWeeks = 5,
EHPMDashboardChartDimensionTimeRange_LastXMonths = 6,
EHPMDashboardChartDimensionTimeRange_LastXQuarters = 7,
EHPMDashboardChartDimensionTimeRange_LastXYears = 8,
};
Values
EHPMDashboardChartDimensionTimeRange_NewVersionOfSDKRequired
The value did not exist when this SDK was created. Upgrade to a newer version of the SDK to be able to use this type.
EHPMDashboardChartDimensionTimeRange_None
No historical data.
EHPMDashboardChartDimensionTimeRange_AutomaticFromData
Automatic from available data.
EHPMDashboardChartDimensionTimeRange_DateRange
From date range.
EHPMDashboardChartDimensionTimeRange_LastXDays
Last X days.
EHPMDashboardChartDimensionTimeRange_LastXWeeks
Last X weeks.
EHPMDashboardChartDimensionTimeRange_LastXMonths
Last X months.
EHPMDashboardChartDimensionTimeRange_LastXQuarters
Last X quarters.
EHPMDashboardChartDimensionTimeRange_LastXYears
Last X years.
See Also
HPMDashboardChartDimension HPMDashboardChartLimit
EHPMDashboardChartDimensionTimeResolution
Chart dimension time resolution, used for HPMDashboardChartDimension::m_TimeResolution.
enum EHPMDashboardChartDimensionTimeResolution {
EHPMDashboardChartDimensionTimeResolution_NewVersionOfSDKRequired = 0,
EHPMDashboardChartDimensionTimeResolution_Days = 1,
EHPMDashboardChartDimensionTimeResolution_Weeks = 2,
EHPMDashboardChartDimensionTimeResolution_Months = 3,
EHPMDashboardChartDimensionTimeResolution_Quarters = 4,
EHPMDashboardChartDimensionTimeResolution_Years = 5,
};
Values
EHPMDashboardChartDimensionTimeResolution_NewVersionOfSDKRequired
The value did not exist when this SDK was created. Upgrade to a newer version of the SDK to be able to use this type.
EHPMDashboardChartDimensionTimeResolution_Days
Time resolution in days.
EHPMDashboardChartDimensionTimeResolution_Weeks
Time resolution in weeks.
EHPMDashboardChartDimensionTimeResolution_Months
Time resolution in months.
EHPMDashboardChartDimensionTimeResolution_Quarters
Time resolution in quarters.
EHPMDashboardChartDimensionTimeResolution_Years
Time resolution in years.
See Also
EHPMDashboardChartDimensionSortMethod
Chart dimension sort method, used for HPMDashboardChartDimension::m_SortMethod.
enum EHPMDashboardChartDimensionSortMethod {
EHPMDashboardChartDimensionSortMethod_NewVersionOfSDKRequired = 0,
EHPMDashboardChartDimensionSortMethod_Natural = 1,
EHPMDashboardChartDimensionSortMethod_Numeric = 2,
};
Values
EHPMDashboardChartDimensionSortMethod_NewVersionOfSDKRequired
The value did not exist when this SDK was created. Upgrade to a newer version of the SDK to be able to use this type.
EHPMDashboardChartDimensionSortMethod_Natural
Sort dimension in natural order
EHPMDashboardChartDimensionSortMethod_Numeric
Sort dimension in numeric order
See Also
EHPMDashboardChartDimensionSortDirection
Chart dimension sort direction, used for HPMDashboardChartDimension::m_SortDirection.
enum EHPMDashboardChartDimensionSortDirection {
EHPMDashboardChartDimensionSortDirection_NewVersionOfSDKRequired = 0,
EHPMDashboardChartDimensionSortDirection_Ascending = 1,
EHPMDashboardChartDimensionSortDirection_Descending = 2,
};
Values
EHPMDashboardChartDimensionSortDirection_NewVersionOfSDKRequired
The value did not exist when this SDK was created. Upgrade to a newer version of the SDK to be able to use this type.
EHPMDashboardChartDimensionSortDirection_Ascending
Ascending order
EHPMDashboardChartDimensionSortDirection_Descending
Descending order
See Also
EHPMDashboardChartDimensionGroupExpansion
Chart dimension group expansion used for HPMDashboardChartDimension::m_GroupExpansion.
enum EHPMDashboardChartDimensionGroupExpansion {
EHPMDashboardChartDimensionGroupExpansion_NewVersionOfSDKRequired = 0,
EHPMDashboardChartDimensionGroupExpansion_Off = 1,
EHPMDashboardChartDimensionGroupExpansion_On = 2,
};
Values
EHPMDashboardChartDimensionGroupExpansion_NewVersionOfSDKRequired
The value did not exist when this SDK was created. Upgrade to a newer version of the SDK to be able to use this type.
EHPMDashboardChartDimensionGroupExpansion_Off
Do not expand groups
EHPMDashboardChartDimensionGroupExpansion_On
Expand groups to users
See Also
EHPMDashboardChartDimensionSettingEnabled
Chart dimension settings enabled, used for HPMDashboardChartDimension::m_Enabled.
enum EHPMDashboardChartDimensionSettingEnabled {
EHPMDashboardChartDimensionSettingEnabled_None = 0,
EHPMDashboardChartDimensionSettingEnabled_Category = 1,
EHPMDashboardChartDimensionSettingEnabled_SubCategory = 2,
EHPMDashboardChartDimensionSettingEnabled_TimeRange = 4,
EHPMDashboardChartDimensionSettingEnabled_TimeResolution = 8,
EHPMDashboardChartDimensionSettingEnabled_SortMethod = 16,
EHPMDashboardChartDimensionSettingEnabled_SortDirection = 32,
EHPMDashboardChartDimensionSettingEnabled_GroupExpansion = 64,
EHPMDashboardChartDimensionSettingEnabled_Limits = 128,
EHPMDashboardChartDimensionSettingEnabled_Forcasting = 256,
};
Values
EHPMDashboardChartDimensionSettingEnabled_None
No settings.
EHPMDashboardChartDimensionSettingEnabled_Category
Category setting.
EHPMDashboardChartDimensionSettingEnabled_SubCategory
Sub category setting.
EHPMDashboardChartDimensionSettingEnabled_TimeRange
Time range setting.
EHPMDashboardChartDimensionSettingEnabled_TimeResolution
Time resolution setting.
EHPMDashboardChartDimensionSettingEnabled_SortMethod
Sorting method setting.
EHPMDashboardChartDimensionSettingEnabled_SortDirection
Sorting direction setting.
EHPMDashboardChartDimensionSettingEnabled_GroupExpansion
Group expansion setting.
EHPMDashboardChartDimensionSettingEnabled_Limits
Dimension limits setting.
EHPMDashboardChartDimensionSettingEnabled_Forcasting
Forecasting setting.
See Also
HPMDashboardChartDimension
Chart dimension configuration.
struct HPMDashboardChartDimension {
HPMUInt32 m_Enabled;
HPMUInt32 m_Category;
HPMDashboardChartDataIdentifier m_SubCategory;
HPMUInt32 m_TimeRange;
HPMUInt32 m_TimeResolution;
HPMUInt32 m_SortMethod;
HPMUInt32 m_SortDirection;
HPMUInt32 m_GroupExpansion;
HPMDashboardChartLimit m_Limit;
HPMDashboardChartForecastingConfig m_Forecasting;
} HPMDashboardChartDimension;
Members
m_Enabled
Enabled settings, can be any combination of EHPMDashboardChartDimensionSettingEnabled.
m_Category
Dimension category.
m_SubCategory
Sub category identifier. EHPMDashboardChartDimensionCategory_ProjectColumnData: m_ID = EHPMProjectDefaultColumn, m_IDData = IDData for column, otherwise unused
m_TimeRange
Time range setting.
m_TimeResolution
Time resolution setting.
m_SortMethod
Sorting method.
m_SortDirection
Sorting direction.
m_GroupExpansion
Group expansion setting.
m_Limit
Dimension limits setting. Resources, Groups: m_ID = ResourceID, m_IDData = EHPMResourceGroupingType // (Pipelines and Workflows), (m_Category = EHPMDashboardChartDimensionCategory_ProjectColumnData, m_SubCategory.m_ID = EHPMProjectDefaultColumn_WorkflowEnterByUser): m_ContainerID = ProjectID, m_ID = WorkflowID, m_IDData = WorkflowStatusID // Milestones: m_ID as TaskRefID // Projects: m_ID as ProjectID // Sprints: m_ID as TaskRefID
m_Forecasting
Forecasting setting, only used when Category is EHPMDashboardChartDimensionCategory_HistoricalData.
See Also
HPMDashboardChartComputationConfig DashboardUtilIsDimensionValidForResource
EHPMDashboardChartMeasureCategory
Chart measure category, used for HPMDashboardChartMeasure::m_Category.
enum EHPMDashboardChartMeasureCategory {
EHPMDashboardChartMeasureCategory_NewVersionOfSDKRequired = 0,
EHPMDashboardChartMeasureCategory_None = 1,
EHPMDashboardChartMeasureCategory_ProjectColumnData = 2,
EHPMDashboardChartMeasureCategory_Allocation = 3,
EHPMDashboardChartMeasureCategory_NumberOfItems = 4,
EHPMDashboardChartMeasureCategory_SprintBurndown = 5,
EHPMDashboardChartMeasureCategory_ReleaseBurndown = 6,
EHPMDashboardChartMeasureCategory_SprintAllocation = 7,
EHPMDashboardChartMeasureCategory_SprintCapacity = 8,
};
Values
EHPMDashboardChartMeasureCategory_NewVersionOfSDKRequired
The value did not exist when this SDK was created. Upgrade to a newer version of the SDK to be able to use this type.
EHPMDashboardChartMeasureCategory_None
No category.
EHPMDashboardChartMeasureCategory_ProjectColumnData
Project column data.
EHPMDashboardChartMeasureCategory_Allocation
Allocation.
EHPMDashboardChartMeasureCategory_NumberOfItems
Number of items.
EHPMDashboardChartMeasureCategory_SprintBurndown
Sprint burndown.
EHPMDashboardChartMeasureCategory_ReleaseBurndown
Release burndown.
EHPMDashboardChartMeasureCategory_SprintAllocation
Sprint allocation.
EHPMDashboardChartMeasureCategory_SprintCapacity
Release capacity.
See Also
EHPMDashboardChartMeasureAggregationFunction
Chart measure aggregation function, used for HPMDashboardChartMeasure::m_AggregationFunction.
enum EHPMDashboardChartMeasureAggregationFunction {
EHPMDashboardChartMeasureAggregationFunction_NewVersionOfSDKRequired = 0,
EHPMDashboardChartMeasureAggregationFunction_Sum = 1,
EHPMDashboardChartMeasureAggregationFunction_Average = 2,
EHPMDashboardChartMeasureAggregationFunction_Min = 3,
EHPMDashboardChartMeasureAggregationFunction_Max = 4,
EHPMDashboardChartMeasureAggregationFunction_First = 5,
EHPMDashboardChartMeasureAggregationFunction_Last = 6,
};
Values
EHPMDashboardChartMeasureAggregationFunction_NewVersionOfSDKRequired
The value did not exist when this SDK was created. Upgrade to a newer version of the SDK to be able to use this type.
EHPMDashboardChartMeasureAggregationFunction_Sum
Sum.
EHPMDashboardChartMeasureAggregationFunction_Average
Average value.
EHPMDashboardChartMeasureAggregationFunction_Min
Minimum value.
EHPMDashboardChartMeasureAggregationFunction_Max
Maximum value.
EHPMDashboardChartMeasureAggregationFunction_First
First value.
EHPMDashboardChartMeasureAggregationFunction_Last
Last value.
See Also
EHPMDashboardChartMeasureTimeRange
Chart measure time range limit, used for HPMDashboardChartMeasure::m_TimeRange in connection with HPMDashboardChartMeasure::m_Limit
enum EHPMDashboardChartMeasureTimeRange {
EHPMDashboardChartMeasureTimeRange_NewVersionOfSDKRequired = 0,
EHPMDashboardChartMeasureTimeRange_None = 1,
EHPMDashboardChartMeasureTimeRange_DateRange = 2,
EHPMDashboardChartMeasureTimeRange_LastXDays = 3,
EHPMDashboardChartMeasureTimeRange_LastXWeeks = 4,
EHPMDashboardChartMeasureTimeRange_LastXMonths = 5,
EHPMDashboardChartMeasureTimeRange_LastXQuarters = 6,
EHPMDashboardChartMeasureTimeRange_LastXYears = 7,
EHPMDashboardChartMeasureTimeRange_FutureXDays = 8,
EHPMDashboardChartMeasureTimeRange_FutureXWeeks = 9,
EHPMDashboardChartMeasureTimeRange_FutureXMonths = 10,
EHPMDashboardChartMeasureTimeRange_FutureXQuarters = 11,
EHPMDashboardChartMeasureTimeRange_FutureXYears = 12,
};
Values
EHPMDashboardChartMeasureTimeRange_NewVersionOfSDKRequired
The value did not exist when this SDK was created. Upgrade to a newer version of the SDK to be able to use this type.
EHPMDashboardChartMeasureTimeRange_None
No time range.
EHPMDashboardChartMeasureTimeRange_DateRange
Date range.
EHPMDashboardChartMeasureTimeRange_LastXDays
Last X days.
EHPMDashboardChartMeasureTimeRange_LastXWeeks
Last X weeks.
EHPMDashboardChartMeasureTimeRange_LastXMonths
Last X months.
EHPMDashboardChartMeasureTimeRange_LastXQuarters
Last X quarters.
EHPMDashboardChartMeasureTimeRange_LastXYears
Last X years.
EHPMDashboardChartMeasureTimeRange_FutureXDays
Future X days.
EHPMDashboardChartMeasureTimeRange_FutureXWeeks
Future X weeks.
EHPMDashboardChartMeasureTimeRange_FutureXMonths
Future X months.
EHPMDashboardChartMeasureTimeRange_FutureXQuarters
Future X quarters.
EHPMDashboardChartMeasureTimeRange_FutureXYears
Future X years.
See Also
EHPMDashboardChartMeasureAllocationType
Chart measure allocation type, used for HPMDashboardChartMeasure::m_AllocationType.
enum EHPMDashboardChartMeasureAllocationType {
EHPMDashboardChartMeasureAllocationType_NewVersionOfSDKRequired = 0,
EHPMDashboardChartMeasureAllocationType_AllocatedTime = 1,
EHPMDashboardChartMeasureAllocationType_Capacity = 2,
};
Values
EHPMDashboardChartMeasureAllocationType_NewVersionOfSDKRequired
The value did not exist when this SDK was created. Upgrade to a newer version of the SDK to be able to use this type.
EHPMDashboardChartMeasureAllocationType_AllocatedTime
Allocated time.
EHPMDashboardChartMeasureAllocationType_Capacity
Capacity.
See Also
EHPMDashboardChartMeasureBurndownType
Chart measure burndown type, used for HPMDashboardChartMeasure::m_BurndownType.
enum EHPMDashboardChartMeasureBurndownType {
EHPMDashboardChartMeasureBurndownType_NewVersionOfSDKRequired = 0,
EHPMDashboardChartMeasureBurndownType_None = 1,
EHPMDashboardChartMeasureBurndownType_WorkRemaining = 2,
EHPMDashboardChartMeasureBurndownType_Points = 3,
EHPMDashboardChartMeasureBurndownType_IdealDays = 4,
};
Values
EHPMDashboardChartMeasureBurndownType_NewVersionOfSDKRequired
The value did not exist when this SDK was created. Upgrade to a newer version of the SDK to be able to use this type.
EHPMDashboardChartMeasureBurndownType_None
No burndown.
EHPMDashboardChartMeasureBurndownType_WorkRemaining
Work remaining burndown.
EHPMDashboardChartMeasureBurndownType_Points
Points burndown.
EHPMDashboardChartMeasureBurndownType_IdealDays
Ideal days burndown.
See Also
EHPMDashboardChartPostAction
Chart measure post action used for HPMDashboardChartMeasure::m_PostAction.
enum EHPMDashboardChartPostAction {
EHPMDashboardChartPostAction_NewVersionOfSDKRequired = 0,
EHPMDashboardChartPostAction_None = 1,
EHPMDashboardChartPostAction_Delta = 2,
};
Values
EHPMDashboardChartPostAction_NewVersionOfSDKRequired
The value did not exist when this SDK was created. Upgrade to a newer version of the SDK to be able to use this type.
EHPMDashboardChartPostAction_None
No post action.
EHPMDashboardChartPostAction_Delta
Delta post action
See Also
HPMDashboardChartMeasure
Chart measure configuration
struct HPMDashboardChartMeasure {
HPMUInt32 m_Category;
const HPMChar * m_pCustomName;
HPMUInt32 m_TimeRange;
HPMDashboardChartLimit m_Limit;
HPMUInt32 m_AllocationType;
HPMUInt32 m_nIdentifiers;
HPMDashboardChartDataIdentifier const * m_pIdentifiers;
HPMDashboardChartFilter m_Filter;
HPMUInt32 m_BurndownType;
HPMUInt32 m_AggregationFunction;
HPMFP64 m_ScaleByFinalValue;
HPMInt32 m_bScaleByAllocation;
HPMUInt32 m_PostAction;
} HPMDashboardChartMeasure;
Members
m_Category
. Measure category.
m_pCustomName
Measure custom name
m_TimeRange
Time range.
m_Limit
Measure limits. Only EHPMDashboardChartLimitType_NumericValue and EHPMDashboardChartLimitType_Time valid here
m_AllocationType
Allocation type.
m_nIdentifiers
Number of identifiers.
m_pIdentifiers
List of identifiers. If m_Category is EHPMDashboardChartMeasureCategory_ReleaseBurndown: The task refs of the releases to measure in m_ID // EHPMDashboardChartMeasureCategory_SprintBurndown: The task refs of the sprints to measure in m_ID // EHPMDashboardChartMeasureCategory_ProjectColumnData: Only one ident: m_ID = EHPMProjectDefaultColumn, m_IDData = Column IDData
m_Filter
Measure filter.
m_BurndownType
. Measure burndown type.
m_AggregationFunction
. Measure aggregation function.
m_ScaleByFinalValue
. Measure scale value.
m_bScaleByAllocation
. Scale measure by allocation.
m_PostAction
. Chart measure post action.
See Also
DashboardUtilGetMeasureAutoName DashboardUtilIsMeasureValidForResource
HPMDashboardChartComputationConfig
Chart computation configuration
struct HPMDashboardChartComputationConfig {
HPMUniqueID m_ChartOwner;
HPMUInt32 m_nFilters;
HPMDashboardChartFilter const * m_pFilters;
HPMUInt32 m_nDimensions;
HPMDashboardChartDimension const * m_pDimensions;
HPMUInt32 m_nMeasures;
HPMDashboardChartMeasure const * m_pMeasures;
HPMDashboardChartItemViewConfig m_ItemViewConfig;
HPMInt32 m_bSupressZeroValues;
HPMUInt64 m_EarliestSampledTime;
HPMUInt32 m_OriginalVersion;
} HPMDashboardChartComputationConfig;
Members
m_ChartOwner
Chart owner.
m_nFilters
Number of filters.
m_pFilters
List of filters.
m_nDimensions
Number of dimensions.
m_pDimensions
List of dimensions.
m_nMeasures
Number of measures.
m_pMeasures
List of measures.
m_ItemViewConfig
Item view configuration.
m_bSupressZeroValues
Suppression of zero values.
m_EarliestSampledTime
The time when this configuration was first sampled. Only valid when getting historic data. Expressed as micro seconds since 1970 UTC.
m_OriginalVersion
Original version number when chart configuration was created, used for backwards compatibility.
See Also
DashboardChartCreate DashboardChartGetComputationConfig DashboardChartSetComputationConfig DashboardChartGetLastSampledHistoricComputationConfig
HPMDashboardChartHistoricComputationConfigs
Chart historic computation configuration list.
struct HPMDashboardChartHistoricComputationConfigs {
HPMUInt32 m_nConfigurations;
HPMDashboardChartComputationConfig const * m_pConfigurations;
} HPMDashboardChartHistoricComputationConfigs;
Members
m_nConfigurations
Number of configurations.
m_pConfigurations
List of configurations.
See Also
DashboardChartGetHistoricComputationConfigs
HPMDashboardChartValidationResult
Chart validation result
struct HPMDashboardChartValidationResult {
HPMInt32 m_bValid;
HPMUntranslatedString const * m_pError;
} HPMDashboardChartValidationResult;
Members
m_bValid
. True if chart is valid.
m_pError
List of errors.
See Also
DashboardUtilIsComputationConfigValidForResource
HPMDashboardThemes
Dashboard themes.
struct HPMDashboardThemes {
HPMUInt32 m_nThemes;
HPMString const * m_pThemes;
} HPMDashboardThemes;
Members
m_nThemes
Number of themes.
m_pThemes
List of themes.
See Also
DashboardPageEnum
Enumerates dashboard page IDs in a database.
HPMError DashboardPageEnum (
    void * _pSession,
    HPMUniqueEnum const * * _pEnum
    );
Parameters
_pSession
[in] A connected session. See SessionOpen.
_pEnum
[out] Pointer to a pointer of a HPMUniqueEnum object, representing the returned dashboard page IDs.
Return Value
Returns an error code. See EHPMError.
Comments
The returned object must be freed with ObjectFree or a memory leak will result.
See Also
HPMSdkFunctions, ObjectFree, HPMUniqueEnum
DashboardPageGetName
Returns the name for a page.
HPMError DashboardPageGetName (
    void * _pSession,
    HPMUniqueID _PageID,
    HPMString const * * _pData
    );
Parameters
_pSession
[in] A connected session. See SessionOpen.
_PageID
[in] The unique identifier of the page to get the name for.
_pData
[out] Pointer to a pointer of a HPMString object holding the name of the page.
Return Value
Returns an error code. See EHPMError.
Comments
The returned object must be freed with ObjectFree or a memory leak will result.
See Also
DashboardPageSetName
Sets the name for a page.
HPMError DashboardPageSetName (
    void * _pSession,
    HPMUniqueID _PageID,
    HPMChar const * _pNewPageName
    );
Parameters
_pSession
[in] A connected session. See SessionOpen.
_PageID
[in] The unique identifier of the page to set the name for.
_pNewPageName
[in] New page name to set on the page.
Return Value
Returns an error code. See EHPMError.
See Also
DashboardPageGetTheme
Returns the theme for a page.
HPMError DashboardPageGetTheme (
    void * _pSession,
    HPMUniqueID _PageID,
    HPMString const * * _pData
    );
Parameters
_pSession
[in] A connected session. See SessionOpen.
_PageID
[in] The unique identifier of the page to get the theme for.
_pData
[out] Pointer to a pointer of a HPMString object holding the theme of the page.
Return Value
Returns an error code. See EHPMError.
Comments
The returned object must be freed with ObjectFree or a memory leak will result.
See Also
DashboardPageSetTheme
Sets the theme for a page.
HPMError DashboardPageSetTheme (
    void * _pSession,
    HPMUniqueID _PageID,
    HPMChar const * _pNewPageTheme
    );
Parameters
_pSession
[in] A connected session. See SessionOpen.
_PageID
[in] The unique identifier of the page to set the theme for.
_pNewPageTheme
[in] New page theme to set on the page.
Return Value
Returns an error code. See EHPMError.
See Also
DashboardThemeEnum
Returns all available themes.
HPMError DashboardThemeEnum (
    void * _pSession,
    HPMDashboardThemes const * * _pData
    );
Parameters
_pSession
[in] A connected session. See SessionOpen.
_pData
[out] Pointer to a pointer of a HPMDashboardThemes object holding the available themes.
Return Value
Returns an error code. See EHPMError.
Comments
The returned object must be freed with ObjectFree or a memory leak will result.
See Also
DashboardPageGetSharedToWithViewingRights
Gets the list of resources that a page is shared to (with viewing rights)
HPMError DashboardPageGetSharedToWithViewingRights (
    void * _pSession,
    HPMUniqueID _PageID,
    HPMResourceDefinitionList const * * _pResult
    );
Parameters
_pSession
[in] A connected session. See SessionOpen.
_PageID
[in] The unique identifier of the page to get the list of resources that the page is shared to (with viewing rights).
_pResult
[out] The resources. See HPMResourceDefinitionList.
Return Value
Returns an error code. See EHPMError.
Comments
The returned object must be freed with ObjectFree or a memory leak will result.
See Also
DashboardPageSetSharedToWithViewingRights
Sets the list of resources that a page is shared to (with viewing rights)
HPMError DashboardPageSetSharedToWithViewingRights (
    void * _pSession,
    HPMUniqueID _PageID,
    HPMResourceDefinitionList const * _pResourceList
    );
Parameters
_pSession
[in] A connected session. See SessionOpen.
_PageID
[in] The unique identifier of the page to set the list of resources that the page is shared to (with viewing rights).
_pResourceList
[in] The resources. See HPMResourceDefinitionList.
Return Value
Returns an error code. See EHPMError.
See Also
DashboardPageGetSharedToWithEditingRights
Gets the list of resources that a page is shared to (with editing rights)
HPMError DashboardPageGetSharedToWithEditingRights (
    void * _pSession,
    HPMUniqueID _PageID,
    HPMResourceDefinitionList const * * _pResult
    );
Parameters
_pSession
[in] A connected session. See SessionOpen.
_PageID
[in] The unique identifier of the page to get the list of resources that the page is shared to (with editing rights).
_pResult
[out] The resources. See HPMResourceDefinitionList.
Return Value
Returns an error code. See EHPMError.
Comments
The returned object must be freed with ObjectFree or a memory leak will result.
See Also
DashboardPageSetSharedToWithEditingRights
Sets the list of resources that a page is shared to (with editing rights)
HPMError DashboardPageSetSharedToWithEditingRights (
    void * _pSession,
    HPMUniqueID _PageID,
    HPMResourceDefinitionList const * _pResourceList
    );
Parameters
_pSession
[in] A connected session. See SessionOpen.
_PageID
[in] The unique identifier of the page to set the list of resources that the page is shared to (with editing rights).
_pResourceList
[in] The resources. See HPMResourceDefinitionList.
Return Value
Returns an error code. See EHPMError.
See Also
DashboardPageDelete
Deletes the page with the given unique identifier.
HPMError DashboardPageDelete (
    void * _pSession,
    HPMUniqueID _PageID
    );
Parameters
_pSession
[in] A connected session. See SessionOpen.
_PageID
[in] The unique identifier of the page to delete.
Return Value
Returns an error code. See EHPMError.
See Also
DashboardPageCreate
Creates a new dashboards page.
HPMError DashboardPageCreate (
    void * _pSession,
    HPMChar const * _pPageName,
    HPMUniqueID _LocalObjectID,
    HPMUniqueID * _pReturnedPageID
    );
Parameters
_pSession
[in] A connected session. See SessionOpen.
_pPageName
[in] The name of the page to create.
_LocalObjectID
[in] Optional supplied local id that will be returned when page is created.
_pReturnedPageID
[out] The unique identifier of the created page. This function will block even in non-blocking mode if this parameter is not NULL.
Return Value
Returns an error code. See EHPMError.
See Also
DashboardPageIsPersonal
Returns whether the dashboard page is a personal resource page
HPMError DashboardPageIsPersonal (
    void * _pSession,
    HPMUniqueID _PageID,
    HPMInt32 * _pReturn
    );
Parameters
_pSession
[in] A connected session. See SessionOpen.
_PageID
[in] The unique identifier of the page to check.
_pReturn
[out] Set to 1 if the dashboard page is personal to a resource, 0 otherwise
Return Value
Returns an error code. See EHPMError.
See Also
DashboardPageGetCreatedBy
Returns the unique identifier of the resource that created the page
HPMError DashboardPageGetCreatedBy (
    void * _pSession,
    HPMUniqueID _PageID,
    HPMUniqueID * _pReturn
    );
Parameters
_pSession
[in] A connected session. See SessionOpen.
_PageID
[in] The unique identifier of the page to get the creator for.
_pReturn
[out] The unique identifier of the resource that created the page.
Return Value
Returns an error code. See EHPMError.
See Also
DashboardPageGetLayout
Returns the layout for a page.
HPMError DashboardPageGetLayout (
    void * _pSession,
    HPMUniqueID _PageID,
    HPMDashboardPageLayout const * * _pData
    );
Parameters
_pSession
[in] A connected session. See SessionOpen.
_PageID
[in] The unique identifier of the page to get the layout for.
_pData
[out] Pointer to a pointer of a HPMDashboardPageLayout object holding the layout of the page.
Return Value
Returns an error code. See EHPMError.
Comments
The returned object must be freed with ObjectFree or a memory leak will result.
See Also
HPMSdkFunctions, ObjectFree, HPMDashboardPageLayout
DashboardPageSetLayout
Sets the layout for a page.
HPMError DashboardPageSetLayout (
    void * _pSession,
    HPMUniqueID _PageID,
    HPMDashboardPageLayout const * _pNewPageTheme
    );
Parameters
_pSession
[in] A connected session. See SessionOpen.
_PageID
[in] The unique identifier of the page to set the layout for.
_pNewPageTheme
[in] New page layout to set on the page.
Return Value
Returns an error code. See EHPMError.
See Also
HPMSdkFunctions, ObjectFree, HPMDashboardPageLayout
DashboardChartEnum
Enumerates chart IDs on a dashboard page.
HPMError DashboardChartEnum (
    void * _pSession,
    HPMUniqueID _PageID,
    HPMUniqueEnum const * * _pEnum
    );
Parameters
_pSession
[in] A connected session. See SessionOpen.
_PageID
[in] The unique identifier of the page to get the charts for.
_pEnum
[out] Pointer to a pointer of a HPMUniqueEnum object, representing the returned dashboard chart IDs.
Return Value
Returns an error code. See EHPMError.
Comments
The returned object must be freed with ObjectFree or a memory leak will result.
See Also
HPMSdkFunctions, ObjectFree, HPMUniqueEnum
DashboardChartCreate
Create chart on dashboard page.
HPMError DashboardChartCreate (
    void * _pSession,
    HPMUniqueID _PageID,
    const HPMDashboardChartPresentationConfig * _pPresentationConfig,
    const HPMDashboardChartComputationConfig * _pComputationConfig,
    HPMUniqueID _LocalObjectID,
    HPMUniqueID _CloneFromChartID,
    HPMUniqueID * _pReturnedChartID
    );
Parameters
_pSession
[in] A connected session. See SessionOpen.
_PageID
[in] The unique identifier of the page to create the chart on.
_pPresentationConfig
[in] Presentation configuration.
_pComputationConfig
[in] Computation configuration.
_LocalObjectID
[in] Local ID.
_CloneFromChartID
[in] Optional source chart ID for cloning. The presentation and computation configurations will not be cloned automatically.
_pReturnedChartID
[out] ID of created chart.
Return Value
Returns an error code. See EHPMError.
See Also
HPMSdkFunctions, HPMDashboardChartPresentationConfig HPMDashboardChartComputationConfig
DashboardChartDelete
Delete chart.
HPMError DashboardChartDelete (
    void * _pSession,
    HPMUniqueID _ChartID
    );
Parameters
_pSession
[in] A connected session. See SessionOpen.
_ChartID
[in] The unique identifier of the chart to delete.
Return Value
Returns an error code. See EHPMError.
See Also
DashboardChartSetName
Set chart name.
HPMError DashboardChartSetName (
    void * _pSession,
    HPMUniqueID _ChartID,
    const HPMChar * _pName
    );
Parameters
_pSession
[in] A connected session. See SessionOpen.
_ChartID
[in] The unique identifier of the chart to set the name for.
_pName
[in] New name.
Return Value
Returns an error code. See EHPMError.
See Also
DashboardChartSetPresentationConfig
Set chart presentation configuration.
HPMError DashboardChartSetPresentationConfig (
    void * _pSession,
    HPMUniqueID _ChartID,
    const HPMDashboardChartPresentationConfig * _pConfig
    );
Parameters
_pSession
[in] A connected session. See SessionOpen.
_ChartID
[in] The unique identifier of the chart to set the presentation config for.
_pConfig
[in] New presentation configuration.
Return Value
Returns an error code. See EHPMError.
See Also
HPMSdkFunctions, HPMDashboardChartPresentationConfig
DashboardChartSetComputationConfig
Set chart computation configuration.
HPMError DashboardChartSetComputationConfig (
    void * _pSession,
    HPMUniqueID _ChartID,
    const HPMDashboardChartComputationConfig * _pConfig
    );
Parameters
_pSession
[in] A connected session. See SessionOpen.
_ChartID
[in] The unique identifier of the chart to set the computation config for.
_pConfig
[in] New chart computation configuration.
Return Value
Returns an error code. See EHPMError.
See Also
HPMSdkFunctions, HPMDashboardChartComputationConfig
DashboardChartGetName
Get chart name.
HPMError DashboardChartGetName (
    void * _pSession,
    HPMUniqueID _ChartID,
    HPMString const * * _pData
    );
Parameters
_pSession
[in] A connected session. See SessionOpen.
_ChartID
[in] Chart ID.
_pData
[out] Chart name.
Return Value
Returns an error code. See EHPMError.
Comments
The returned object must be freed with ObjectFree or a memory leak will result.
See Also
DashboardChartGetPageID
Get chart dashboard page ID.
HPMError DashboardChartGetPageID (
    void * _pSession,
    HPMUniqueID _ChartID,
    HPMUniqueID * _pPageID
    );
Parameters
_pSession
[in] A connected session. See SessionOpen.
_ChartID
[in] Chart ID.
_pPageID
[out] Dashboard page ID.
Return Value
Returns an error code. See EHPMError.
Comments
The returned object must be freed with ObjectFree or a memory leak will result.
See Also
DashboardChartGetComputationConfig
Get chart computation configuration.
HPMError DashboardChartGetComputationConfig (
    void * _pSession,
    HPMUniqueID _ChartID,
    HPMDashboardChartComputationConfig const * * _pData
    );
Parameters
_pSession
[in] A connected session. See SessionOpen.
_ChartID
[in] Chart ID.
_pData
[out] Computation configuration.
Return Value
Returns an error code. See EHPMError.
Comments
The returned object must be freed with ObjectFree or a memory leak will result.
See Also
HPMSdkFunctions, ObjectFree, HPMDashboardChartComputationConfig
DashboardChartGetPresentationConfig
Get chart presentation configuration.
HPMError DashboardChartGetPresentationConfig (
    void * _pSession,
    HPMUniqueID _ChartID,
    HPMDashboardChartPresentationConfig const * * _pData
    );
Parameters
_pSession
[in] A connected session. See SessionOpen.
_ChartID
[in] Chart ID.
_pData
[out] Presentation configuration.
Return Value
Returns an error code. See EHPMError.
Comments
The returned object must be freed with ObjectFree or a memory leak will result.
See Also
HPMSdkFunctions, ObjectFree, HPMDashboardChartPresentationConfig
DashboardChartGetHistoricComputationConfigs
Get chart historic computation configurations.
HPMError DashboardChartGetHistoricComputationConfigs (
    void * _pSession,
    HPMUniqueID _ChartID,
    HPMDashboardChartHistoricComputationConfigs const * * _pData
    );
Parameters
_pSession
[in] A connected session. See SessionOpen.
_ChartID
[in] Chart ID.
_pData
[out] Computation configurations.
Return Value
Returns an error code. See EHPMError.
Comments
The returned object must be freed with ObjectFree or a memory leak will result.
See Also
HPMSdkFunctions, ObjectFree, HPMDashboardChartHistoricComputationConfigs
DashboardChartGetLastSampledHistoricComputationConfig
Get chart last sampled historic computation configuration.
HPMError DashboardChartGetLastSampledHistoricComputationConfig (
    void * _pSession,
    HPMUniqueID _ChartID,
    HPMDashboardChartComputationConfig const * * _pData
    );
Parameters
_pSession
[in] A connected session. See SessionOpen.
_ChartID
[in] Chart ID.
_pData
[out] Computation configuration.
Return Value
Returns an error code. See EHPMError.
Comments
The returned object must be freed with ObjectFree or a memory leak will result.
See Also
HPMSdkFunctions, ObjectFree, HPMDashboardChartComputationConfig
DashboardUtilGetMeasureAutoName
Get automatic name for measure.
HPMError DashboardUtilGetMeasureAutoName (
    void * _pSession,
    HPMDashboardChartMeasure const * _pMeasure,
    HPMUntranslatedString const * * _pData
    );
Parameters
_pSession
[in] A connected session. See SessionOpen.
_pMeasure
[in] Measure configuration.
_pData
[out] Measure automatic name.
Return Value
Returns an error code. See EHPMError.
Comments
The returned object must be freed with ObjectFree or a memory leak will result.
See Also
HPMSdkFunctions, ObjectFree, HPMDashboardChartMeasure
DashboardUtilGetFilterAutoName
Get automatic name for filter.
HPMError DashboardUtilGetFilterAutoName (
    void * _pSession,
    HPMDashboardChartFilter const * _pFilter,
    HPMUntranslatedString const * * _pData
    );
Parameters
_pSession
[in] A connected session. See SessionOpen.
_pFilter
[in] Filter configuration.
_pData
[out] Filter automatic name.
Return Value
Returns an error code. See EHPMError.
Comments
The returned object must be freed with ObjectFree or a memory leak will result.
See Also
HPMSdkFunctions, ObjectFree, HPMDashboardChartFilter
DashboardUtilColumnCanBeUsedForDimension
Check if column can be used as a dimension.
HPMError DashboardUtilColumnCanBeUsedForDimension (
    void * _pSession,
    HPMColumn const * _pColumn,
    HPMInt32 * _pData
    );
Parameters
_pSession
[in] A connected session. See SessionOpen.
_pColumn
[in] Column.
_pData
[out] True if column can be used as dimension.
Return Value
Returns an error code. See EHPMError.
Comments
The returned object must be freed with ObjectFree or a memory leak will result.
See Also
DashboardUtilIsDimensionValidForResource
Check if dimension is valid for resource.
HPMError DashboardUtilIsDimensionValidForResource (
    void * _pSession,
    HPMDashboardChartDimension const * _pDimension,
    HPMUniqueID _ForResourceID,
    HPMInt32 * _pData
    );
Parameters
_pSession
[in] A connected session. See SessionOpen.
_pDimension
[in] Dimension configuration.
_ForResourceID
[in] Resource ID.
_pData
[out] True if dimension is valid for resource.
Return Value
Returns an error code. See EHPMError.
Comments
The returned object must be freed with ObjectFree or a memory leak will result.
See Also
HPMSdkFunctions, ObjectFree, HPMDashboardChartDimension
DashboardUtilIsMeasureValidForResource
Check if measure is valid for resource.
HPMError DashboardUtilIsMeasureValidForResource (
    void * _pSession,
    HPMDashboardChartMeasure const * _pMeasure,
    HPMUniqueID _ForResourceID,
    HPMInt32 * _pData
    );
Parameters
_pSession
[in] A connected session. See SessionOpen.
_pMeasure
[in] Measure configuration.
_ForResourceID
[in] Resource ID.
_pData
[out] True if measure is valid for resource.
Return Value
Returns an error code. See EHPMError.
Comments
The returned object must be freed with ObjectFree or a memory leak will result.
See Also
HPMSdkFunctions, ObjectFree, HPMDashboardChartMeasure
DashboardUtilIsFilterValidForResource
Check if filter is valid for resource.
HPMError DashboardUtilIsFilterValidForResource (
    void * _pSession,
    HPMDashboardChartFilter const * _pFilter,
    HPMUniqueID _ForResourceID,
    HPMInt32 * _pData
    );
Parameters
_pSession
[in] A connected session. See SessionOpen.
_pFilter
[in] Filter configuration.
_ForResourceID
[in] Resource ID.
_pData
[out] True if filter is valid for resource.
Return Value
Returns an error code. See EHPMError.
Comments
The returned object must be freed with ObjectFree or a memory leak will result.
See Also
HPMSdkFunctions, ObjectFree, HPMDashboardChartFilter
DashboardUtilIsComputationConfigValidForResource
Check if computation configuration is valid for resource.
HPMError DashboardUtilIsComputationConfigValidForResource (
    void * _pSession,
    HPMDashboardChartComputationConfig const * _pConfig,
    HPMUniqueID _ForResourceID,
    HPMDashboardChartValidationResult const * * _pData
    );
Parameters
_pSession
[in] A connected session. See SessionOpen.
_pConfig
[in] Computation configuration.
_ForResourceID
[in] Resource ID.
_pData
[out] Validation result.
Return Value
Returns an error code. See EHPMError.
Comments
The returned object must be freed with ObjectFree or a memory leak will result.
See Also
HPMSdkFunctions, ObjectFree, HPMDashboardChartFilter, HPMDashboardChartValidationResult
DashboardSubscribeToChart
Subscribes to a chart. Chart data will is received asynchronously and a EHPMChangeCallbackOperation_DashboardChartReceived callback signals that new data is available.
HPMError DashboardSubscribeToChart (
    void * _pSession,
    HPMUniqueID _ChartID,
    HPMDashboardChartSubscription const * * _pEnum
    );
Parameters
_pSession
[in] A connected session. See SessionOpen.
_ChartID
[in] The unique identifier of the chart to subscribe to.
_pEnum
[out] Pointer to a pointer of a HPMDashboardChartSubscription object holding the subscription.
Return Value
Returns an error code. See EHPMError.
Comments
The returned object must be freed with ObjectFree or a memory leak will result.
See Also
HPMSdkFunctions, ObjectFree, HPMDashboardChartSubscription
DashboardSubscriptionGetLastResultSetAsString
Decodes the latest received result set as string. The result set is available when a EHPMChangeCallbackOperation_DashboardChartReceived callback signal is received. If no data has been been received for the subscription, EHPMError_DataNotYetAvailable will be returned.
HPMError DashboardSubscriptionGetLastResultSetAsString (
    void * _pSession,
    HPMDashboardChartSubscription const * _pSubscription,
    HPMString const * * _pData
    );
Parameters
_pSession
[in] A connected session. See SessionOpen.
_pSubscription
[in] The chart subscription holding the result set.
_pData
[out] Pointer to a pointer of a HPMString object holding the chart result set as a string.
Return Value
Returns an error code. See EHPMError.
Comments
The returned object must be freed with ObjectFree or a memory leak will result.
See Also
HPMSdkFunctions, ObjectFree, HPMDashboardChartSubscription
DashboardSubscriptionGetLastResultSet
Decodes the latest received result set as a HPMDashboardChartResultSet. The result set is available when a EHPMChangeCallbackOperation_DashboardChartReceived callback signal is received. If no data has been been received for the subscription, EHPMError_DataNotYetAvailable will be returned.
HPMError DashboardSubscriptionGetLastResultSet (
    void * _pSession,
    HPMDashboardChartSubscription const * _pSubscription,
    HPMDashboardChartResultSet const * * _pData
    );
Parameters
_pSession
[in] A connected session. See SessionOpen.
_pSubscription
[in] The chart subscription holding the result set.
_pData
[out] Pointer to a pointer of a HPMDashboardChartResultSet object holding the chart result set structure.
Return Value
Returns an error code. See EHPMError.
Comments
The returned object must be freed with ObjectFree or a memory leak will result.
See Also
HPMSdkFunctions, ObjectFree, HPMDashboardChartSubscription
EHPMChangeCallbackOperation
Callback operation specified for HPMChangeCallbackInfo::m_Operation.
enum EHPMChangeCallbackOperation {
EHPMChangeCallbackOperation_NewVersionOfSDKRequired = 0,
EHPMChangeCallbackOperation_GlobalStatisticsSettingsChange = 1,
EHPMChangeCallbackOperation_GlobalServerNameChange = 2,
EHPMChangeCallbackOperation_ResourceCreate = 3,
EHPMChangeCallbackOperation_ResourceDelete = 4,
EHPMChangeCallbackOperation_ResourcePropertiesChange = 5,
EHPMChangeCallbackOperation_ResourceGlobalSettingsChange = 6,
EHPMChangeCallbackOperation_ResourceLicenseViolation = 7,
EHPMChangeCallbackOperation_ResourceGroupsChange = 8,
EHPMChangeCallbackOperation_ProjectCreate = 9,
EHPMChangeCallbackOperation_ProjectDelete = 10,
EHPMChangeCallbackOperation_ProjectPropertiesChange = 11,
EHPMChangeCallbackOperation_ProjectSettingsChange = 12,
EHPMChangeCallbackOperation_ProjectStatisticsSettingsChange = 13,
EHPMChangeCallbackOperation_ProjectWorkflowChange = 14,
EHPMChangeCallbackOperation_ProjectEmailSettingsChange = 15,
EHPMChangeCallbackOperation_ProjectOpenBacklogProject = 16,
EHPMChangeCallbackOperation_ProjectOpenQAProject = 17,
EHPMChangeCallbackOperation_ProjectHistoryAutoSaveSettingsChange = 18,
EHPMChangeCallbackOperation_ProjectResourceAdd = 19,
EHPMChangeCallbackOperation_ProjectResourceRemove = 20,
EHPMChangeCallbackOperation_ProjectResourcePropertiesChange = 21,
EHPMChangeCallbackOperation_ProjectCustomColumnsChange = 22,
EHPMChangeCallbackOperation_ProjectCustomColumnsDeleteTaskData = 23,
EHPMChangeCallbackOperation_ProjectCustomColumnsRenameTaskData = 24,
EHPMChangeCallbackOperation_ProjectActiveDefaultColumnsChange = 25,
EHPMChangeCallbackOperation_ProjectWallSettingsChange = 26,
EHPMChangeCallbackOperation_ProjectWallGroupsChange = 27,
EHPMChangeCallbackOperation_ProjectDetailedAccessRulesChange = 28,
EHPMChangeCallbackOperation_TaskDelete = 29,
EHPMChangeCallbackOperation_TaskChange = 30,
EHPMChangeCallbackOperation_TaskChangeCustomColumnData = 31,
EHPMChangeCallbackOperation_TaskChangeWorkRemainingHistory = 32,
EHPMChangeCallbackOperation_TaskRefDelete = 33,
EHPMChangeCallbackOperation_TaskRefConnect = 34,
EHPMChangeCallbackOperation_TaskRefChange = 35,
EHPMChangeCallbackOperation_TaskConnectionDelete = 36,
EHPMChangeCallbackOperation_TaskConnectionChangeType = 37,
EHPMChangeCallbackOperation_TaskConnectionChangeLeadLagTime = 38,
EHPMChangeCallbackOperation_TaskCreateComment = 39,
EHPMChangeCallbackOperation_TaskDeleteComment = 40,
EHPMChangeCallbackOperation_TaskCommentPosted = 41,
EHPMChangeCallbackOperation_DataHistoryReceived = 42,
EHPMChangeCallbackOperation_VersionControlFileTreeAvailable = 43,
EHPMChangeCallbackOperation_VersionControlAllCommandsFinished = 44,
EHPMChangeCallbackOperation_VersionControlFileInfoChanged = 45,
EHPMChangeCallbackOperation_VersionControlWarnFileOverwriteDelete = 46,
EHPMChangeCallbackOperation_VersionControlWarnCheckOutShouldSync = 47,
EHPMChangeCallbackOperation_VersionControlSyncFilesResponse = 48,
EHPMChangeCallbackOperation_VersionControlAddFilesResponse = 49,
EHPMChangeCallbackOperation_VersionControlCheckInFilesResponse = 50,
EHPMChangeCallbackOperation_VersionControlCheckOutFilesResponse = 51,
EHPMChangeCallbackOperation_VersionControlRenameResponse = 52,
EHPMChangeCallbackOperation_VersionControlDeleteFilesResponse = 53,
EHPMChangeCallbackOperation_VersionControlRestoreDeletedFilesResponse = 54,
EHPMChangeCallbackOperation_VersionControlSetAccessRightsResponse = 55,
EHPMChangeCallbackOperation_VersionControlRollbackFileResponse = 56,
EHPMChangeCallbackOperation_VersionControlDeleteVersionsResponse = 57,
EHPMChangeCallbackOperation_VersionControlGetFileHistoryResponse = 58,
EHPMChangeCallbackOperation_VersionControlGetAccessRightsResponse = 59,
EHPMChangeCallbackOperation_GlobalCustomSettingsChange = 60,
EHPMChangeCallbackOperation_GlobalCustomSettingsUnregister = 61,
EHPMChangeCallbackOperation_GlobalCustomSettingsValueChange = 62,
EHPMChangeCallbackOperation_ProjectCustomSettingsValueChange = 63,
EHPMChangeCallbackOperation_ProjectResourceCustomSettingsValueChange = 64,
EHPMChangeCallbackOperation_ResourceCustomSettingsValueChange = 65,
EHPMChangeCallbackOperation_GlobalSDKInternalDataChange = 66,
EHPMChangeCallbackOperation_ProjectSDKInternalDataChange = 67,
EHPMChangeCallbackOperation_ProjectResourceSDKInternalDataChange = 68,
EHPMChangeCallbackOperation_ResourceSDKInternalDataChange = 69,
EHPMChangeCallbackOperation_TaskSDKInternalDataChange = 70,
EHPMChangeCallbackOperation_TaskRefSDKInternalDataChange = 71,
EHPMChangeCallbackOperation_ClientExecuteURL = 72,
EHPMChangeCallbackOperation_ClientSyncDone = 73,
EHPMChangeCallbackOperation_ProjectCustomStatisticsSettingsChange = 74,
EHPMChangeCallbackOperation_ProjectWorkflowCreate = 75,
EHPMChangeCallbackOperation_ProjectWorkflowDelete = 76,
EHPMChangeCallbackOperation_ProjectReportsChange = 77,
EHPMChangeCallbackOperation_ProjectWorkflowStatusStatsChange = 78,
EHPMChangeCallbackOperation_ProjectWorkflowNewVersion = 79,
EHPMChangeCallbackOperation_TaskUpdatePipelineWorkflowToNewestVersion = 80,
EHPMChangeCallbackOperation_GlobalWorkflowsDeleted = 81,
EHPMChangeCallbackOperation_GlobalReportsChange = 82,
EHPMChangeCallbackOperation_TaskLastExitWorkflowStatusChange = 83,
EHPMChangeCallbackOperation_TaskLastEnterWorkflowStatusChange = 84,
EHPMChangeCallbackOperation_TaskLastAssignedInWorkflowStatusChange = 85,
EHPMChangeCallbackOperation_GlobalDocumentAttachmentLimitChange = 86,
EHPMChangeCallbackOperation_TaskCreateUnified = 87,
EHPMChangeCallbackOperation_TaskChangeDisposition = 88,
EHPMChangeCallbackOperation_AuthenticationProtocolBegin = 89,
EHPMChangeCallbackOperation_CommunicationChannelPacketReceived = 90,
EHPMChangeCallbackOperation_CommunicationChannelPacketDropped = 91,
EHPMChangeCallbackOperation_AuthenticationResolveCredentials = 92,
EHPMChangeCallbackOperation_CommunicationChannelRegisterFailed = 93,
EHPMChangeCallbackOperation_ProjectAgilePriorityCustomColumnChange = 94,
EHPMChangeCallbackOperation_ResourceLockFlagsChange = 95,
EHPMChangeCallbackOperation_AuthenticationResolveCredentialsResponse = 96,
EHPMChangeCallbackOperation_TaskChangeIdealDaysHistory = 97,
EHPMChangeCallbackOperation_TaskChangePointsHistory = 98,
EHPMChangeCallbackOperation_CalendarChangeHolidays = 99,
EHPMChangeCallbackOperation_CalendarChangeCustomWorkingHours = 100,
EHPMChangeCallbackOperation_CalendarChangeWorkingHours = 101,
EHPMChangeCallbackOperation_CalendarChangeCustomWorkingDays = 102,
EHPMChangeCallbackOperation_CalendarChangeWorkingDays = 103,
EHPMChangeCallbackOperation_ResourcePreferredLanguageChange = 104,
EHPMChangeCallbackOperation_ResourceLastUsedLanguageChange = 105,
EHPMChangeCallbackOperation_ProjectViewPresetsApplied = 106,
EHPMChangeCallbackOperation_ResourceTimesheetPeriodDataDelete = 107,
EHPMChangeCallbackOperation_ProjectTimesheetLockChange = 108,
EHPMChangeCallbackOperation_GlobalTimesheetConfigChange = 109,
EHPMChangeCallbackOperation_ProjectDisplayUserMessage = 110,
EHPMChangeCallbackOperation_IDNoLongerExists = 111,
EHPMChangeCallbackOperation_TaskChangeLastResourceCommentReadTime = 112,
EHPMChangeCallbackOperation_TaskEditComment = 113,
EHPMChangeCallbackOperation_TaskCommentSDKInternalDataChange = 114,
EHPMChangeCallbackOperation_DynamicCustomSettingsNotification = 115,
EHPMChangeCallbackOperation_DynamicCustomSettingsValueChanged = 116,
EHPMChangeCallbackOperation_DynamicCustomSettingsValuesRequestResponse = 117,
EHPMChangeCallbackOperation_CommunicationChannelsChanged = 118,
EHPMChangeCallbackOperation_RightClickDisplayTaskMenu = 119,
EHPMChangeCallbackOperation_RightClickDisplayWorkflowStepMenu = 120,
EHPMChangeCallbackOperation_RightClickMenuItemSelected = 121,
EHPMChangeCallbackOperation_ResourceGetTimesheetDayResponse = 122,
EHPMChangeCallbackOperation_TimesheetGetDateRangeResponse = 123,
EHPMChangeCallbackOperation_TimesheetRowChange = 124,
EHPMChangeCallbackOperation_ChatMessage = 125,
EHPMChangeCallbackOperation_ChatMessageLastID = 126,
EHPMChangeCallbackOperation_ChatMessageLastReadID = 127,
EHPMChangeCallbackOperation_ChatOnlineStatusChange = 128,
EHPMChangeCallbackOperation_ChatHistoryReceived = 129,
EHPMChangeCallbackOperation_VersionControlUploadAvatarFilesResponse = 130,
EHPMChangeCallbackOperation_ResourceDoNotDisturbChange = 131,
EHPMChangeCallbackOperation_GlobalEmailSettingsChange = 132,
EHPMChangeCallbackOperation_CustomTaskStatusNotification = 133,
EHPMChangeCallbackOperation_DashboardChartReceive = 134,
EHPMChangeCallbackOperation_DashboardChartCreate = 135,
EHPMChangeCallbackOperation_DashboardComputationConfigurationChange = 136,
EHPMChangeCallbackOperation_DashboardPresentationConfigurationChange = 137,
EHPMChangeCallbackOperation_DashboardChartDelete = 138,
EHPMChangeCallbackOperation_DashboardChartNameChange = 139,
EHPMChangeCallbackOperation_DashboardPageCreate = 140,
EHPMChangeCallbackOperation_DashboardPageNameChange = 141,
EHPMChangeCallbackOperation_DashboardThemeChange = 142,
EHPMChangeCallbackOperation_DashboardPageLayoutChange = 143,
EHPMChangeCallbackOperation_DashboardPageSharedToWithViewingRightsChange = 144,
EHPMChangeCallbackOperation_DashboardPageSharedToWithEditingRightsChange = 145,
EHPMChangeCallbackOperation_DashboardPageDelete = 146,
EHPMChangeCallbackOperation_UserNotMemberOfProject = 147,
EHPMChangeCallbackOperation_ProjectBugReportResourcesChange = 148,
EHPMChangeCallbackOperation_ProjectDefaultQAWorkflowChange = 149,
EHPMChangeCallbackOperation_SharesUpdate = 150,
EHPMChangeCallbackOperation_ProjectViewPresetCreate = 151,
EHPMChangeCallbackOperation_ProjectViewPresetChange = 152,
EHPMChangeCallbackOperation_ProjectViewPresetDelete = 153,
EHPMChangeCallbackOperation_ProjectColumnMetaDataChange = 154,
EHPMChangeCallbackOperation_ProjectOverviewTextChange = 155,
EHPMChangeCallbackOperation_ProjectResourceParentTaskDisplayDepthChange = 156,
EHPMChangeCallbackOperation_DashboardChartStatusUpdated = 157,
EHPMChangeCallbackOperation_GlobalDocumentAttachmentCommentRequiredChange = 158,
EHPMChangeCallbackOperation_BoardCreate = 159,
EHPMChangeCallbackOperation_BoardAttributesChanged = 160,
EHPMChangeCallbackOperation_BoardElementUpdated = 161,
EHPMChangeCallbackOperation_BoardElementDeleted = 162,
EHPMChangeCallbackOperation_BoardCardMove = 163,
EHPMChangeCallbackOperation_BoardCardHide = 164,
EHPMChangeCallbackOperation_SprintConvertedToBoard = 165,
EHPMChangeCallbackOperation_TaskAssignmentChange = 166,
EHPMChangeCallbackOperation_ColumnStatusMappingChanged = 167,
EHPMChangeCallbackOperation_BoardElementSettingsChanged = 168,
EHPMChangeCallbackOperation_ResourceGroupAdded = 169,
EHPMChangeCallbackOperation_ResourceGroupEdited = 170,
EHPMChangeCallbackOperation_ResourceGroupDeleted = 171,
EHPMChangeCallbackOperation_ResourceAccessTokensChanged = 172,
EHPMChangeCallbackOperation_GlobalSecurityOptionsChanged = 173,
EHPMChangeCallbackOperation_ProjectColumnResourcePermissionRulesChange = 174,
EHPMChangeCallbackOperation_GlobalSecurityPolicyChanged = 175,
EHPMChangeCallbackOperation_ProjectResourceGroupAdd = 176,
EHPMChangeCallbackOperation_ProjectResourceGroupRemove = 177,
EHPMChangeCallbackOperation_AuthenticationResolveCredentialsHelixAuthUrl = 178,
};
Values
EHPMChangeCallbackOperation_NewVersionOfSDKRequired
EHPMChangeCallbackOperation_GlobalStatisticsSettingsChange
The global statistics settings changed. HPMChangeCallbackInfo::m_pCallbackData should be cast to HPMChangeCallbackData_GlobalStatisticsSettingsChange.
EHPMChangeCallbackOperation_GlobalServerNameChange
The global server name changed. HPMChangeCallbackInfo::m_pCallbackData should be cast to HPMChangeCallbackData_GlobalServerNameChange.
EHPMChangeCallbackOperation_ResourceCreate
A new resource was created. HPMChangeCallbackInfo::m_pCallbackData should be cast to HPMChangeCallbackData_ResourceCreate.
EHPMChangeCallbackOperation_ResourceDelete
A resource was deleted. HPMChangeCallbackInfo::m_pCallbackData should be cast to HPMChangeCallbackData_ResourceCreate.
EHPMChangeCallbackOperation_ResourcePropertiesChange
The properties of a resource was changed. HPMChangeCallbackInfo::m_pCallbackData should be cast to HPMChangeCallbackData_ResourcePropertiesChange.
EHPMChangeCallbackOperation_ResourceGlobalSettingsChange
The global settings for a resource changed. HPMChangeCallbackInfo::m_pCallbackData should be cast to HPMChangeCallbackData_ResourceGlobalSettingsChange.
EHPMChangeCallbackOperation_ResourceLicenseViolation
A user command caused a license violation. HPMChangeCallbackInfo::m_pCallbackData should be cast to HPMChangeCallbackData_ResourceLicenseViolation.
EHPMChangeCallbackOperation_ResourceGroupsChange
A resource group was created, deleted or changed. HPMChangeCallbackInfo::m_pCallbackData should be cast to HPMChangeCallbackData_ResourceGroupsChange.
EHPMChangeCallbackOperation_ProjectCreate
A project was created. HPMChangeCallbackInfo::m_pCallbackData should be cast to HPMChangeCallbackData_ProjectCreate.
EHPMChangeCallbackOperation_ProjectDelete
A project was deleted. HPMChangeCallbackInfo::m_pCallbackData should be cast to HPMChangeCallbackData_ProjectDelete.
EHPMChangeCallbackOperation_ProjectPropertiesChange
The properties of a project changed. HPMChangeCallbackInfo::m_pCallbackData should be cast to HPMChangeCallbackData_ProjectPropertiesChange.
EHPMChangeCallbackOperation_ProjectSettingsChange
The settings of a project changed. HPMChangeCallbackInfo::m_pCallbackData should be cast to HPMChangeCallbackData_ProjectSettingsChange.
EHPMChangeCallbackOperation_ProjectStatisticsSettingsChange
The statistics settings of a project changed. HPMChangeCallbackInfo::m_pCallbackData should be cast to HPMChangeCallbackData_ProjectStatisticsSettingsChange.
EHPMChangeCallbackOperation_ProjectWorkflowChange
The settings for a workflow in a project changed. HPMChangeCallbackInfo::m_pCallbackData should be cast to HPMChangeCallbackData_ProjectWorkflowChange.
EHPMChangeCallbackOperation_ProjectEmailSettingsChange
The email settings of a project changed. HPMChangeCallbackInfo::m_pCallbackData should be cast to HPMChangeCallbackData_ProjectEmailSettingsChange.
EHPMChangeCallbackOperation_ProjectOpenBacklogProject
The backlog project of a project was opened. HPMChangeCallbackInfo::m_pCallbackData should be cast to HPMChangeCallbackData_ProjectOpenBacklogProject.
EHPMChangeCallbackOperation_ProjectOpenQAProject
The QA project of a project was opened. HPMChangeCallbackInfo::m_pCallbackData should be cast to HPMChangeCallbackData_ProjectOpenQAProject.
EHPMChangeCallbackOperation_ProjectHistoryAutoSaveSettingsChange
The project history auto save settings for a project was changed. HPMChangeCallbackInfo::m_pCallbackData should be cast to HPMChangeCallbackData_ProjectHistoryAutoSaveSettingsChange.
EHPMChangeCallbackOperation_ProjectResourceAdd
A resource was added to a project. HPMChangeCallbackInfo::m_pCallbackData should be cast to HPMChangeCallbackData_ProjectResourceAdd.
EHPMChangeCallbackOperation_ProjectResourceRemove
A resource was removed from a project. HPMChangeCallbackInfo::m_pCallbackData should be cast to HPMChangeCallbackData_ProjectResourceRemove.
EHPMChangeCallbackOperation_ProjectResourcePropertiesChange
The properties of a resource was changed for a project. HPMChangeCallbackInfo::m_pCallbackData should be cast to HPMChangeCallbackData_ProjectResourcePropertiesChange.
EHPMChangeCallbackOperation_ProjectCustomColumnsChange
The custom columns of a project was changed. HPMChangeCallbackInfo::m_pCallbackData should be cast to HPMChangeCallbackData_ProjectCustomColumnsChange.
EHPMChangeCallbackOperation_ProjectCustomColumnsDeleteTaskData
Custom column task data was deleted in a project. HPMChangeCallbackInfo::m_pCallbackData should be cast to HPMChangeCallbackData_ProjectCustomColumnsDeleteTaskData.
EHPMChangeCallbackOperation_ProjectCustomColumnsRenameTaskData
Custom column task data was renamed in a project. HPMChangeCallbackInfo::m_pCallbackData should be cast to HPMChangeCallbackData_ProjectCustomColumnsRenameTaskData.
EHPMChangeCallbackOperation_ProjectActiveDefaultColumnsChange
The active default column of a project was changed. HPMChangeCallbackInfo::m_pCallbackData should be cast to HPMChangeCallbackData_ProjectActiveDefaultColumnsChange.
EHPMChangeCallbackOperation_ProjectWallSettingsChange
The wall settings of the project was changed. HPMChangeCallbackInfo::m_pCallbackData should be cast to HPMChangeCallbackData_ProjectWallSettingsChange.
EHPMChangeCallbackOperation_ProjectWallGroupsChange
The wall groups of the project was changed. HPMChangeCallbackInfo::m_pCallbackData should be cast to HPMChangeCallbackData_ProjectWallGroupsChange.
EHPMChangeCallbackOperation_ProjectDetailedAccessRulesChange
The detailed access rules of the project was changed. HPMChangeCallbackInfo::m_pCallbackData should be cast to HPMChangeCallbackData_ProjectDetailedAccessRulesChange.
EHPMChangeCallbackOperation_TaskDelete
A task was deleted. HPMChangeCallbackInfo::m_pCallbackData should be cast to HPMChangeCallbackData_TaskDelete.
EHPMChangeCallbackOperation_TaskChange
A property of a task changed. HPMChangeCallbackInfo::m_pCallbackData should be cast to HPMChangeCallbackData_TaskChange.
EHPMChangeCallbackOperation_TaskChangeCustomColumnData
The custom column data of a task was changed. HPMChangeCallbackInfo::m_pCallbackData should be cast to HPMChangeCallbackData_TaskChangeCustomColumnData.
EHPMChangeCallbackOperation_TaskChangeWorkRemainingHistory
The work remaining history of a task was changed. HPMChangeCallbackInfo::m_pCallbackData should be cast to HPMChangeCallbackData_TaskChangeWorkRemainingHistory.
EHPMChangeCallbackOperation_TaskRefDelete
A task reference was deleted. HPMChangeCallbackInfo::m_pCallbackData should be cast to HPMChangeCallbackData_TaskRefDelete.
EHPMChangeCallbackOperation_TaskRefConnect
A task reference was connected. HPMChangeCallbackInfo::m_pCallbackData should be cast to HPMChangeCallbackData_TaskRefConnect.
EHPMChangeCallbackOperation_TaskRefChange
A property of a task reference was changed. HPMChangeCallbackInfo::m_pCallbackData should be cast to HPMChangeCallbackData_TaskRefChange.
EHPMChangeCallbackOperation_TaskConnectionDelete
A task connection was deleted. HPMChangeCallbackInfo::m_pCallbackData should be cast to HPMChangeCallbackData_TaskConnectionDelete.
EHPMChangeCallbackOperation_TaskConnectionChangeType
The type of a connection was changed. HPMChangeCallbackInfo::m_pCallbackData should be cast to HPMChangeCallbackData_TaskConnectionChangeType.
EHPMChangeCallbackOperation_TaskConnectionChangeLeadLagTime
The lead lag time of a connection was changed. HPMChangeCallbackInfo::m_pCallbackData should be cast to HPMChangeCallbackData_TaskConnectionChangeLeadLagTime.
EHPMChangeCallbackOperation_TaskCreateComment
A comment was created on a task. HPMChangeCallbackInfo::m_pCallbackData should be cast to HPMChangeCallbackData_TaskCreateComment.
EHPMChangeCallbackOperation_TaskDeleteComment
A comment was deleted on a task. HPMChangeCallbackInfo::m_pCallbackData should be cast to HPMChangeCallbackData_TaskDeleteComment.
EHPMChangeCallbackOperation_TaskCommentPosted
A comment was posted on a task. HPMChangeCallbackInfo::m_pCallbackData should be cast to HPMChangeCallbackData_TaskCommentPosted.
EHPMChangeCallbackOperation_DataHistoryReceived
Data history was received. HPMChangeCallbackInfo::m_pCallbackData should be cast to HPMChangeCallbackData_DataHistoryReceived.
EHPMChangeCallbackOperation_VersionControlFileTreeAvailable
A new file tree is available, you need to enumerate files to download the latest version. HPMChangeCallbackInfo::m_pCallbackData should be cast to HPMChangeCallbackData_VersionControlFileTreeAvailable.
EHPMChangeCallbackOperation_VersionControlAllCommandsFinished
Info for a file somewhere in the file tree changed. HPMChangeCallbackInfo::m_pCallbackData should be cast to HPMChangeCallbackData_VersionControlFileInfoChanged.
EHPMChangeCallbackOperation_VersionControlFileInfoChanged
Info for a file somewhere in the file tree changed. HPMChangeCallbackInfo::m_pCallbackData should be cast to HPMChangeCallbackData_VersionControlFileInfoChanged.
EHPMChangeCallbackOperation_VersionControlWarnFileOverwriteDelete
The file will be overwritten callback. This callback will not be called from the SessionProcess function, but rather from a processing thread, so make sure to return as fast as possible and take care to protect your data from other threads. HPMChangeCallbackInfo::m_pCallbackData should be cast to HPMChangeCallbackData_VersionControlWarnFileOverwriteDelete.
EHPMChangeCallbackOperation_VersionControlWarnCheckOutShouldSync
The files that are to be checked out isn't the newest version. This callback will not be called from the SessionProcess function, but rather from a processing thread, so make sure to return as fast as possible and take care to protect your data from other threads. HPMChangeCallbackInfo::m_pCallbackData should be cast to HPMChangeCallbackData_VersionControlWarnCheckOutShouldSync.
EHPMChangeCallbackOperation_VersionControlSyncFilesResponse
Response to a sync files operation. HPMChangeCallbackInfo::m_pCallbackData should be cast to HPMChangeCallbackData_VersionControlSyncFilesResponse.
EHPMChangeCallbackOperation_VersionControlAddFilesResponse
Response to a add files operation. HPMChangeCallbackInfo::m_pCallbackData should be cast to HPMChangeCallbackData_VersionControlAddFilesResponse.
EHPMChangeCallbackOperation_VersionControlCheckInFilesResponse
Response to a check in files operation. HPMChangeCallbackInfo::m_pCallbackData should be cast to HPMChangeCallbackData_VersionControlCheckInFilesResponse.
EHPMChangeCallbackOperation_VersionControlCheckOutFilesResponse
Response to a check out files operation. HPMChangeCallbackInfo::m_pCallbackData should be cast to HPMChangeCallbackData_VersionControlCheckOutFilesResponse.
EHPMChangeCallbackOperation_VersionControlRenameResponse
Response to a rename files operation. HPMChangeCallbackInfo::m_pCallbackData should be cast to HPMChangeCallbackData_VersionControlRenameResponse.
EHPMChangeCallbackOperation_VersionControlDeleteFilesResponse
Response to a delete files operation. HPMChangeCallbackInfo::m_pCallbackData should be cast to HPMChangeCallbackData_VersionControlDeleteFilesResponse.
EHPMChangeCallbackOperation_VersionControlRestoreDeletedFilesResponse
Response to a restore deleted files operation. HPMChangeCallbackInfo::m_pCallbackData should be cast to HPMChangeCallbackData_VersionControlRestoreDeletedFilesResponse.
EHPMChangeCallbackOperation_VersionControlSetAccessRightsResponse
Response to a set file access rights operation. HPMChangeCallbackInfo::m_pCallbackData should be cast to HPMChangeCallbackData_VersionControlSetAccessRightsResponse.
EHPMChangeCallbackOperation_VersionControlRollbackFileResponse
Response to a rollback file operation. HPMChangeCallbackInfo::m_pCallbackData should be cast to HPMChangeCallbackData_VersionControlRollbackFileResponse.
EHPMChangeCallbackOperation_VersionControlDeleteVersionsResponse
Response to a delete versions file operation. HPMChangeCallbackInfo::m_pCallbackData should be cast to HPMChangeCallbackData_VersionControlDeleteVersionsResponse.
EHPMChangeCallbackOperation_VersionControlGetFileHistoryResponse
Response to a get file history operation. HPMChangeCallbackInfo::m_pCallbackData should be cast to HPMChangeCallbackData_VersionControlGetFileHistoryResponse.
EHPMChangeCallbackOperation_VersionControlGetAccessRightsResponse
Response to a get access rights operation. HPMChangeCallbackInfo::m_pCallbackData should be cast to HPMChangeCallbackData_VersionControlGetAccessRightsResponse.
// Version 1.2 Changes
EHPMChangeCallbackOperation_GlobalCustomSettingsChange
The custom settings for an integration identifier changed. HPMChangeCallbackInfo::m_pCallbackData should be cast to HPMChangeCallbackData_GlobalCustomSettingsChange.
EHPMChangeCallbackOperation_GlobalCustomSettingsUnregister
A custom settings was unregistered. HPMChangeCallbackInfo::m_pCallbackData should be cast to HPMChangeCallbackData_GlobalCustomSettingsUnregister.
EHPMChangeCallbackOperation_GlobalCustomSettingsValueChange
A global custom settings value changed. HPMChangeCallbackInfo::m_pCallbackData should be cast to HPMChangeCallbackData_GlobalCustomSettingsValueChange.
EHPMChangeCallbackOperation_ProjectCustomSettingsValueChange
A project custom settings value changed. HPMChangeCallbackInfo::m_pCallbackData should be cast to HPMChangeCallbackData_ProjectCustomSettingsValueChange.
EHPMChangeCallbackOperation_ProjectResourceCustomSettingsValueChange
A project resource custom settings value changed. HPMChangeCallbackInfo::m_pCallbackData should be cast to HPMChangeCallbackData_ProjectResourceCustomSettingsValueChange.
EHPMChangeCallbackOperation_ResourceCustomSettingsValueChange
A user custom settings value changed. HPMChangeCallbackInfo::m_pCallbackData should be cast to HPMChangeCallbackData_ResourceCustomSettingsValueChange.
EHPMChangeCallbackOperation_GlobalSDKInternalDataChange
Global SDK internal data changed. HPMChangeCallbackInfo::m_pCallbackData should be cast to HPMChangeCallbackData_GlobalSDKInternalDataChange.
EHPMChangeCallbackOperation_ProjectSDKInternalDataChange
Project SDK internal data changed. HPMChangeCallbackInfo::m_pCallbackData should be cast to HPMChangeCallbackData_ProjectSDKInternalDataChange.
EHPMChangeCallbackOperation_ProjectResourceSDKInternalDataChange
Project SDK internal data changed. HPMChangeCallbackInfo::m_pCallbackData should be cast to HPMChangeCallbackData_ProjectResourceSDKInternalDataChange.
EHPMChangeCallbackOperation_ResourceSDKInternalDataChange
User SDK internal data changed. HPMChangeCallbackInfo::m_pCallbackData should be cast to HPMChangeCallbackData_ResourceSDKInternalDataChange.
EHPMChangeCallbackOperation_TaskSDKInternalDataChange
Task SDK internal data changed. HPMChangeCallbackInfo::m_pCallbackData should be cast to HPMChangeCallbackData_TaskSDKInternalDataChange.
EHPMChangeCallbackOperation_TaskRefSDKInternalDataChange
Task reference SDK internal data changed. HPMChangeCallbackInfo::m_pCallbackData should be cast to HPMChangeCallbackData_TaskRefSDKInternalDataChange.
EHPMChangeCallbackOperation_ClientExecuteURL
Called by the client integration dll when the user clicks an URL. This callback might be called from any thread, so make sure to return as fast as possible and take care to protect your data from other threads. HPMChangeCallbackInfo::m_pCallbackData should be cast to HPMChangeCallbackData_ClientExecuteURL.
EHPMChangeCallbackOperation_ClientSyncDone
The client have fully logged in to the database. This message is only sent when using the SDK in a client plugin. HPMChangeCallbackInfo::m_pCallbackData should be cast to HPMChangeCallbackData_ClientSyncDone.
EHPMChangeCallbackOperation_ProjectCustomStatisticsSettingsChange
The custom statistics settings of the project was changed. HPMChangeCallbackInfo::m_pCallbackData should be cast to HPMChangeCallbackData_ProjectCustomStatisticsSettingsChange.
// Version 5.3 Changes
EHPMChangeCallbackOperation_ProjectWorkflowCreate
A workflow was created in a project. HPMChangeCallbackInfo::m_pCallbackData should be cast to HPMChangeCallbackData_ProjectWorkflowCreate.
EHPMChangeCallbackOperation_ProjectWorkflowDelete
A workflow was deleted in a project. HPMChangeCallbackInfo::m_pCallbackData should be cast to HPMChangeCallbackData_ProjectWorkflowDelete.
EHPMChangeCallbackOperation_ProjectReportsChange
The reports of the project changed. HPMChangeCallbackInfo::m_pCallbackData should be cast to HPMChangeCallbackData_ProjectReportsChange.
EHPMChangeCallbackOperation_ProjectWorkflowStatusStatsChange
The statistics of a workflow status in the project changed. HPMChangeCallbackInfo::m_pCallbackData should be cast to HPMChangeCallbackData_ProjectWorkflowStatusStatsChange.
EHPMChangeCallbackOperation_ProjectWorkflowNewVersion
A new version of a workflow in the project is available. HPMChangeCallbackInfo::m_pCallbackData should be cast to HPMChangeCallbackData_ProjectWorkflowNewVersion.
EHPMChangeCallbackOperation_TaskUpdatePipelineWorkflowToNewestVersion
A task updated a pipeline structure. HPMChangeCallbackInfo::m_pCallbackData should be cast to HPMChangeCallbackData_TaskUpdatePipelineWorkflowToNewestVersion.
EHPMChangeCallbackOperation_GlobalWorkflowsDeleted
All versions of a workflow where deleted in the project. HPMChangeCallbackInfo::m_pCallbackData should be cast to HPMChangeCallbackData_GlobalWorkflowsDeleted.
EHPMChangeCallbackOperation_GlobalReportsChange
The global reports changed. HPMChangeCallbackInfo::m_pCallbackData should be cast to HPMChangeCallbackData_GlobalReportsChange.
EHPMChangeCallbackOperation_TaskLastExitWorkflowStatusChange
Last exit status for a specific workflow status changed. HPMChangeCallbackInfo::m_pCallbackData should be cast to HPMChangeCallbackData_TaskLastExitWorkflowStatusChange.
EHPMChangeCallbackOperation_TaskLastEnterWorkflowStatusChange
Last enter status for a specific workflow status changed. HPMChangeCallbackInfo::m_pCallbackData should be cast to HPMChangeCallbackData_TaskLastEnterWorkflowStatusChange.
EHPMChangeCallbackOperation_TaskLastAssignedInWorkflowStatusChange
Last assigned in a specific workflow status changed. HPMChangeCallbackInfo::m_pCallbackData should be cast to HPMChangeCallbackData_TaskLastAssignedInWorkflowStatusChange.
EHPMChangeCallbackOperation_GlobalDocumentAttachmentLimitChange
The global document attachment size limit changed. HPMChangeCallbackInfo::m_pCallbackData should be cast to HPMChangeCallbackData_GlobalDocumentAttachmentLimitChange.
EHPMChangeCallbackOperation_TaskCreateUnified
Tasks and/or proxies was created in a container. HPMChangeCallbackInfo::m_pCallbackData should be cast to HPMChangeCallbackData_TaskCreateUnified.
EHPMChangeCallbackOperation_TaskChangeDisposition
The disposition of tasks in a container was changed. HPMChangeCallbackInfo::m_pCallbackData should be cast to HPMChangeCallbackData_TaskChangeDisposition.
// Version 6.0 Changes
EHPMChangeCallbackOperation_AuthenticationProtocolBegin
This Custom Authentication Plugin should initiate its authentication protocol. HPMChangeCallbackInfo::m_pCallbackData should be cast to HPMChangeCallbackData_AuthenticationProtocolBegin.
EHPMChangeCallbackOperation_CommunicationChannelPacketReceived
The SDK session received a packet sent to a named communication channel and / or SDK session ID. HPMChangeCallbackInfo::m_pCallbackData should be cast to HPMChangeCallbackData_CommunicationChannelPacketReceived.
EHPMChangeCallbackOperation_CommunicationChannelPacketDropped
A packet sent by the SDK session could not be delivered. HPMChangeCallbackInfo::m_pCallbackData should be cast to HPMChangeCallbackData_CommunicationChannelPacketDropped.
EHPMChangeCallbackOperation_AuthenticationResolveCredentials
This Custom Authentication Integration should validate the credentials provided. HPMChangeCallbackInfo::m_pCallbackData should be cast to HPMChangeCallbackData_AuthenticationResolveCredentials.
EHPMChangeCallbackOperation_CommunicationChannelRegisterFailed
The request of the SDK session to register a communication channel failed. HPMChangeCallbackInfo::m_pCallbackData should be cast to HPMChangeCallbackData_CommunicationChannelRegisterFailed.
EHPMChangeCallbackOperation_ProjectAgilePriorityCustomColumnChange
The agile priority has been updated to use a new custom column. HPMChangeCallbackInfo::m_pCallbackData should be cast to HPMChangeCallbackData_ProjectAgilePriorityCustomColumnChange.
EHPMChangeCallbackOperation_ResourceLockFlagsChange
The lock flags of a resource have been changed. {HPMChangeCallbackInfo}::m_pCallbackData should be cast to HPMChangeCallbackData_ResourceLockFlagsChange.
// Version 6.1 Changes
EHPMChangeCallbackOperation_AuthenticationResolveCredentialsResponse
A credential resolution request has completed. HPMChangeCallbackInfo::m_pCallbackData should be cast to HPMChangeCallbackData_AuthenticationResolveCredentialsResponse.
EHPMChangeCallbackOperation_TaskChangeIdealDaysHistory
The ideal days history of a task was changed. HPMChangeCallbackInfo::m_pCallbackData should be cast to HPMChangeCallbackData_TaskChangeIdealDaysHistory.
EHPMChangeCallbackOperation_TaskChangePointsHistory
The points history of a task was changed. HPMChangeCallbackInfo::m_pCallbackData should be cast to HPMChangeCallbackData_TaskChangePointsHistory.
EHPMChangeCallbackOperation_CalendarChangeHolidays
The holidays of a calendar were changed. HPMChangeCallbackInfo::m_pCallbackData should be cast to HPMChangeCallbackData_CalendarChangeHolidays.
EHPMChangeCallbackOperation_CalendarChangeCustomWorkingHours
The changed working hours of a calendar were changed. HPMChangeCallbackInfo::m_pCallbackData should be cast to HPMChangeCallbackData_CalendarChangeCustomWorkingHours.
EHPMChangeCallbackOperation_CalendarChangeWorkingHours
The working hours of a calendar were changed. HPMChangeCallbackInfo::m_pCallbackData should be cast to HPMChangeCallbackData_CalendarChangeWorkingHours.
EHPMChangeCallbackOperation_CalendarChangeCustomWorkingDays
The changed working days of a calendar were changed. HPMChangeCallbackInfo::m_pCallbackData should be cast to HPMChangeCallbackData_CalendarChangeCustomWorkingDays.
EHPMChangeCallbackOperation_CalendarChangeWorkingDays
The working days of a calendar were changed. HPMChangeCallbackInfo::m_pCallbackData should be cast to HPMChangeCallbackData_CalendarChangeWorkingDays.
// Version 6.5 Changes
EHPMChangeCallbackOperation_ResourcePreferredLanguageChange
The preferred language of a resource changed. {HPMChangeCallbackInfo}::m_pCallbackData should be cast to HPMChangeCallbackData_ResourcePreferredLanguageChange.
EHPMChangeCallbackOperation_ResourceLastUsedLanguageChange
The last used language of a resource changed. {HPMChangeCallbackInfo}::m_pCallbackData should be cast to HPMChangeCallbackData_ResourceLastUsedLanguageChange.
EHPMChangeCallbackOperation_ProjectViewPresetsApplied
The view presets have been applied. {HPMChangeCallbackInfo}::m_pCallbackData should be cast to HPMChangeCallbackData_ProjectViewPresetsApplied.
EHPMChangeCallbackOperation_ResourceTimesheetPeriodDataDelete
The timesheets for a period were deleted. {HPMChangeCallbackInfo}::m_pCallbackData should be cast to HPMChangeCallbackData_ResourceTimesheetPeriodDataDelete.
EHPMChangeCallbackOperation_ProjectTimesheetLockChange
The timesheet lock for a project changed. {HPMChangeCallbackInfo}::m_pCallbackData should be cast to HPMChangeCallbackData_ProjectTimesheetLockChange.
EHPMChangeCallbackOperation_GlobalTimesheetConfigChange
The timesheet configuration changed. {HPMChangeCallbackInfo}::m_pCallbackData should be cast to HPMChangeCallbackData_GlobalTimesheetConfigChange.
// Version 6.7 Changes
EHPMChangeCallbackOperation_ProjectDisplayUserMessage
An SDK session has requested a client display user message. Only received if the logged in resource is the same as the resource the message was sent to. {HPMChangeCallbackInfo}::m_pCallbackData should be cast to HPMChangeCallbackData_ProjectDisplayUserMessage.
EHPMChangeCallbackOperation_IDNoLongerExists
The identifier specified in the command to the server never existed or has been deleted since the command was sent to server. {HPMChangeCallbackInfo}::m_pCallbackData should be cast to HPMChangeCallbackData_IDNoLongerExists.
EHPMChangeCallbackOperation_TaskChangeLastResourceCommentReadTime
The last resource comment read time data of a task was changed. HPMChangeCallbackInfo::m_pCallbackData should be cast to HPMChangeCallbackData_TaskChangeLastResourceCommentReadTime.
EHPMChangeCallbackOperation_TaskEditComment
A comment was created on a task. HPMChangeCallbackInfo::m_pCallbackData should be cast to HPMChangeCallbackData_TaskEditComment.
EHPMChangeCallbackOperation_TaskCommentSDKInternalDataChange
SDK internal data on a comment changed. HPMChangeCallbackInfo::m_pCallbackData should be cast to HPMChangeCallbackData_TaskCommentSDKInternalDataChange.
EHPMChangeCallbackOperation_DynamicCustomSettingsNotification
Dynamic custom settings notification. HPMChangeCallbackInfo::m_pCallbackData should be cast to HPMChangeCallbackData_DynamicCustomSettingsNotification.
EHPMChangeCallbackOperation_DynamicCustomSettingsValueChanged
Dynamic custom settings value changed. HPMChangeCallbackInfo::m_pCallbackData should be cast to HPMChangeCallbackData_DynamicCustomSettingsValueChanged.
EHPMChangeCallbackOperation_DynamicCustomSettingsValuesRequestResponse
Response to a dynamic custom settings value request. HPMChangeCallbackInfo::m_pCallbackData should be cast to HPMChangeCallbackData_DynamicCustomSettingsValuesRequestResponse.
EHPMChangeCallbackOperation_CommunicationChannelsChanged
The a SDK communication channels changed. HPMChangeCallbackInfo::m_pCallbackData should be cast to HPMChangeCallbackData_CommunicationChannelsChanged.
EHPMChangeCallbackOperation_RightClickDisplayTaskMenu
Tasks were right clicked. HPMChangeCallbackInfo::m_pCallbackData should be cast to HPMChangeCallbackData_RightClickDisplayTaskMenu.
EHPMChangeCallbackOperation_RightClickDisplayWorkflowStepMenu
A workflow step was right clicked. HPMChangeCallbackInfo::m_pCallbackData should be cast to HPMChangeCallbackData_RightClickDisplayWorkflowStepMenu.
EHPMChangeCallbackOperation_RightClickMenuItemSelected
A right click menu item was selected. HPMChangeCallbackInfo::m_pCallbackData should be cast to HPMChangeCallbackData_RightClickMenuItemSelected.
// Version 7.0 Changes
EHPMChangeCallbackOperation_ResourceGetTimesheetDayResponse
The response to requested timesheet day data for a resource. {HPMChangeCallbackInfo}::m_pCallbackData should be cast to HPMChangeCallbackData_ResourceGetTimesheetDayResponse.
EHPMChangeCallbackOperation_TimesheetGetDateRangeResponse
The response to requested timesheet date range data. {HPMChangeCallbackInfo}::m_pCallbackData should be cast to HPMChangeCallbackData_TimesheetGetDateRangeResponse.
EHPMChangeCallbackOperation_TimesheetRowChange
A timesheet row was changed. {HPMChangeCallbackInfo}::m_pCallbackData should be cast to HPMChangeCallbackData_TimesheetRowChange.
EHPMChangeCallbackOperation_ChatMessage
A chat message was received. {HPMChangeCallbackInfo}::m_pCallbackData should be cast to HPMChangeCallbackData_ChatMessage.
EHPMChangeCallbackOperation_ChatMessageLastID
The last id in a chat room was upped. {HPMChangeCallbackInfo}::m_pCallbackData should be cast to HPMChangeCallbackData_ChatMessageLastID.
EHPMChangeCallbackOperation_ChatMessageLastReadID
The last read id in a chat room was upped. {HPMChangeCallbackInfo}::m_pCallbackData should be cast to HPMChangeCallbackData_ChatMessageLastReadID.
EHPMChangeCallbackOperation_ChatOnlineStatusChange
The chat online status for a resource changed. {HPMChangeCallbackInfo}::m_pCallbackData should be cast to HPMChangeCallbackData_ChatOnlineStatusChange.
EHPMChangeCallbackOperation_ChatHistoryReceived
Chat history was received. HPMChangeCallbackInfo::m_pCallbackData should be cast to HPMChangeCallbackData_ChatHistoryReceived.
EHPMChangeCallbackOperation_VersionControlUploadAvatarFilesResponse
Response to a upload avatar files operation. HPMChangeCallbackInfo::m_pCallbackData should be cast to HPMChangeCallbackData_VersionControlUploadAvatarFilesResponse.
EHPMChangeCallbackOperation_ResourceDoNotDisturbChange
The do not disturb flag for a resource changed. {HPMChangeCallbackInfo}::m_pCallbackData should be cast to HPMChangeCallbackData_ResourceDoNotDisturbChange.
EHPMChangeCallbackOperation_GlobalEmailSettingsChange
The global email settings changed. {HPMChangeCallbackInfo}::m_pCallbackData should be cast to HPMChangeCallbackData_GlobalEmailSettingsChange.
// Version 7.1 Changes
EHPMChangeCallbackOperation_CustomTaskStatusNotification
Dynamic custom task status notification. HPMChangeCallbackInfo::m_pCallbackData should be cast to HPMChangeCallbackData_CustomTaskStatusNotification.
// Version 8.1 Changes
EHPMChangeCallbackOperation_DashboardChartReceive
Dashboard chart subscription notification. HPMChangeCallbackInfo::m_pCallbackData should be cast to HPMChangeCallbackData_DashboardChartReceive.
EHPMChangeCallbackOperation_DashboardChartCreate
A dashboard chart was created. HPMChangeCallbackInfo::m_pCallbackData should be cast to HPMChangeCallbackData_DashboardChartCreate.
EHPMChangeCallbackOperation_DashboardComputationConfigurationChange
A dashboard computation configuration was changed. HPMChangeCallbackInfo::m_pCallbackData should be cast to HPMChangeCallbackData_DashboardComputationConfigurationChange.
EHPMChangeCallbackOperation_DashboardPresentationConfigurationChange
A dashboard presentation configuration was changed. HPMChangeCallbackInfo::m_pCallbackData should be cast to HPMChangeCallbackData_DashboardPresentationConfigurationChange.
EHPMChangeCallbackOperation_DashboardChartDelete
A dashboard chart was deleted. HPMChangeCallbackInfo::m_pCallbackData should be cast to HPMChangeCallbackData_DashboardChartDelete.
EHPMChangeCallbackOperation_DashboardChartNameChange
A dashboard chart name was changed. HPMChangeCallbackInfo::m_pCallbackData should be cast to HPMChangeCallbackData_DashboardChartNameChange.
EHPMChangeCallbackOperation_DashboardPageCreate
A dashboard page was created. HPMChangeCallbackInfo::m_pCallbackData should be cast to HPMChangeCallbackData_DashboardPageCreate.
EHPMChangeCallbackOperation_DashboardPageNameChange
A dashboard page name was changed. HPMChangeCallbackInfo::m_pCallbackData should be cast to HPMChangeCallbackData_DashboardPageNameChange.
EHPMChangeCallbackOperation_DashboardThemeChange
A dashboard theme was changed. HPMChangeCallbackInfo::m_pCallbackData should be cast to HPMChangeCallbackData_DashboardThemeChange.
EHPMChangeCallbackOperation_DashboardPageLayoutChange
A dashboard page layout was changed. HPMChangeCallbackInfo::m_pCallbackData should be cast to HPMChangeCallbackData_DashboardPageLayoutChange.
EHPMChangeCallbackOperation_DashboardPageSharedToWithViewingRightsChange
A dashboard page viewing rights was changed. HPMChangeCallbackInfo::m_pCallbackData should be cast to HPMChangeCallbackData_DashboardPageSharedToWithViewingRightsChange.
EHPMChangeCallbackOperation_DashboardPageSharedToWithEditingRightsChange
A dashboard page editing rights was changed. HPMChangeCallbackInfo::m_pCallbackData should be cast to HPMChangeCallbackData_DashboardPageSharedToWithEditingRightsChange.
EHPMChangeCallbackOperation_DashboardPageDelete
A dashboard page was deleted. HPMChangeCallbackInfo::m_pCallbackData should be cast to HPMChangeCallbackData_DashboardPageDelete.
// Version 8.3 Changes
EHPMChangeCallbackOperation_UserNotMemberOfProject
The SDK user running the command is not member of the project that that the command requested. HPMChangeCallbackInfo::m_pCallbackData should be cast to HPMChangeCallbackData_UserNotMemberOfProject.
// Version 8.4 Changes
EHPMChangeCallbackOperation_ProjectBugReportResourcesChange
The resources that can report bugs in a project changed. HPMChangeCallbackInfo::m_pCallbackData should be cast to HPMChangeCallbackData_ProjectBugReportResourcesChange.
EHPMChangeCallbackOperation_ProjectDefaultQAWorkflowChange
The default QA workflow changed. HPMChangeCallbackInfo::m_pCallbackData should be cast to HPMChangeCallbackData_ProjectDefaultQAWorkflowChange.
// Version 9.0 Changes
EHPMChangeCallbackOperation_SharesUpdate
Shares have been updated. HPMChangeCallbackInfo::m_pCallbackData should be cast to HPMChangeCallbackData_SharesUpdate.
// Version 9.1 Changes
EHPMChangeCallbackOperation_ProjectViewPresetCreate
A user view preset was created. HPMChangeCallbackInfo::m_pCallbackData should be cast to HPMChangeCallbackData_ProjectViewPresetCreate.
EHPMChangeCallbackOperation_ProjectViewPresetChange
A user view preset was changed. HPMChangeCallbackInfo::m_pCallbackData should be cast to HPMChangeCallbackData_ProjectViewPresetChange.
EHPMChangeCallbackOperation_ProjectViewPresetDelete
A user view preset was deleted. HPMChangeCallbackInfo::m_pCallbackData should be cast to HPMChangeCallbackData_ProjectViewPresetDelete.
EHPMChangeCallbackOperation_ProjectColumnMetaDataChange
The column meta data a project column changed. HPMChangeCallbackInfo::m_pCallbackData should be cast to HPMChangeCallbackData_ProjectColumnMetaDataChange.
// Version 9.2 Changes
EHPMChangeCallbackOperation_ProjectOverviewTextChange
The project overview text was changed. HPMChangeCallbackInfo::m_pCallbackData should be cast to HPMChangeCallbackData_ProjectOverviewTextChange.
EHPMChangeCallbackOperation_ProjectResourceParentTaskDisplayDepthChange
The project resource parent task display depth was changed. HPMChangeCallbackInfo::m_pCallbackData should be cast to HPMChangeCallbackData_ProjectResourceParentTaskDisplayDepthChange.
EHPMChangeCallbackOperation_DashboardChartStatusUpdated
Dashboard chart status updation notification. HPMChangeCallbackInfo::m_pCallbackData should be cast to HPMChangeCallbackData_DashboardChartStatusUpdated.
EHPMChangeCallbackOperation_GlobalDocumentAttachmentCommentRequiredChange
The global document attachment comment required policy changed. HPMChangeCallbackInfo::m_pCallbackData should be cast to HPMChangeCallbackData_GlobalDocumentAttachmentCommentRequiredChange.
// Version 10.0 Changes
EHPMChangeCallbackOperation_BoardCreate
A board was created. HPMChangeCallbackInfo::m_pCallbackData should be cast to HPMChangeCallbackData_BoardCreate.
EHPMChangeCallbackOperation_BoardAttributesChanged
Board attributes were changed. HPMChangeCallbackInfo::m_pCallbackData should be cast to HPMChangeCallbackData_BoardAttributesChanged.
EHPMChangeCallbackOperation_BoardElementUpdated
Board element was updated or created. HPMChangeCallbackInfo::m_pCallbackData should be cast to HPMChangeCallbackData_BoardElementUpdated.
EHPMChangeCallbackOperation_BoardElementDeleted
Board element was updated or created. HPMChangeCallbackInfo::m_pCallbackData should be cast to HPMChangeCallbackData_BoardElementDeleted.
EHPMChangeCallbackOperation_BoardCardMove
Board cards were moved. HPMChangeCallbackInfo::m_pCallbackData should be cast to HPMChangeCallbackData_BoardCardMove.
EHPMChangeCallbackOperation_BoardCardHide
Board cards were hidden. HPMChangeCallbackInfo::m_pCallbackData should be cast to HPMChangeCallbackData_BoardCardHide.
EHPMChangeCallbackOperation_SprintConvertedToBoard
Sprint was converted to board. HPMChangeCallbackInfo::m_pCallbackData should be cast to HPMChangeCallbackData_SprintConvertedToBoard.
EHPMChangeCallbackOperation_TaskAssignmentChange
A user has been assigned or unassigned from a task.
EHPMChangeCallbackOperation_ColumnStatusMappingChanged
Board's column mapping to status was changed. HPMChangeCallbackInfo::m_pCallbackData should be cast to HPMChangeCallbackData_ColumnStatusMappingChanged.
EHPMChangeCallbackOperation_BoardElementSettingsChanged
Board's element settings were changed. HPMChangeCallbackInfo::m_pCallbackData should be cast to HPMChangeCallbackData_BoardElementSettingsChanged.
// Version 10.2 Changes
EHPMChangeCallbackOperation_ResourceGroupAdded
Resource group was created. HPMChangeCallbackInfo::m_pCallbackData should be cast to HPMChangeCallbackData_ResourceGroupAdded.
EHPMChangeCallbackOperation_ResourceGroupEdited
Resource group was changed. HPMChangeCallbackInfo::m_pCallbackData should be cast to HPMChangeCallbackData_ResourceGroupEdited.
EHPMChangeCallbackOperation_ResourceGroupDeleted
Resource group was deleted. HPMChangeCallbackInfo::m_pCallbackData should be cast to HPMChangeCallbackData_ResourceGroupDeleted.
EHPMChangeCallbackOperation_ResourceAccessTokensChanged
Resource access tokens were reset. HPMChangeCallbackInfo::m_pCallbackData should be cast to HPMChangeCallbackData_ResourceAccessTokensChanged.
EHPMChangeCallbackOperation_GlobalSecurityOptionsChanged
Global security options changed. HPMChangeCallbackInfo::m_pCallbackData should be cast to HPMChangeCallbackData_GlobalSecurityOptionsChanged. // Version 11.1 Changes
EHPMChangeCallbackOperation_ProjectColumnResourcePermissionRulesChange
The column resource permission rules of the project was changed. HPMChangeCallbackInfo::m_pCallbackData should be cast to HPMChangeCallbackData_ProjectColumnResourcePermissionRulesChange.
EHPMChangeCallbackOperation_GlobalSecurityPolicyChanged
Global security policy changed. HPMChangeCallbackInfo::m_pCallbackData should be cast to HPMChangeCallbackData_GlobalSecurityPolicyChanged.
EHPMChangeCallbackOperation_ProjectResourceGroupAdd
A resource group was added to a project. HPMChangeCallbackInfo::m_pCallbackData should be cast to HPMChangeCallbackData_ProjectResourceGroupAdd.
EHPMChangeCallbackOperation_ProjectResourceGroupRemove
A resource group was removed from a project. HPMChangeCallbackInfo::m_pCallbackData should be cast to HPMChangeCallbackData_ProjectResourceGroupRemove.
EHPMChangeCallbackOperation_AuthenticationResolveCredentialsHelixAuthUrl
A credential resolution request using Helix Authentication Service has returned the URL required to commplete the authentication. HPMChangeCallbackInfo::m_pCallbackData should be cast to HPMChangeCallbackData_AuthenticationResolveCredentialsHelixAuthUrl.
Comments
When you receive a change callback you need to cast HPMChangeCallbackInfo::m_pCallbackData according to the m_Operation member. For information about what structure belongs to which operation check the documentation for the enum values.
See Also
EHPMLicenseViolationReason
License violation reason used for HPMChangeCallbackData_ResourceLicenseViolation::m_ViolationReason
enum EHPMLicenseViolationReason {
EHPMLicenseViolationReason_NewVersionOfSDKRequired = 0,
EHPMLicenseViolationReason_CreateResourceExceededLicense = 1,
EHPMLicenseViolationReason_ChangeUserExceededLicense = 2,
EHPMLicenseViolationReason_ChangeUserExceededLicense_Overridden = 3,
EHPMLicenseViolationReason_ConvertResourceExceededLicense = 4,
EHPMLicenseViolationReason_CannotChangeDeletedResource = 5,
EHPMLicenseViolationReason_CannotUndeleteADeletedResource = 6,
};
Values
EHPMLicenseViolationReason_NewVersionOfSDKRequired
The reason did not exist when this SDK was created. Upgrade to a newer version of the SDK to be able to use this reason.
EHPMLicenseViolationReason_CreateResourceExceededLicense
A command to create a resource would have caused the license to be exceeded. The command was not performed.
EHPMLicenseViolationReason_ChangeUserExceededLicense
A command to change a resource would have caused the license to be exceeded. The command was not performed.
EHPMLicenseViolationReason_ChangeUserExceededLicense_Overridden
A command to change a resource caused the license to be exceeded. The command was performed and the license is now exceeded.
EHPMLicenseViolationReason_ConvertResourceExceededLicense
A command to convert a resource would have caused the license to be exceeded. The command was not performed.
EHPMLicenseViolationReason_CannotChangeDeletedResource
The license does not allow deleted resources to be changed. The command was not performed.
EHPMLicenseViolationReason_CannotUndeleteADeletedResource
The license does not deleted resources to be undeleted. The command was not performed.
See Also
HPMChangeCallbackData_ResourceLicenseViolation
EHPMPacketDropReason
Reason for dropped packet, used by HPMChangeCallbackData_CommunicationChannelPacketDropped::m_Reason
enum EHPMPacketDropReason {
EHPMPacketDropReason_ChannelNotRegistered = 0,
EHPMPacketDropReason_UnknownDestinationSession = 1,
EHPMPacketDropReason_ChannelNotAuthenticationProvider = 2,
EHPMPacketDropReason_ChannelNotCredentialChecksProvider = 3,
EHPMPacketDropReason_NewVersionOfSDKRequired = 4,
};
Values
EHPMPacketDropReason_ChannelNotRegistered
The packet's destination channel does not exist at the server.
EHPMPacketDropReason_UnknownDestinationSession
The packet's destination session ID is not known to the server.
EHPMPacketDropReason_ChannelNotAuthenticationProvider
The destination channel does not support the transmission of login authentication packets.
EHPMPacketDropReason_ChannelNotCredentialChecksProvider
The destination channel does not support the transmission of login authentication packets.
EHPMPacketDropReason_NewVersionOfSDKRequired
The reason did not exist when this SDK was created. Upgrade to a newer version of the SDK to be able to use this reason.
See Also
HPMChangeCallbackData_CommunicationChannelPacketDropped, CommunicationChannelRegister
EHPMChannelRegisterFailReason
Reason for dropped packet, used by HPMChangeCallbackData_CommunicationChannelRegisterFailed::m_Reason
enum EHPMChannelRegisterFailReason {
EHPMChannelRegisterFailReason_UserNotAuthenticationProvider = 0,
EHPMChannelRegisterFailReason_UserNotResolveCredentialsProvider = 1,
EHPMChannelRegisterFailReason_NewVersionOfSDKRequired = 2,
};
Values
EHPMChannelRegisterFailReason_UserNotAuthenticationProvider
The channel flag EHPMChannelFlag_SupportsAuthentication was specified but the session's SDK user account is not permitted to provide login authentication services.
EHPMChannelRegisterFailReason_UserNotResolveCredentialsProvider
The channel flag EHPMChannelFlag_SupportsResolveCredentials was specified but the session's SDK user account is not permitted to provide credential resolution services.
EHPMChannelRegisterFailReason_NewVersionOfSDKRequired
The reason did not exist when this SDK was created. Upgrade to a newer version of the SDK to be able to use this reason.
See Also
HPMChangeCallbackData_CommunicationChannelRegisterFailed, CommunicationChannelRegister
EHPMChartStatus
Dashboard chart status, used by HPMChangeCallbackData_DashboardChartStatusUpdated::m_Status
enum EHPMChartStatus {
EHPMChartStatus_NewVersionOfSDKRequired = 0,
EHPMChartStatus_Outdated = 1,
EHPMChartStatus_WaitDownload = 2,
EHPMChartStatus_Updated = 3,
};
Values
EHPMChartStatus_NewVersionOfSDKRequired
The chart status did not exist when this SDK was created. Upgrade to a newer version of the SDK to be able to use this reason.
EHPMChartStatus_Outdated
Chart is outdated
EHPMChartStatus_WaitDownload
Chart waits results to be downloaded
EHPMChartStatus_Updated
Chart is up to date
See Also
HPMChangeCallbackData_DashboardChartStatusUpdated
EHPMBoardElementUpdatedReason
Board element update reason, used by HPMChangeCallbackData_BoardElementUpdated::m_Reason
enum EHPMBoardElementUpdatedReason {
EHPMBoardElementUpdatedReason_NewVersionOfSDKRequired = 0,
EHPMBoardElementUpdatedReason_ElementCreated = 1,
EHPMBoardElementUpdatedReason_ElementUpdated = 2,
};
Values
EHPMBoardElementUpdatedReason_NewVersionOfSDKRequired
The board element update reason did not exist when this SDK was created. Upgrade to a newer version of the SDK to be able to use this reason.
EHPMBoardElementUpdatedReason_ElementCreated
New element was created
EHPMBoardElementUpdatedReason_ElementUpdated
Existing element was updated
See Also
HPMChangeCallbackData_BoardElementUpdated
EHPMBoardMoveReason
Board cards move reason, used by HPMChangeCallbackData_BoardCardMove::m_Reason
enum EHPMBoardMoveReason {
EHPMBoardMoveReason_NewVersionOfSDKRequired = 0,
EHPMBoardMoveReason_CardCreated = 1,
EHPMBoardMoveReason_CardMoved = 2,
EHPMBoardMoveReason_CardUnhidden = 3,
EHPMBoardMoveReason_TreeChanges = 4,
EHPMBoardMoveReason_PipelineStructureChanges = 5,
EHPMBoardMoveReason_SprintConvertedToBoard = 6,
EHPMBoardMoveReason_StatusChanged = 7,
};
Values
EHPMBoardMoveReason_NewVersionOfSDKRequired
The board move reason did not exist when this SDK was created. Upgrade to a newer version of the SDK to be able to use this reason.
EHPMBoardMoveReason_CardCreated
Cards were created and moved to default cell.
EHPMBoardMoveReason_CardMoved
Cards were moved within the board.
EHPMBoardMoveReason_CardUnhidden
Cards were unhidden and moved to the end of their cells
EHPMBoardMoveReason_TreeChanges
Task card were moved because of task tree structure changes
EHPMBoardMoveReason_PipelineStructureChanges
Cards were created because of pipeline structure changes
EHPMBoardMoveReason_SprintConvertedToBoard
Cards were created because sprint was converted to board
EHPMBoardMoveReason_StatusChanged
Cards were moved because status changed
See Also
HPMChangeCallbackData_BoardCardMove
EHPMAuthenticationRefusedResult
User authentication refused result HPMChangeCallbackData_AuthenticationResolveCredentialsResponse::m_Result
enum EHPMAuthenticationRefusedResult {
EHPMAuthenticationRefusedResult_NewVersionOfSDKRequired = 0,
EHPMAuthenticationRefusedResult_None = 1,
EHPMAuthenticationRefusedResult_InvalidLogin = 2,
EHPMAuthenticationRefusedResult_LoginDisabled = 3,
EHPMAuthenticationRefusedResult_InActiveAccount = 4,
EHPMAuthenticationRefusedResult_HelixAuthError = 5,
EHPMAuthenticationRefusedResult_HelixAuthUserNotFound = 6,
};
Values
EHPMAuthenticationRefusedResult_NewVersionOfSDKRequired
Upgrade to a newer version of the SDK to be able to use this result.
EHPMAuthenticationRefusedResult_None
Login was successful.
EHPMAuthenticationRefusedResult_InvalidLogin
Invalid username or password.
EHPMAuthenticationRefusedResult_LoginDisabled
User account is disabled.
EHPMAuthenticationRefusedResult_InActiveAccount
User account is inactive
EHPMAuthenticationRefusedResult_HelixAuthError
Error using Helix Auth for SSO
EHPMAuthenticationRefusedResult_HelixAuthUserNotFound
User was validated by Helix Auth but did not match to a Helix Plan user account
See Also
HPMChangeCallbackData_AuthenticationResolveCredentialsResponse , AuthenticationResolveCredentials
HPMChangeCallbackData_GlobalStatisticsSettingsChange
Callback data type for HPMChangeCallbackInfo::m_pCallbackData when HPMChangeCallbackInfo::m_Operation is set to EHPMChangeCallbackOperation_GlobalStatisticsSettingsChange.
struct HPMChangeCallbackData_GlobalStatisticsSettingsChange {
HPMInt32 m_bChangeInitiatedFromThisSession;
HPMUniqueID m_ChangedByResourceID;
HPMUniqueID m_ChangedByImpersonatedResourceID;
} HPMChangeCallbackData_GlobalStatisticsSettingsChange;
Members
m_bChangeInitiatedFromThisSession
Set to 1 if this change in the database was the result of an operation that was initiated from this session.
m_ChangedByResourceID
The unique identifier of the resource that initiated the change.
m_ChangedByImpersonatedResourceID
The unique identifier of the impersonated resource that initiated the change.
See Also
EHPMChangeCallbackOperation, HPMChangeCallbackInfo
HPMChangeCallbackData_GlobalServerNameChange
Callback data type for HPMChangeCallbackInfo::m_pCallbackData when HPMChangeCallbackInfo::m_Operation is set to EHPMChangeCallbackOperation_GlobalServerNameChange.
struct HPMChangeCallbackData_GlobalServerNameChange {
HPMInt32 m_bChangeInitiatedFromThisSession;
HPMUniqueID m_ChangedByResourceID;
HPMUniqueID m_ChangedByImpersonatedResourceID;
} HPMChangeCallbackData_GlobalServerNameChange;
Members
m_bChangeInitiatedFromThisSession
Set to 1 if this change in the database was the result of an operation that was initiated from this session.
m_ChangedByResourceID
The unique identifier of the resource that initiated the change.
m_ChangedByImpersonatedResourceID
The unique identifier of the impersonated resource that initiated the change.
See Also
EHPMChangeCallbackOperation, HPMChangeCallbackInfo
HPMChangeCallbackData_GlobalDocumentAttachmentLimitChange
Callback data type for HPMChangeCallbackInfo::m_pCallbackData when HPMChangeCallbackInfo::m_Operation is set to EHPMChangeCallbackOperation_GlobalDocumentAttachmentLimitChange.
struct HPMChangeCallbackData_GlobalDocumentAttachmentLimitChange {
HPMInt32 m_bChangeInitiatedFromThisSession;
HPMUniqueID m_ChangedByResourceID;
HPMUniqueID m_ChangedByImpersonatedResourceID;
} HPMChangeCallbackData_GlobalDocumentAttachmentLimitChange;
Members
m_bChangeInitiatedFromThisSession
Set to 1 if this change in the database was the result of an operation that was initiated from this session.
m_ChangedByResourceID
The unique identifier of the resource that initiated the change.
m_ChangedByImpersonatedResourceID
The unique identifier of the impersonated resource that initiated the change.
See Also
EHPMChangeCallbackOperation, HPMChangeCallbackInfo
HPMChangeCallbackData_GlobalDocumentAttachmentCommentRequiredChange
Callback data type for HPMChangeCallbackInfo::m_pCallbackData when HPMChangeCallbackInfo::m_Operation is set to EHPMChangeCallbackOperation_GlobalDocumentAttachmentCommentRequiredChange
struct HPMChangeCallbackData_GlobalDocumentAttachmentCommentRequiredChange {
HPMInt32 m_bChangeInitiatedFromThisSession;
HPMUniqueID m_ChangedByResourceID;
HPMUniqueID m_ChangedByImpersonatedResourceID;
} HPMChangeCallbackData_GlobalDocumentAttachmentCommentRequiredChange;
Members
m_bChangeInitiatedFromThisSession
Set to 1 if this change in the database was the result of an operation that was initiated from this session.
m_ChangedByResourceID
The unique identifier of the resource that initiated the change.
m_ChangedByImpersonatedResourceID
The unique identifier of the impersonated resource that initiated the change.
See Also
EHPMChangeCallbackOperation, HPMChangeCallbackInfo
HPMChangeCallbackData_AuthenticationProtocolBegin
Callback data type for HPMChangeCallbackInfo::m_pCallbackData when HPMChangeCallbackInfo::m_Operation is set to EHPMChangeCallbackOperation_AuthenticationProtocolBegin.
struct HPMChangeCallbackData_AuthenticationProtocolBegin {
const HPMChar * m_pIdentifier;
const HPMChar * m_pUserName;
const HPMChar * m_pPassword;
} HPMChangeCallbackData_AuthenticationProtocolBegin;
Members
m_pIdentifier
the identifier of the authentication method to start. The Plugin had previously registered this method using the AuthenticationClientPluginRegister function.
m_pUserName
the user name entered into the login dialog by the user.
m_pPassword
the password entered into the login dialog by the user.
See Also
EHPMChangeCallbackOperation, HPMChangeCallbackInfo
HPMChangeCallbackData_CommunicationChannelPacketReceived
Callback data type for HPMChangeCallbackInfo::m_pCallbackData when HPMChangeCallbackInfo::m_Operation is set to EHPMChangeCallbackOperation_CommunicationChannelPacketReceived.
struct HPMChangeCallbackData_CommunicationChannelPacketReceived {
const HPMChar * m_pChannelName;
HPMUInt64 m_ToSessionID;
HPMUInt64 m_FromSessionID;
HPMCommunicationChannelPacket m_Packet;
} HPMChangeCallbackData_CommunicationChannelPacketReceived;
Members
m_pChannelName
The name of the channel on which the packet was sent.
m_ToSessionID
The identifier of the SDK session to which the packet was sent, or 0 if the packet was sent to the channel's owner session.
m_FromSessionID
The identifier of the SDK session that sent the packet.
m_Packet
The packet's data and settings
See Also
EHPMChangeCallbackOperation, HPMChangeCallbackInfo
HPMChangeCallbackData_CommunicationChannelPacketDropped
Callback data type for HPMChangeCallbackInfo::m_pCallbackData when HPMChangeCallbackInfo::m_Operation is set to EHPMChangeCallbackOperation_CommunicationChannelPacketDropped.
struct HPMChangeCallbackData_CommunicationChannelPacketDropped {
const HPMChar * m_pChannelName;
HPMUInt64 m_ToSessionID;
HPMUInt64 m_FromSessionID;
HPMCommunicationChannelPacket m_Packet;
HPMInt32 m_Reason;
} HPMChangeCallbackData_CommunicationChannelPacketDropped;
Members
m_pChannelName
The name of the channel for which the packet was intended.
m_ToSessionID
The identifier of the SDK session for which the packet was intended, or 0 if the packet was sent to the channel's owner session.
m_FromSessionID
The identifier of the SDK session that sent the packet, that is: the session receiving this callback.
m_Packet
The packet that was dropped
m_Reason
The reason why the packet was dropped, one of EHPMPacketDropReason.
See Also
EHPMChangeCallbackOperation, HPMChangeCallbackInfo
HPMChangeCallbackData_CommunicationChannelRegisterFailed
Callback data type for HPMChangeCallbackInfo::m_pCallbackData when HPMChangeCallbackInfo::m_Operation is set to EHPMChangeCallbackOperation_CommunicationChannelRegisterFailed.
struct HPMChangeCallbackData_CommunicationChannelRegisterFailed {
const HPMChar * m_pChannelName;
HPMInt32 m_Reason;
} HPMChangeCallbackData_CommunicationChannelRegisterFailed;
Members
m_pChannelName
The name of the channel to which the session attempted to register.
m_Reason
The reason why the registration failed, one of EHPMChannelRegisterFailReason.
See Also
EHPMChangeCallbackOperation, HPMChangeCallbackInfo, CommunicationChannelRegister
HPMChangeCallbackData_CommunicationChannelsChanged
Callback data type for HPMChangeCallbackInfo::m_pCallbackData when HPMChangeCallbackInfo::m_Operation is set to EHPMChangeCallbackOperation_CommunicationChannelsChanged.
struct HPMChangeCallbackData_CommunicationChannelsChanged {
const HPMChar * m_pChannelName;
} HPMChangeCallbackData_CommunicationChannelsChanged;
Members
m_pChannelName
The name of the channel that was registered.
See Also
EHPMChangeCallbackOperation, HPMChangeCallbackInfo, CommunicationChannelRegister
HPMChangeCallbackData_AuthenticationResolveCredentials
Callback data type for HPMChangeCallbackInfo::m_pCallbackData when HPMChangeCallbackInfo::m_Operation is set to EHPMChangeCallbackOperation_AuthenticationResolveCredentials.
struct HPMChangeCallbackData_AuthenticationResolveCredentials {
const HPMChar * m_pChannelName;
HPMUInt64 m_ToSessionID;
HPMUInt64 m_FromSessionID;
HPMUInt64 m_Context;
const HPMChar * m_pUserName;
const HPMChar * m_pPassword;
const HPMChar * m_pSource;
} HPMChangeCallbackData_AuthenticationResolveCredentials;
Members
m_pChannelName
The name of the channel on which the credential check request was sent.
m_ToSessionID
The identifier of the SDK session to which the packet was sent, that is: this session.
m_FromSessionID
The identifier of the SDK session requesting the credentials check.
m_Context
Set to the _Context value that was passed to AuthenticationResolveCredentials
m_pUserName
the user name to check.
m_pPassword
the password to check.
m_pSource
the origin of request.
See Also
EHPMChangeCallbackOperation, HPMChangeCallbackInfo
HPMChangeCallbackData_AuthenticationResolveCredentialsResponse
Callback data type for HPMChangeCallbackInfo::m_pCallbackData when HPMChangeCallbackInfo::m_Operation is set to EHPMChangeCallbackOperation_AuthenticationResolveCredentialsResponse.
struct HPMChangeCallbackData_AuthenticationResolveCredentialsResponse {
const HPMChar * m_pUserName;
HPMUniqueID m_ResourceID;
HPMUInt64 m_AuthSessionID;
HPMUInt64 m_Context;
const HPMChar * m_pErrorText;
HPMInt32 m_bExpired;
HPMInt32 m_RefusedResult;
const HPMChar * m_pAuthToken;
} HPMChangeCallbackData_AuthenticationResolveCredentialsResponse;
Members
m_pUserName
The user name that was checked
m_ResourceID
Set to 0 if the credential resolution failed, otherwise: the User ID of the user that was verified.
m_AuthSessionID
If m_ResourceID != 0: the identifier of the SDK session that performed the credential resolution.
m_Context
Set to the _Context value that was passed to AuthenticationResolveCredentials
m_pErrorText
Valid only if resolution failed.
m_bExpired
. True if password expired.
m_RefusedResult
. Authentication refused result, valid only if resolution failed.
m_pAuthToken
The new token generated by success login for specified source.
See Also
EHPMChangeCallbackOperation, HPMChangeCallbackInfo
HPMChangeCallbackData_AuthenticationResolveCredentialsHelixAuthUrl
Callback data type for HPMChangeCallbackInfo::m_pCallbackData when HPMChangeCallbackInfo::m_Operation is set to EHPMChangeCallbackOperation_AuthenticationResolveCredentialsHelixAuthUrl.
struct HPMChangeCallbackData_AuthenticationResolveCredentialsHelixAuthUrl {
HPMUInt64 m_Context;
const HPMChar * m_pAuthenticationUrl;
} HPMChangeCallbackData_AuthenticationResolveCredentialsHelixAuthUrl;
Members
m_Context
Set to the _Context value that was passed to AuthenticationResolveCredentialsHelixAuth
m_pAuthenticationUrl
The URL to be used by client to initiate the Helix authentication
See Also
EHPMChangeCallbackOperation, HPMChangeCallbackInfo
HPMChangeCallbackData_ResourceCreate
Callback data type for HPMChangeCallbackInfo::m_pCallbackData when HPMChangeCallbackInfo::m_Operation is set to EHPMChangeCallbackOperation_ResourceCreate.
struct HPMChangeCallbackData_ResourceCreate {
HPMInt32 m_bChangeInitiatedFromThisSession;
HPMUniqueID m_ChangedByResourceID;
HPMUniqueID m_ChangedByImpersonatedResourceID;
HPMUniqueID m_ResourceID;
HPMUniqueID m_TemporaryResourceID;
} HPMChangeCallbackData_ResourceCreate;
Members
m_bChangeInitiatedFromThisSession
Set to 1 if this change in the database was the result of an operation that was initiated from this session.
m_ChangedByResourceID
The unique identifier of the resource that initiated the change.
m_ChangedByImpersonatedResourceID
The unique identifier of the impersonated resource that initiated the change.
m_ResourceID
The unique identifier of the created resource.
m_TemporaryResourceID
When in nonblocking mode this is the identifier returned from the ResourceCreate function.
See Also
EHPMChangeCallbackOperation, HPMChangeCallbackInfo
HPMChangeCallbackData_ResourceDelete
Callback data type for HPMChangeCallbackInfo::m_pCallbackData when HPMChangeCallbackInfo::m_Operation is set to EHPMChangeCallbackOperation_ResourceDelete.
struct HPMChangeCallbackData_ResourceDelete {
HPMInt32 m_bChangeInitiatedFromThisSession;
HPMUniqueID m_ChangedByResourceID;
HPMUniqueID m_ChangedByImpersonatedResourceID;
HPMUniqueID m_ResourceID;
} HPMChangeCallbackData_ResourceDelete;
Members
m_bChangeInitiatedFromThisSession
Set to 1 if this change in the database was the result of an operation that was initiated from this session.
m_ChangedByResourceID
The unique identifier of the resource that initiated the change.
m_ChangedByImpersonatedResourceID
The unique identifier of the impersonated resource that initiated the change.
m_ResourceID
The unique identifier of the deleted resource.
See Also
EHPMChangeCallbackOperation, HPMChangeCallbackInfo
HPMChangeCallbackData_ResourcePropertiesChange
Callback data type for HPMChangeCallbackInfo::m_pCallbackData when HPMChangeCallbackInfo::m_Operation is set to EHPMChangeCallbackOperation_ResourcePropertiesChange.
struct HPMChangeCallbackData_ResourcePropertiesChange {
HPMInt32 m_bChangeInitiatedFromThisSession;
HPMUniqueID m_ChangedByResourceID;
HPMUniqueID m_ChangedByImpersonatedResourceID;
HPMUniqueID m_ResourceID;
} HPMChangeCallbackData_ResourcePropertiesChange;
Members
m_bChangeInitiatedFromThisSession
Set to 1 if this change in the database was the result of an operation that was initiated from this session.
m_ChangedByResourceID
The unique identifier of the resource that initiated the change.
m_ChangedByImpersonatedResourceID
The unique identifier of the impersonated resource that initiated the change.
m_ResourceID
The unique identifier of the resource that properties was changed on.
See Also
EHPMChangeCallbackOperation, HPMChangeCallbackInfo
HPMChangeCallbackData_ResourceGlobalSettingsChange
Callback data type for HPMChangeCallbackInfo::m_pCallbackData when HPMChangeCallbackInfo::m_Operation is set to EHPMChangeCallbackOperation_ResourceGlobalSettingsChange.
struct HPMChangeCallbackData_ResourceGlobalSettingsChange {
HPMInt32 m_bChangeInitiatedFromThisSession;
HPMUniqueID m_ChangedByResourceID;
HPMUniqueID m_ChangedByImpersonatedResourceID;
HPMUniqueID m_ResourceID;
} HPMChangeCallbackData_ResourceGlobalSettingsChange;
Members
m_bChangeInitiatedFromThisSession
Set to 1 if this change in the database was the result of an operation that was initiated from this session.
m_ChangedByResourceID
The unique identifier of the resource that initiated the change.
m_ChangedByImpersonatedResourceID
The unique identifier of the impersonated resource that initiated the change.
m_ResourceID
The unique identifier of the resource that global settings was changed for.
See Also
EHPMChangeCallbackOperation, HPMChangeCallbackInfo
HPMChangeCallbackData_ResourceLicenseViolation
Callback data type for HPMChangeCallbackInfo::m_pCallbackData when HPMChangeCallbackInfo::m_Operation is set to EHPMChangeCallbackOperation_ResourceLicenseViolation.
struct HPMChangeCallbackData_ResourceLicenseViolation {
HPMInt32 m_bChangeInitiatedFromThisSession;
HPMUniqueID m_ChangedByResourceID;
HPMUniqueID m_ChangedByImpersonatedResourceID;
HPMInt32 m_ViolationReason;
} HPMChangeCallbackData_ResourceLicenseViolation;
Members
m_bChangeInitiatedFromThisSession
Set to 1 if this license violation was the result of an operation that was initiated from this session.
m_ChangedByResourceID
The unique identifier of the resource that initiated the change.
m_ChangedByImpersonatedResourceID
The unique identifier of the impersonated resource that initiated the change.
m_ViolationReason
The reason the license was violated. Can be one of EHPMLicenseViolationReason.
See Also
EHPMChangeCallbackOperation, HPMChangeCallbackInfo, EHPMLicenseViolationReason
HPMChangeCallbackData_ResourceLockFlagsChange
Callback data type for HPMChangeCallbackInfo::m_pCallbackData when HPMChangeCallbackInfo::m_Operation is set to EHPMChangeCallbackOperation_ResourceLockFlagsChange.
struct HPMChangeCallbackData_ResourceLockFlagsChange {
HPMInt32 m_bChangeInitiatedFromThisSession;
HPMUniqueID m_ChangedByResourceID;
HPMUniqueID m_ChangedByImpersonatedResourceID;
HPMUniqueID m_ResourceID;
} HPMChangeCallbackData_ResourceLockFlagsChange;
Members
m_bChangeInitiatedFromThisSession
Set to 1 if this change in the database was the result of an operation that was initiated from this session.
m_ChangedByResourceID
The unique identifier of the resource that initiated the change.
m_ChangedByImpersonatedResourceID
The unique identifier of the impersonated resource that initiated the change.
m_ResourceID
The unique identifier of the resource that lock flags was changed for.
See Also
EHPMChangeCallbackOperation, HPMChangeCallbackInfo
HPMChangeCallbackData_ResourcePreferredLanguageChange
Callback data type for HPMChangeCallbackInfo::m_pCallbackData when HPMChangeCallbackInfo::m_Operation is set to EHPMChangeCallbackOperation_ResourcePreferredLanguageChange.
struct HPMChangeCallbackData_ResourcePreferredLanguageChange {
HPMInt32 m_bChangeInitiatedFromThisSession;
HPMUniqueID m_ChangedByResourceID;
HPMUniqueID m_ChangedByImpersonatedResourceID;
HPMUniqueID m_ResourceID;
HPMUInt16 m_LanguageID;
const HPMChar * m_pCustomLanguageID;
} HPMChangeCallbackData_ResourcePreferredLanguageChange;
Members
m_bChangeInitiatedFromThisSession
Set to 1 if this change in the database was the result of an operation that was initiated from this session.
m_ChangedByResourceID
The unique identifier of the resource that initiated the change.
m_ChangedByImpersonatedResourceID
The unique identifier of the impersonated resource that initiated the change.
m_ResourceID
The unique identifier of the resource that preferred language was changed for.
m_LanguageID
The language id of the new language
m_pCustomLanguageID
The custom language id of the new language
See Also
EHPMChangeCallbackOperation, HPMChangeCallbackInfo
HPMChangeCallbackData_ResourceLastUsedLanguageChange
Callback data type for HPMChangeCallbackInfo::m_pCallbackData when HPMChangeCallbackInfo::m_Operation is set to EHPMChangeCallbackOperation_ResourceLastUsedLanguageChange.
struct HPMChangeCallbackData_ResourceLastUsedLanguageChange {
HPMInt32 m_bChangeInitiatedFromThisSession;
HPMUniqueID m_ChangedByResourceID;
HPMUniqueID m_ChangedByImpersonatedResourceID;
HPMUniqueID m_ResourceID;
HPMUInt16 m_LanguageID;
const HPMChar * m_pCustomLanguageID;
} HPMChangeCallbackData_ResourceLastUsedLanguageChange;
Members
m_bChangeInitiatedFromThisSession
Set to 1 if this change in the database was the result of an operation that was initiated from this session.
m_ChangedByResourceID
The unique identifier of the resource that initiated the change.
m_ChangedByImpersonatedResourceID
The unique identifier of the impersonated resource that initiated the change.
m_ResourceID
The unique identifier of the resource that preferred language was changed for.
m_LanguageID
The language id of the new language
m_pCustomLanguageID
The custom language id of the new language
See Also
EHPMChangeCallbackOperation, HPMChangeCallbackInfo
HPMChangeCallbackData_ResourceGroupsChange
Callback data type for HPMChangeCallbackInfo::m_pCallbackData when HPMChangeCallbackInfo::m_Operation is set to EHPMChangeCallbackOperation_ResourceGroupsChange.
struct HPMChangeCallbackData_ResourceGroupsChange {
HPMInt32 m_bChangeInitiatedFromThisSession;
HPMUniqueID m_ChangedByResourceID;
HPMUniqueID m_ChangedByImpersonatedResourceID;
} HPMChangeCallbackData_ResourceGroupsChange;
Members
m_bChangeInitiatedFromThisSession
Set to 1 if this change in the database was the result of an operation that was initiated from this session.
m_ChangedByResourceID
The unique identifier of the resource that initiated the change.
m_ChangedByImpersonatedResourceID
The unique identifier of the impersonated resource that initiated the change.
See Also
EHPMChangeCallbackOperation, HPMChangeCallbackInfo
HPMChangeCallbackData_ProjectViewPresetsApplied
Callback data type for HPMChangeCallbackInfo::m_pCallbackData when HPMChangeCallbackInfo::m_Operation is set to EHPMChangeCallbackOperation_ProjectViewPresetsApplied.
struct HPMChangeCallbackData_ProjectViewPresetsApplied {
HPMInt32 m_bChangeInitiatedFromThisSession;
HPMUniqueID m_ChangedByResourceID;
HPMUniqueID m_ChangedByImpersonatedResourceID;
HPMUniqueID m_ResourceID;
HPMUniqueID m_ProjectID;
} HPMChangeCallbackData_ProjectViewPresetsApplied;
Members
m_bChangeInitiatedFromThisSession
Set to 1 if this change in the database was the result of an operation that was initiated from this session.
m_ChangedByResourceID
The unique identifier of the resource that initiated the change.
m_ChangedByImpersonatedResourceID
The unique identifier of the impersonated resource that initiated the change.
m_ResourceID
The unique identifier of the resource that the presets have been applied for.
m_ProjectID
The unique identifier of the project the presets have been applied in.
See Also
EHPMChangeCallbackOperation, HPMChangeCallbackInfo
HPMChangeCallbackData_ProjectResourceParentTaskDisplayDepthChange
Callback data type for HPMChangeCallbackInfo::m_pCallbackData when HPMChangeCallbackInfo::m_Operation is set to EHPMChangeCallbackOperation_ProjectResourceParentTaskDisplayDepthChange.
struct HPMChangeCallbackData_ProjectResourceParentTaskDisplayDepthChange {
HPMInt32 m_bChangeInitiatedFromThisSession;
HPMUniqueID m_ChangedByResourceID;
HPMUniqueID m_ResourceID;
HPMUniqueID m_ProjectID;
HPMInt32 m_ParentTaskDisplayDepth;
} HPMChangeCallbackData_ProjectResourceParentTaskDisplayDepthChange;
Members
m_bChangeInitiatedFromThisSession
Set to 1 if this change in the database was the result of an operation that was initiated from this session.
m_ChangedByResourceID
The unique identifier of the resource that initiated the change.
m_ResourceID
The unique identifier of the resource that the parent task display depth have been applied for.
m_ProjectID
The unique identifier of the project the parent task display depth have been applied in.
m_ParentTaskDisplayDepth
The value of the parent task display depth that was applied.
See Also
EHPMChangeCallbackOperation, HPMChangeCallbackInfo
HPMChangeCallbackData_ProjectViewPresetCreate
Callback data type for HPMChangeCallbackInfo::m_pCallbackData when HPMChangeCallbackInfo::m_Operation is set to EHPMChangeCallbackOperation_ProjectViewPresetCreate.
struct HPMChangeCallbackData_ProjectViewPresetCreate {
HPMInt32 m_bChangeInitiatedFromThisSession;
HPMUniqueID m_ChangedByResourceID;
HPMUniqueID m_ChangedByImpersonatedResourceID;
HPMUniqueID m_ProjectID;
HPMUniqueID m_ResourceID;
HPMUniqueID m_PresetID;
HPMUniqueID m_LocalID;
} HPMChangeCallbackData_ProjectViewPresetCreate;
Members
m_bChangeInitiatedFromThisSession
Set to 1 if this change in the database was the result of an operation that was initiated from this session.
m_ChangedByResourceID
The unique identifier of the resource that initiated the change.
m_ChangedByImpersonatedResourceID
The unique identifier of the impersonated resource that initiated the change.
m_ProjectID
The unique identifier of the project the preset was created in.
m_ResourceID
The unique identifier of the resource that created the preset.
m_PresetID
The unique identifier of created preset.
m_LocalID
The local identifier of created preset.
See Also
EHPMChangeCallbackOperation, HPMChangeCallbackInfo
HPMChangeCallbackData_ProjectViewPresetChange
Callback data type for HPMChangeCallbackInfo::m_pCallbackData when HPMChangeCallbackInfo::m_Operation is set to EHPMChangeCallbackOperation_ProjectViewPresetChange.
struct HPMChangeCallbackData_ProjectViewPresetChange {
HPMInt32 m_bChangeInitiatedFromThisSession;
HPMUniqueID m_ChangedByResourceID;
HPMUniqueID m_ChangedByImpersonatedResourceID;
HPMUniqueID m_ProjectID;
HPMUniqueID m_ResourceID;
HPMUniqueID m_PresetID;
} HPMChangeCallbackData_ProjectViewPresetChange;
Members
m_bChangeInitiatedFromThisSession
Set to 1 if this change in the database was the result of an operation that was initiated from this session.
m_ChangedByResourceID
The unique identifier of the resource that initiated the change.
m_ChangedByImpersonatedResourceID
The unique identifier of the impersonated resource that initiated the change.
m_ProjectID
The unique identifier of the project the preset changed in.
m_ResourceID
The unique identifier of the resource that changed the presets.
m_PresetID
The unique identifier of edited preset.
See Also
EHPMChangeCallbackOperation, HPMChangeCallbackInfo
HPMChangeCallbackData_ProjectViewPresetDelete
Callback data type for HPMChangeCallbackInfo::m_pCallbackData when HPMChangeCallbackInfo::m_Operation is set to EHPMChangeCallbackOperation_ProjectViewPresetDelete.
struct HPMChangeCallbackData_ProjectViewPresetDelete {
HPMInt32 m_bChangeInitiatedFromThisSession;
HPMUniqueID m_ChangedByResourceID;
HPMUniqueID m_ChangedByImpersonatedResourceID;
HPMUniqueID m_ProjectID;
HPMUniqueID m_ResourceID;
HPMUniqueID m_PresetID;
} HPMChangeCallbackData_ProjectViewPresetDelete;
Members
m_bChangeInitiatedFromThisSession
Set to 1 if this change in the database was the result of an operation that was initiated from this session.
m_ChangedByResourceID
The unique identifier of the resource that initiated the change.
m_ChangedByImpersonatedResourceID
The unique identifier of the impersonated resource that initiated the change.
m_ProjectID
The unique identifier of the project the preset was deleted in.
m_ResourceID
The unique identifier of the resource that deleted the presets.
m_PresetID
The unique identifier of edited preset.
See Also
EHPMChangeCallbackOperation, HPMChangeCallbackInfo
HPMChangeCallbackData_ResourceTimesheetWeekDataChange
Callback data type for HPMChangeCallbackInfo::m_pCallbackData when HPMChangeCallbackInfo::m_Operation is set to EHPMChangeCallbackOperation_ResourceTimesheetWeekDataChange.
struct HPMChangeCallbackData_ResourceTimesheetWeekDataChange {
HPMInt32 m_bChangeInitiatedFromThisSession;
HPMUniqueID m_ChangedByResourceID;
HPMUniqueID m_ChangedByImpersonatedResourceID;
HPMUniqueID m_ResourceID;
HPMUInt32 m_Year;
HPMUInt32 m_Week;
} HPMChangeCallbackData_ResourceTimesheetWeekDataChange;
Members
m_bChangeInitiatedFromThisSession
Set to 1 if this change in the database was the result of an operation that was initiated from this session.
m_ChangedByResourceID
The unique identifier of the resource that initiated the change.
m_ChangedByImpersonatedResourceID
The unique identifier of the impersonated resource that initiated the change.
m_ResourceID
The unique identifier of the resource that the timesheet week data has been changed for.
m_Year
The year that timesheet week data has been changed for.
m_Week
The week of year that timesheet week data has been changed for.
See Also
EHPMChangeCallbackOperation, HPMChangeCallbackInfo
HPMChangeCallbackData_GlobalTimesheetConfigChange
Callback data type for HPMChangeCallbackInfo::m_pCallbackData when HPMChangeCallbackInfo::m_Operation is set to EHPMChangeCallbackOperation_GlobalTimesheetConfigChange.
struct HPMChangeCallbackData_GlobalTimesheetConfigChange {
HPMInt32 m_bChangeInitiatedFromThisSession;
HPMUniqueID m_ChangedByResourceID;
HPMUniqueID m_ChangedByImpersonatedResourceID;
} HPMChangeCallbackData_GlobalTimesheetConfigChange;
Members
m_bChangeInitiatedFromThisSession
Set to 1 if this change in the database was the result of an operation that was initiated from this session.
m_ChangedByResourceID
The unique identifier of the resource that initiated the change.
m_ChangedByImpersonatedResourceID
The unique identifier of the impersonated resource that initiated the change.
See Also
EHPMChangeCallbackOperation, HPMChangeCallbackInfo
HPMChangeCallbackData_ResourceTimesheetPeriodDataDelete
Callback data type for HPMChangeCallbackInfo::m_pCallbackData when HPMChangeCallbackInfo::m_Operation is set to EHPMChangeCallbackOperation_ResourceTimesheetPeriodDataDelete.
struct HPMChangeCallbackData_ResourceTimesheetPeriodDataDelete {
HPMInt32 m_bChangeInitiatedFromThisSession;
HPMUniqueID m_ChangedByResourceID;
HPMUniqueID m_ChangedByImpersonatedResourceID;
HPMUniqueID m_ResourceID;
HPMUInt64 m_Date;
} HPMChangeCallbackData_ResourceTimesheetPeriodDataDelete;
Members
m_bChangeInitiatedFromThisSession
Set to 1 if this change in the database was the result of an operation that was initiated from this session.
m_ChangedByResourceID
The unique identifier of the resource that initiated the change.
m_ChangedByImpersonatedResourceID
The unique identifier of the impersonated resource that initiated the change.
m_ResourceID
The unique identifier of the resource that deleted the reports.
m_Date
The end date up until the reports where deleted. Expressed as the number of microseconds since 1970 UTC.
See Also
EHPMChangeCallbackOperation, HPMChangeCallbackInfo
HPMChangeCallbackData_ProjectTimesheetLockChange
Callback data type for HPMChangeCallbackInfo::m_pCallbackData when HPMChangeCallbackInfo::m_Operation is set to EHPMChangeCallbackOperation_ProjectTimesheetLockChange.
struct HPMChangeCallbackData_ProjectTimesheetLockChange {
HPMInt32 m_bChangeInitiatedFromThisSession;
HPMUniqueID m_ChangedByResourceID;
HPMUniqueID m_ChangedByImpersonatedResourceID;
HPMUniqueID m_ProjectID;
} HPMChangeCallbackData_ProjectTimesheetLockChange;
Members
m_bChangeInitiatedFromThisSession
Set to 1 if this change in the database was the result of an operation that was initiated from this session.
m_ChangedByResourceID
The unique identifier of the resource that initiated the change.
m_ChangedByImpersonatedResourceID
The unique identifier of the impersonated resource that initiated the change.
m_ProjectID
The unique identifier of the resource that deleted the reports.
See Also
EHPMChangeCallbackOperation, HPMChangeCallbackInfo
HPMChangeCallbackData_ResourceGetTimesheetDayResponse
Callback data type for HPMChangeCallbackInfo::m_pCallbackData when HPMChangeCallbackInfo::m_Operation is set to EHPMChangeCallbackOperation_ResourceGetTimesheetDayResponse.
struct HPMChangeCallbackData_ResourceGetTimesheetDayResponse {
HPMInt32 m_bChangeInitiatedFromThisSession;
HPMUniqueID m_ChangedByResourceID;
HPMUniqueID m_ChangedByImpersonatedResourceID;
HPMTimesheetDay m_Day;
HPMInt32 m_CurrentHighestRowID;
} HPMChangeCallbackData_ResourceGetTimesheetDayResponse;
Members
m_bChangeInitiatedFromThisSession
Set to 1 if this change in the database was the result of an operation that was initiated from this session.
m_ChangedByResourceID
The unique identifier of the resource that initiated the change.
m_ChangedByImpersonatedResourceID
The unique identifier of the impersonated resource that initiated the change.
m_Day
The timesheet day data.
m_CurrentHighestRowID
The current highest used row id.
See Also
EHPMChangeCallbackOperation, HPMChangeCallbackInfo
HPMChangeCallbackData_TimesheetGetDateRangeResponse
Callback data type for HPMChangeCallbackInfo::m_pCallbackData when HPMChangeCallbackInfo::m_Operation is set to EHPMChangeCallbackOperation_TimesheetGetDateRangeResponse.
struct HPMChangeCallbackData_TimesheetGetDateRangeResponse {
HPMInt32 m_bChangeInitiatedFromThisSession;
HPMUniqueID m_ChangedByResourceID;
HPMUniqueID m_ChangedByImpersonatedResourceID;
HPMUInt32 m_nTimesheetDays;
const HPMTimesheetDay * m_pTimesheetDays;
} HPMChangeCallbackData_TimesheetGetDateRangeResponse;
Members
m_bChangeInitiatedFromThisSession
Set to 1 if this change in the database was the result of an operation that was initiated from this session.
m_ChangedByResourceID
The unique identifier of the resource that initiated the change.
m_ChangedByImpersonatedResourceID
The unique identifier of the impersonated resource that initiated the change.
m_nTimesheetDays
The number of timesheet posts in the report.
m_pTimesheetDays
Pointer to a list of HPMTimesheetDay timesheet posts.
See Also
EHPMChangeCallbackOperation, HPMChangeCallbackInfo
HPMChangeCallbackData_TimesheetRowChange
Callback data type for HPMChangeCallbackInfo::m_pCallbackData when HPMChangeCallbackInfo::m_Operation is set to EHPMChangeCallbackOperation_TimesheetRowChange.
struct HPMChangeCallbackData_TimesheetRowChange {
HPMInt32 m_bChangeInitiatedFromThisSession;
HPMUniqueID m_ChangedByResourceID;
HPMUniqueID m_ChangedByImpersonatedResourceID;
HPMUniqueID m_DayID;
HPMUInt32 m_RowID;
HPMInt32 m_FieldID;
} HPMChangeCallbackData_TimesheetRowChange;
Members
m_bChangeInitiatedFromThisSession
Set to 1 if this change in the database was the result of an operation that was initiated from this session.
m_ChangedByResourceID
The unique identifier of the resource that initiated the change.
m_ChangedByImpersonatedResourceID
The unique identifier of the impersonated resource that initiated the change.
m_DayID
The unique identifier of the resource that the timesheet day data has been created for.
m_RowID
The unique identifier of the day that the timesheet day data has been created for.
m_FieldID
The field type of the field in the row that was changed. Can be one of EHPMTimesheetField.
See Also
EHPMChangeCallbackOperation, HPMChangeCallbackInfo
HPMChangeCallbackData_ProjectDisplayUserMessage
Callback data type for HPMChangeCallbackInfo::m_pCallbackData when HPMChangeCallbackInfo::m_Operation is set to EHPMChangeCallbackOperation_ProjectDisplayUserMessage.
struct HPMChangeCallbackData_ProjectDisplayUserMessage {
HPMInt32 m_bChangeInitiatedFromThisSession;
HPMUniqueID m_ChangedByResourceID;
HPMUniqueID m_ChangedByImpersonatedResourceID;
HPMUniqueID m_ProjectID;
HPMUniqueID m_ResourceID;
HPMInt32 m_MessageType;
const HPMUntranslatedString * m_pMessage;
} HPMChangeCallbackData_ProjectDisplayUserMessage;
Members
m_bChangeInitiatedFromThisSession
Set to 1 if this change in the database was the result of an operation that was initiated from this session.
m_ChangedByResourceID
The unique identifier of the resource that initiated the change.
m_ChangedByImpersonatedResourceID
The unique identifier of the impersonated resource that initiated the change.
m_ProjectID
The unique identifier of the project to display the message in client for.
m_ResourceID
The unique identifier of the resource to display the message in client for if the resource is logged in.
m_MessageType
The type of user message to display. Can be one of EHPMProjectUserMessageType.
m_pMessage
The message to display.
See Also
EHPMChangeCallbackOperation, HPMChangeCallbackInfo
HPMChangeCallbackData_IDNoLongerExists
Callback data type for HPMChangeCallbackInfo::m_pCallbackData when HPMChangeCallbackInfo::m_Operation is set to EHPMChangeCallbackOperation_IDNoLongerExists.
struct HPMChangeCallbackData_IDNoLongerExists {
HPMInt32 m_bChangeInitiatedFromThisSession;
} HPMChangeCallbackData_IDNoLongerExists;
Members
m_bChangeInitiatedFromThisSession
Set to 1 if this change in the database was the result of an operation that was initiated from this session.
See Also
EHPMChangeCallbackOperation, HPMChangeCallbackInfo
HPMChangeCallbackData_ChatMessage
Callback data type for HPMChangeCallbackInfo::m_pCallbackData when HPMChangeCallbackInfo::m_Operation is set to EHPMChangeCallbackOperation_ChatMessage.
struct HPMChangeCallbackData_ChatMessage {
HPMInt32 m_bChangeInitiatedFromThisSession;
HPMUniqueID m_ChangedByResourceID;
HPMUniqueID m_ChangedByImpersonatedResourceID;
HPMUniqueID m_ResourceID;
HPMChatRoom m_ChatRoom;
const HPMChar * m_Message;
} HPMChangeCallbackData_ChatMessage;
Members
m_bChangeInitiatedFromThisSession
Set to 1 if this change in the database was the result of an operation that was initiated from this session.
m_ChangedByResourceID
The unique identifier of the resource that initiated the change.
m_ChangedByImpersonatedResourceID
The unique identifier of the impersonated resource that initiated the change.
m_ResourceID
The unique identifier of the resource that sent the chat message.
m_ChatRoom
The chat room where the message was sent.
m_Message
The chat message.
See Also
EHPMChangeCallbackOperation, HPMChangeCallbackInfo
HPMChangeCallbackData_ChatMessageLastID
Callback data type for HPMChangeCallbackInfo::m_pCallbackData when HPMChangeCallbackInfo::m_Operation is set to EHPMChangeCallbackOperation_ChatMessageLastID.
struct HPMChangeCallbackData_ChatMessageLastID {
HPMInt32 m_bChangeInitiatedFromThisSession;
HPMUniqueID m_ChangedByResourceID;
HPMUniqueID m_ChangedByImpersonatedResourceID;
HPMInt64 m_LastChatID;
HPMChatRoom m_ChatRoom;
} HPMChangeCallbackData_ChatMessageLastID;
Members
m_bChangeInitiatedFromThisSession
Set to 1 if this change in the database was the result of an operation that was initiated from this session.
m_ChangedByResourceID
The unique identifier of the resource that initiated the change.
m_ChangedByImpersonatedResourceID
The unique identifier of the impersonated resource that initiated the change.
m_LastChatID
The id of the last message in the chat room.
m_ChatRoom
The chat room where the message was sent.
See Also
EHPMChangeCallbackOperation, HPMChangeCallbackInfo
HPMChangeCallbackData_ChatMessageLastReadID
Callback data type for HPMChangeCallbackInfo::m_pCallbackData when HPMChangeCallbackInfo::m_Operation is set to EHPMChangeCallbackOperation_ChatMessageLastReadID.
struct HPMChangeCallbackData_ChatMessageLastReadID {
HPMInt32 m_bChangeInitiatedFromThisSession;
HPMUniqueID m_ChangedByResourceID;
HPMUniqueID m_ChangedByImpersonatedResourceID;
HPMUniqueID m_ResourceID;
HPMInt64 m_LastReadChatID;
HPMChatRoom m_ChatRoom;
} HPMChangeCallbackData_ChatMessageLastReadID;
Members
m_bChangeInitiatedFromThisSession
Set to 1 if this change in the database was the result of an operation that was initiated from this session.
m_ChangedByResourceID
The unique identifier of the resource that initiated the change.
m_ChangedByImpersonatedResourceID
The unique identifier of the impersonated resource that initiated the change.
m_ResourceID
The unique identifier of the resource that read the last chat message.
m_LastReadChatID
The id of the last read message.
m_ChatRoom
The chat room where the message was read.
See Also
EHPMChangeCallbackOperation, HPMChangeCallbackInfo
HPMChangeCallbackData_ChatOnlineStatusChange
Callback data type for HPMChangeCallbackInfo::m_pCallbackData when HPMChangeCallbackInfo::m_Operation is set to EHPMChangeCallbackOperation_ChatOnlineStatusChange.
struct HPMChangeCallbackData_ChatOnlineStatusChange {
HPMInt32 m_bChangeInitiatedFromThisSession;
HPMUniqueID m_ChangedByResourceID;
HPMUniqueID m_ChangedByImpersonatedResourceID;
HPMUniqueID m_ResourceID;
HPMInt32 m_Status;
} HPMChangeCallbackData_ChatOnlineStatusChange;
Members
m_bChangeInitiatedFromThisSession
Set to 1 if this change in the database was the result of an operation that was initiated from this session.
m_ChangedByResourceID
The unique identifier of the resource that initiated the change.
m_ChangedByImpersonatedResourceID
The unique identifier of the impersonated resource that initiated the change.
m_ResourceID
The unique identifier of the resource that the chat online status was changed for.
m_Status
The new chat online status. Can be one of EHPMChatOnlineStatus.
See Also
EHPMChangeCallbackOperation, HPMChangeCallbackInfo
HPMChangeCallbackData_ResourceDoNotDisturbChange
Callback data type for HPMChangeCallbackInfo::m_pCallbackData when HPMChangeCallbackInfo::m_Operation is set to EHPMChangeCallbackOperation_ResourceDoNotDisturbChange.
struct HPMChangeCallbackData_ResourceDoNotDisturbChange {
HPMInt32 m_bChangeInitiatedFromThisSession;
HPMUniqueID m_ChangedByResourceID;
HPMUniqueID m_ChangedByImpersonatedResourceID;
HPMUniqueID m_ResourceID;
HPMInt32 m_bIsDoNotDisturb;
} HPMChangeCallbackData_ResourceDoNotDisturbChange;
Members
m_bChangeInitiatedFromThisSession
Set to 1 if this change in the database was the result of an operation that was initiated from this session.
m_ChangedByResourceID
The unique identifier of the resource that initiated the change.
m_ChangedByImpersonatedResourceID
The unique identifier of the impersonated resource that initiated the change.
m_ResourceID
The unique identifier of the resource that the do not disturb flag was changed for.
m_bIsDoNotDisturb
The new value of the do not disturb flag.
See Also
EHPMChangeCallbackOperation, HPMChangeCallbackInfo
HPMChangeCallbackData_GlobalEmailSettingsChange
Callback data type for HPMChangeCallbackInfo::m_pCallbackData when HPMChangeCallbackInfo::m_Operation is set to EHPMChangeCallbackOperation_GlobalEmailSettingsChange.
struct HPMChangeCallbackData_GlobalEmailSettingsChange {
HPMInt32 m_bChangeInitiatedFromThisSession;
HPMUniqueID m_ChangedByResourceID;
HPMUniqueID m_ChangedByImpersonatedResourceID;
} HPMChangeCallbackData_GlobalEmailSettingsChange;
Members
m_bChangeInitiatedFromThisSession
Set to 1 if this change in the database was the result of an operation that was initiated from this session.
m_ChangedByResourceID
The unique identifier of the resource that initiated the change.
m_ChangedByImpersonatedResourceID
The unique identifier of the impersonated resource that initiated the change.
See Also
EHPMChangeCallbackOperation, HPMChangeCallbackInfo
HPMChangeCallbackData_ProjectCreate
Callback data type for HPMChangeCallbackInfo::m_pCallbackData when HPMChangeCallbackInfo::m_Operation is set to EHPMChangeCallbackOperation_ProjectCreate.
struct HPMChangeCallbackData_ProjectCreate {
HPMInt32 m_bChangeInitiatedFromThisSession;
HPMUniqueID m_ChangedByResourceID;
HPMUniqueID m_ChangedByImpersonatedResourceID;
HPMUniqueID m_ProjectID;
HPMUniqueID m_TemporaryProjectID;
HPMInt32 m_bIsProjectCloned;
HPMUniqueID m_SourceProjectID;
} HPMChangeCallbackData_ProjectCreate;
Members
m_bChangeInitiatedFromThisSession
Set to 1 if this change in the database was the result of an operation that was initiated from this session.
m_ChangedByResourceID
The unique identifier of the resource that initiated the change.
m_ChangedByImpersonatedResourceID
The unique identifier of the impersonated resource that initiated the change.
m_ProjectID
The unique identifier of the created project.
m_TemporaryProjectID
When in nonblocking mode this is the identifier returned from the ProjectCreate function.
m_bIsProjectCloned
Set to 1 if this project was cloned
m_SourceProjectID
The unique identifier of the project which was a prototype of this project during cloning, set to -1 if this project wasn't cloned
See Also
EHPMChangeCallbackOperation, HPMChangeCallbackInfo
HPMChangeCallbackData_ProjectDelete
Callback data type for HPMChangeCallbackInfo::m_pCallbackData when HPMChangeCallbackInfo::m_Operation is set to EHPMChangeCallbackOperation_ProjectDelete.
struct HPMChangeCallbackData_ProjectDelete {
HPMInt32 m_bChangeInitiatedFromThisSession;
HPMUniqueID m_ChangedByResourceID;
HPMUniqueID m_ChangedByImpersonatedResourceID;
HPMUniqueID m_ProjectID;
HPMUniqueID m_BacklogID;
HPMUniqueID m_QAID;
} HPMChangeCallbackData_ProjectDelete;
Members
m_bChangeInitiatedFromThisSession
Set to 1 if this change in the database was the result of an operation that was initiated from this session.
m_ChangedByResourceID
The unique identifier of the resource that initiated the change.
m_ChangedByImpersonatedResourceID
The unique identifier of the impersonated resource that initiated the change.
m_ProjectID
The unique identifier of the project that was deleted.
m_BacklogID
The unique identifier of the backlog project of the deleted project.
m_QAID
The unique identifier of the QA project of the deleted project.
See Also
EHPMChangeCallbackOperation, HPMChangeCallbackInfo
HPMChangeCallbackData_ProjectPropertiesChange
Callback data type for HPMChangeCallbackInfo::m_pCallbackData when HPMChangeCallbackInfo::m_Operation is set to EHPMChangeCallbackOperation_ProjectPropertiesChange.
struct HPMChangeCallbackData_ProjectPropertiesChange {
HPMInt32 m_bChangeInitiatedFromThisSession;
HPMUniqueID m_ChangedByResourceID;
HPMUniqueID m_ChangedByImpersonatedResourceID;
HPMUniqueID m_ProjectID;
HPMInt32 m_bArchivedStatusChanged;
} HPMChangeCallbackData_ProjectPropertiesChange;
Members
m_bChangeInitiatedFromThisSession
Set to 1 if this change in the database was the result of an operation that was initiated from this session.
m_ChangedByResourceID
The unique identifier of the resource that initiated the change.
m_ChangedByImpersonatedResourceID
The unique identifier of the impersonated resource that initiated the change.
m_ProjectID
The unique identifer of the project that had its properties changed.
m_bArchivedStatusChanged
Set to 1 if the archived status of the project changed.
See Also
EHPMChangeCallbackOperation, HPMChangeCallbackInfo
HPMChangeCallbackData_ProjectSettingsChange
Callback data type for HPMChangeCallbackInfo::m_pCallbackData when HPMChangeCallbackInfo::m_Operation is set to EHPMChangeCallbackOperation_ProjectSettingsChange.
struct HPMChangeCallbackData_ProjectSettingsChange {
HPMInt32 m_bChangeInitiatedFromThisSession;
HPMUniqueID m_ChangedByResourceID;
HPMUniqueID m_ChangedByImpersonatedResourceID;
HPMUniqueID m_ProjectID;
} HPMChangeCallbackData_ProjectSettingsChange;
Members
m_bChangeInitiatedFromThisSession
Set to 1 if this change in the database was the result of an operation that was initiated from this session.
m_ChangedByResourceID
The unique identifier of the resource that initiated the change.
m_ChangedByImpersonatedResourceID
The unique identifier of the impersonated resource that initiated the change.
m_ProjectID
The unique identifier of the project that had its settings changed.
See Also
EHPMChangeCallbackOperation, HPMChangeCallbackInfo
HPMChangeCallbackData_ProjectStatisticsSettingsChange
Callback data type for HPMChangeCallbackInfo::m_pCallbackData when HPMChangeCallbackInfo::m_Operation is set to EHPMChangeCallbackOperation_ProjectStatisticsSettingsChange.
struct HPMChangeCallbackData_ProjectStatisticsSettingsChange {
HPMInt32 m_bChangeInitiatedFromThisSession;
HPMUniqueID m_ChangedByResourceID;
HPMUniqueID m_ChangedByImpersonatedResourceID;
HPMUniqueID m_ProjectID;
} HPMChangeCallbackData_ProjectStatisticsSettingsChange;
Members
m_bChangeInitiatedFromThisSession
Set to 1 if this change in the database was the result of an operation that was initiated from this session.
m_ChangedByResourceID
The unique identifier of the resource that initiated the change.
m_ChangedByImpersonatedResourceID
The unique identifier of the impersonated resource that initiated the change.
m_ProjectID
The unique identifier of the project that had its statistics settings changed.
See Also
EHPMChangeCallbackOperation, HPMChangeCallbackInfo
HPMChangeCallbackData_ProjectColumnMetaDataChange
Callback data type for HPMChangeCallbackInfo::m_pCallbackData when HPMChangeCallbackInfo::m_Operation is set to EHPMChangeCallbackOperation_ProjectColumnMetaDataChange.
struct HPMChangeCallbackData_ProjectColumnMetaDataChange {
HPMInt32 m_bChangeInitiatedFromThisSession;
HPMUniqueID m_ChangedByResourceID;
HPMUniqueID m_ChangedByImpersonatedResourceID;
HPMUniqueID m_ProjectID;
HPMColumn m_Column;
} HPMChangeCallbackData_ProjectColumnMetaDataChange;
Members
m_bChangeInitiatedFromThisSession
Set to 1 if this change in the database was the result of an operation that was initiated from this session.
m_ChangedByResourceID
The unique identifier of the resource that initiated the change.
m_ChangedByImpersonatedResourceID
The unique identifier of the impersonated resource that initiated the change.
m_ProjectID
The unique identifier of the project that had a column in it change meta data .
m_Column
The column for which meta data changed. See also HPMColumn.
See Also
EHPMChangeCallbackOperation, HPMChangeCallbackInfo
HPMChangeCallbackData_ProjectOverviewTextChange
Callback data type for HPMChangeCallbackInfo::m_pCallbackData when HPMChangeCallbackInfo::m_Operation is set to EHPMChangeCallbackOperation_ProjectOverviewTextChange.
struct HPMChangeCallbackData_ProjectOverviewTextChange {
HPMInt32 m_bChangeInitiatedFromThisSession;
HPMUniqueID m_ChangedByResourceID;
HPMUniqueID m_ChangedByImpersonatedResourceID;
HPMUniqueID m_ProjectID;
HPMChar const * m_Text;
} HPMChangeCallbackData_ProjectOverviewTextChange;
Members
m_bChangeInitiatedFromThisSession
Set to 1 if this change in the database was the result of an operation that was initiated from this session.
m_ChangedByResourceID
The unique identifier of the resource that initiated the change.
m_ChangedByImpersonatedResourceID
The unique identifier of the impersonated resource that initiated the change.
m_ProjectID
The unique identifier of the project where the overview text changed.
m_Text
The changed overview text.
See Also
EHPMChangeCallbackOperation, HPMChangeCallbackInfo
HPMChangeCallbackData_ProjectWorkflowChange
Callback data type for HPMChangeCallbackInfo::m_pCallbackData when HPMChangeCallbackInfo::m_Operation is set to EHPMChangeCallbackOperation_WorkflowChange.
struct HPMChangeCallbackData_ProjectWorkflowChange {
HPMInt32 m_bChangeInitiatedFromThisSession;
HPMUniqueID m_ChangedByResourceID;
HPMUniqueID m_ChangedByImpersonatedResourceID;
HPMUniqueID m_ProjectID;
HPMUInt32 m_WorkflowID;
HPMInt32 m_bValidChange;
} HPMChangeCallbackData_ProjectWorkflowChange;
Members
m_bChangeInitiatedFromThisSession
Set to 1 if this change in the database was the result of an operation that was initiated from this session.
m_ChangedByResourceID
The unique identifier of the resource that initiated the change.
m_ChangedByImpersonatedResourceID
The unique identifier of the impersonated resource that initiated the change.
m_ProjectID
The unique identifier of the project that had its workflow changed.
m_WorkflowID
The identifier of the workflow that changed in the project.
m_bValidChange
Set to 1 if the change succeeded, 0 otherwise.
See Also
EHPMChangeCallbackOperation, HPMChangeCallbackInfo
HPMChangeCallbackData_ProjectWorkflowCreate
Callback data type for HPMChangeCallbackInfo::m_pCallbackData when HPMChangeCallbackInfo::m_Operation is set to EHPMChangeCallbackOperation_WorkflowCreate.
struct HPMChangeCallbackData_ProjectWorkflowCreate {
HPMInt32 m_bChangeInitiatedFromThisSession;
HPMUniqueID m_ChangedByResourceID;
HPMUniqueID m_ChangedByImpersonatedResourceID;
HPMUniqueID m_ProjectID;
HPMUInt32 m_WorkflowID;
} HPMChangeCallbackData_ProjectWorkflowCreate;
Members
m_bChangeInitiatedFromThisSession
Set to 1 if this change in the database was the result of an operation that was initiated from this session.
m_ChangedByResourceID
The unique identifier of the resource that initiated the change.
m_ChangedByImpersonatedResourceID
The unique identifier of the impersonated resource that initiated the change.
m_ProjectID
The unique identifier of the project where a workflow was created.
m_WorkflowID
The identifier of the workflow that was created in the project.
See Also
EHPMChangeCallbackOperation, HPMChangeCallbackInfo
HPMChangeCallbackData_WorkflowUpdateData
Structure used for specifying updated versions of a workflow. HPMChangeCallbackData_ProjectWorkflowNewVersion::m_pWorkflows. HPMChangeCallbackData_ProjectWorkflowDelete::m_pWorkflows.
struct HPMChangeCallbackData_WorkflowUpdateData {
HPMUInt32 m_WorkflowOldID;
HPMUInt32 m_WorkflowNewID;
HPMInt32 m_bReferencesChanged;
} HPMChangeCallbackData_WorkflowUpdateData;
Members
m_WorkflowOldID
The id of the new version of the workflow.
m_WorkflowNewID
The id of the old version of the workflow.
m_bReferencesChanged
Set to 1 if the workflow id change is due to a new version of a workflow referenced by this workflow, set to 0 if this workflow has a new version. If set to 0 and m_WorkflowOldID and m_WorkflowNewID are equal HPMProjectWorkflowSettings::m_NewestWorkflowVersionID was updated.
See Also
EHPMChangeCallbackOperation, HPMChangeCallbackInfo
HPMChangeCallbackData_ProjectWorkflowDelete
Callback data type for HPMChangeCallbackInfo::m_pCallbackData when HPMChangeCallbackInfo::m_Operation is set to EHPMChangeCallbackOperation_WorkflowDelete.
struct HPMChangeCallbackData_ProjectWorkflowDelete {
HPMInt32 m_bChangeInitiatedFromThisSession;
HPMUniqueID m_ChangedByResourceID;
HPMUniqueID m_ChangedByImpersonatedResourceID;
HPMUniqueID m_ProjectID;
HPMInt32 m_bValidChange;
HPMUInt32 m_nWorkflows;
const HPMChangeCallbackData_WorkflowUpdateData * m_pWorkflows;
} HPMChangeCallbackData_ProjectWorkflowDelete;
Members
m_bChangeInitiatedFromThisSession
Set to 1 if this change in the database was the result of an operation that was initiated from this session.
m_ChangedByResourceID
The unique identifier of the resource that initiated the change.
m_ChangedByImpersonatedResourceID
The unique identifier of the impersonated resource that initiated the change.
m_ProjectID
The unique identifier of the project where a workflow was deleted.
m_bValidChange
Set to 1 if the change succeeded, 0 otherwise.
m_nWorkflows
The number of deleted workflows.
m_pWorkflows
Pointer to a list of deleted workflow data.
See Also
EHPMChangeCallbackOperation, HPMChangeCallbackInfo
HPMChangeCallbackData_WorkflowsDeletedData
Structure used for specifying updated versions of a workflow. HPMChangeCallbackData_GlobalWorkflowsDeleted::m_pDeletedWorkflows.
struct HPMChangeCallbackData_WorkflowsDeletedData {
HPMUniqueID m_ProjectID;
HPMUInt32 m_WorkflowID;
} HPMChangeCallbackData_WorkflowsDeletedData;
Members
m_ProjectID
The unique identifier of the project where a workflow was deleted.
m_WorkflowID
The id of the last version of the workflow.
See Also
EHPMChangeCallbackOperation, HPMChangeCallbackInfo
HPMChangeCallbackData_GlobalWorkflowsDeleted
Callback data type for HPMChangeCallbackInfo::m_pCallbackData when HPMChangeCallbackInfo::m_Operation is set to EHPMChangeCallbackOperation_WorkflowsDeleted.
struct HPMChangeCallbackData_GlobalWorkflowsDeleted {
HPMInt32 m_bChangeInitiatedFromThisSession;
HPMUniqueID m_ChangedByResourceID;
HPMUniqueID m_ChangedByImpersonatedResourceID;
HPMUInt32 m_nDeletedWorkflows;
const HPMChangeCallbackData_WorkflowsDeletedData * m_pDeletedWorkflows;
} HPMChangeCallbackData_GlobalWorkflowsDeleted;
Members
m_bChangeInitiatedFromThisSession
Set to 1 if this change in the database was the result of an operation that was initiated from this session.
m_ChangedByResourceID
The unique identifier of the resource that initiated the change.
m_ChangedByImpersonatedResourceID
The unique identifier of the impersonated resource that initiated the change.
m_nDeletedWorkflows
The number of deleted workflows.
m_pDeletedWorkflows
Pointer to a list of deleted workflow data.
See Also
EHPMChangeCallbackOperation, HPMChangeCallbackInfo
HPMChangeCallbackData_ProjectReportsChange
Callback data type for HPMChangeCallbackInfo::m_pCallbackData when HPMChangeCallbackInfo::m_Operation is set to EHPMChangeCallbackOperation_ProjectReportsChange
struct HPMChangeCallbackData_ProjectReportsChange {
HPMInt32 m_bChangeInitiatedFromThisSession;
HPMUniqueID m_ChangedByResourceID;
HPMUniqueID m_ChangedByImpersonatedResourceID;
HPMUniqueID m_ProjectID;
} HPMChangeCallbackData_ProjectReportsChange;
Members
m_bChangeInitiatedFromThisSession
Set to 1 if this change in the database was the result of an operation that was initiated from this session.
m_ChangedByResourceID
The unique identifier of the resource that initiated the change.
m_ChangedByImpersonatedResourceID
The unique identifier of the impersonated resource that initiated the change.
m_ProjectID
The unique identifier of the project where reports changed.
See Also
EHPMChangeCallbackOperation, HPMChangeCallbackInfo
HPMChangeCallbackData_ProjectAgilePriorityCustomColumnChange
Callback data type for HPMChangeCallbackInfo::m_pCallbackData when HPMChangeCallbackInfo::m_Operation is set to EHPMChangeCallbackOperation_ProjectAgilePriorityCustomColumnChange
struct HPMChangeCallbackData_ProjectAgilePriorityCustomColumnChange {
HPMInt32 m_bChangeInitiatedFromThisSession;
HPMUniqueID m_ChangedByResourceID;
HPMUniqueID m_ChangedByImpersonatedResourceID;
HPMUniqueID m_ProjectID;
} HPMChangeCallbackData_ProjectAgilePriorityCustomColumnChange;
Members
m_bChangeInitiatedFromThisSession
Set to 1 if this change in the database was the result of an operation that was initiated from this session.
m_ChangedByResourceID
The unique identifier of the resource that initiated the change.
m_ChangedByImpersonatedResourceID
The unique identifier of the impersonated resource that initiated the change.
m_ProjectID
The unique identifier of the project where the agile priority custom column changed.
See Also
EHPMChangeCallbackOperation, HPMChangeCallbackInfo
HPMChangeCallbackData_GlobalReportsChange
Callback data type for HPMChangeCallbackInfo::m_pCallbackData when HPMChangeCallbackInfo::m_Operation is set to EHPMChangeCallbackOperation_GlobalReporsChange
struct HPMChangeCallbackData_GlobalReportsChange {
HPMInt32 m_bChangeInitiatedFromThisSession;
HPMUniqueID m_ChangedByResourceID;
HPMUniqueID m_ChangedByImpersonatedResourceID;
} HPMChangeCallbackData_GlobalReportsChange;
Members
m_bChangeInitiatedFromThisSession
Set to 1 if this change in the database was the result of an operation that was initiated from this session.
m_ChangedByResourceID
The unique identifier of the resource that initiated the change.
m_ChangedByImpersonatedResourceID
The unique identifier of the impersonated resource that initiated the change.
See Also
EHPMChangeCallbackOperation, HPMChangeCallbackInfo
HPMChangeCallbackData_ProjectWorkflowStatusStatsChange
Callback data type for HPMChangeCallbackInfo::m_pCallbackData when HPMChangeCallbackInfo::m_Operation is set to EHPMChangeCallbackOperation_ProjectWorkflowStatusStatsChange
struct HPMChangeCallbackData_ProjectWorkflowStatusStatsChange {
HPMInt32 m_bChangeInitiatedFromThisSession;
HPMUniqueID m_ChangedByResourceID;
HPMUniqueID m_ChangedByImpersonatedResourceID;
HPMUniqueID m_ProjectID;
HPMUInt32 m_WorkflowObjectID;
HPMUInt32 m_WorkflowStatusID;
} HPMChangeCallbackData_ProjectWorkflowStatusStatsChange;
Members
m_bChangeInitiatedFromThisSession
Set to 1 if this change in the database was the result of an operation that was initiated from this session.
m_ChangedByResourceID
The unique identifier of the resource that initiated the change.
m_ChangedByImpersonatedResourceID
The unique identifier of the impersonated resource that initiated the change.
m_ProjectID
The unique identifier of the project where the workflow status statistics changed.
m_WorkflowObjectID
The id of the workflow object that the stats changed for.
m_WorkflowStatusID
The id of the status that the stats changed for.
See Also
EHPMChangeCallbackOperation, HPMChangeCallbackInfo
HPMChangeCallbackData_ProjectWorkflowNewVersion
Callback data type for HPMChangeCallbackInfo::m_pCallbackData when HPMChangeCallbackInfo::m_Operation is set to EHPMChangeCallbackOperation_ProjectWorkflowNewVersion
struct HPMChangeCallbackData_ProjectWorkflowNewVersion {
HPMInt32 m_bChangeInitiatedFromThisSession;
HPMUniqueID m_ChangedByResourceID;
HPMUniqueID m_ChangedByImpersonatedResourceID;
HPMUniqueID m_ProjectID;
HPMInt32 m_bValidChange;
HPMUInt32 m_nWorkflows;
const HPMChangeCallbackData_WorkflowUpdateData * m_pWorkflows;
} HPMChangeCallbackData_ProjectWorkflowNewVersion;
Members
m_bChangeInitiatedFromThisSession
Set to 1 if this change in the database was the result of an operation that was initiated from this session.
m_ChangedByResourceID
The unique identifier of the resource that initiated the change.
m_ChangedByImpersonatedResourceID
The unique identifier of the impersonated resource that initiated the change.
m_ProjectID
The unique identifier of the project where the new version of the workflow was created.
m_bValidChange
Set to 1 if the change succeeded, 0 otherwise.
m_nWorkflows
The number of updated workflows.
m_pWorkflows
Pointer to a list of updated workflow data.
See Also
EHPMChangeCallbackOperation, HPMChangeCallbackInfo
HPMChangeCallbackData_FieldUpdateData
Structure used for specifying updated versions of a workflow. HPMChangeCallbackData_TaskUpdateData::m_pFields.
struct HPMChangeCallbackData_FieldUpdateData {
HPMInt32 m_FieldID;
HPMUInt32 m_FieldData;
} HPMChangeCallbackData_FieldUpdateData;
Members
m_FieldID
The field id of the data for this entry. Depending on if HPMChangeCallbackData_TaskUpdateData::m_ID is a task ref id or task id this field is one of EHPMTaskRefField or EHPMTaskField respectively. If -1 the task it belongs to was deleted or created. Check with UtilIsIDValid if HPMChangeCallbackData_TaskUpdateData::m_ID exist.
m_FieldData
The field data of the data for this entry. If m_FieldID is EHPMTaskField_CustomColumnData this member is the column hash of the custom column data.
See Also
EHPMChangeCallbackOperation, HPMChangeCallbackInfo
HPMChangeCallbackData_TaskUpdateData
Structure used for specifying updated versions of a task. HPMChangeCallbackData_TaskUpdatePipelineWorkflowToNewestVersion::m_pTasks.
struct HPMChangeCallbackData_TaskUpdateData {
HPMUniqueID m_ID;
HPMUInt32 m_nFields;
const HPMChangeCallbackData_FieldUpdateData * m_pFields;
} HPMChangeCallbackData_TaskUpdateData;
Members
m_ID
The unique task id or task reference id that was updated.
m_nFields
The number of updated fields.
m_pFields
Pointer to a list of updated fields.
See Also
EHPMChangeCallbackOperation, HPMChangeCallbackInfo
HPMChangeCallbackData_TaskUpdatePipelineWorkflowToNewestVersion
Callback data type for HPMChangeCallbackInfo::m_pCallbackData when HPMChangeCallbackInfo::m_Operation is set to EHPMChangeCallbackOperation_TaskUpdatePipelineWorkflowToNewestVersion
struct HPMChangeCallbackData_TaskUpdatePipelineWorkflowToNewestVersion {
HPMInt32 m_bChangeInitiatedFromThisSession;
HPMUniqueID m_ChangedByResourceID;
HPMUniqueID m_ChangedByImpersonatedResourceID;
HPMUniqueID m_ProjectID;
HPMUInt32 m_nTasks;
const HPMChangeCallbackData_TaskUpdateData * m_pTasks;
} HPMChangeCallbackData_TaskUpdatePipelineWorkflowToNewestVersion;
Members
m_bChangeInitiatedFromThisSession
Set to 1 if this change in the database was the result of an operation that was initiated from this session.
m_ChangedByResourceID
The unique identifier of the resource that initiated the change.
m_ChangedByImpersonatedResourceID
The unique identifier of the impersonated resource that initiated the change.
m_ProjectID
The unique identifier of the project where the pipeline was updated.
m_nTasks
The number of updated tasks.
m_pTasks
Pointer to a list of updated tasks.
See Also
EHPMChangeCallbackOperation, HPMChangeCallbackInfo
HPMChangeCallbackData_ProjectEmailSettingsChange
Callback data type for HPMChangeCallbackInfo::m_pCallbackData when HPMChangeCallbackInfo::m_Operation is set to EHPMChangeCallbackOperation_ProjectEmailSettingsChange.
struct HPMChangeCallbackData_ProjectEmailSettingsChange {
HPMInt32 m_bChangeInitiatedFromThisSession;
HPMUniqueID m_ChangedByResourceID;
HPMUniqueID m_ChangedByImpersonatedResourceID;
HPMUniqueID m_ProjectID;
} HPMChangeCallbackData_ProjectEmailSettingsChange;
Members
m_bChangeInitiatedFromThisSession
Set to 1 if this change in the database was the result of an operation that was initiated from this session.
m_ChangedByResourceID
The unique identifier of the resource that initiated the change.
m_ChangedByImpersonatedResourceID
The unique identifier of the impersonated resource that initiated the change.
m_ProjectID
The unique identifier of the project that had its email settings changed.
See Also
EHPMChangeCallbackOperation, HPMChangeCallbackInfo
HPMChangeCallbackData_ProjectOpenBacklogProject
Callback data type for HPMChangeCallbackInfo::m_pCallbackData when HPMChangeCallbackInfo::m_Operation is set to EHPMChangeCallbackOperation_ProjectOpenBacklogProject.
struct HPMChangeCallbackData_ProjectOpenBacklogProject {
HPMInt32 m_bChangeInitiatedFromThisSession;
HPMUniqueID m_ChangedByResourceID;
HPMUniqueID m_ChangedByImpersonatedResourceID;
HPMUniqueID m_ProjectID;
HPMInt32 m_bSuccess;
HPMUniqueID m_BacklogProjectID;
} HPMChangeCallbackData_ProjectOpenBacklogProject;
Members
m_bChangeInitiatedFromThisSession
Set to 1 if this change in the database was the result of an operation that was initiated from this session.
m_ChangedByResourceID
The unique identifier of the resource that initiated the change.
m_ChangedByImpersonatedResourceID
The unique identifier of the impersonated resource that initiated the change.
m_ProjectID
The unique identifier of the project that the backlog was opened for.
m_bSuccess
Set to 1 if the open of the backlog succeeded, 0 otherwise.
m_BacklogProjectID
The unique identifier of the backlog in the project.
See Also
EHPMChangeCallbackOperation, HPMChangeCallbackInfo
HPMChangeCallbackData_ProjectOpenQAProject
Callback data type for HPMChangeCallbackInfo::m_pCallbackData when HPMChangeCallbackInfo::m_Operation is set to EHPMChangeCallbackOperation_ProjectOpenQAProject.
struct HPMChangeCallbackData_ProjectOpenQAProject {
HPMInt32 m_bChangeInitiatedFromThisSession;
HPMUniqueID m_ChangedByResourceID;
HPMUniqueID m_ChangedByImpersonatedResourceID;
HPMUniqueID m_ProjectID;
HPMInt32 m_bSuccess;
HPMUniqueID m_QAProjectID;
} HPMChangeCallbackData_ProjectOpenQAProject;
Members
m_bChangeInitiatedFromThisSession
Set to 1 if this change in the database was the result of an operation that was initiated from this session.
m_ChangedByResourceID
The unique identifier of the resource that initiated the change.
m_ChangedByImpersonatedResourceID
The unique identifier of the impersonated resource that initiated the change.
m_ProjectID
The unique identifier of the project that the backlog was opened for.
m_bSuccess
Set to 1 if the open of the QA project succeeded, 0 otherwise.
m_QAProjectID
The unique identifier of the QA in the project.
See Also
EHPMChangeCallbackOperation, HPMChangeCallbackInfo
HPMChangeCallbackData_ProjectHistoryAutoSaveSettingsChange
Callback data type for HPMChangeCallbackInfo::m_pCallbackData when HPMChangeCallbackInfo::m_Operation is set to EHPMChangeCallbackOperation_ProjectHistoryAutoSaveSettingsChange.
struct HPMChangeCallbackData_ProjectHistoryAutoSaveSettingsChange {
HPMInt32 m_bChangeInitiatedFromThisSession;
HPMUniqueID m_ChangedByResourceID;
HPMUniqueID m_ChangedByImpersonatedResourceID;
HPMUniqueID m_ProjectID;
} HPMChangeCallbackData_ProjectHistoryAutoSaveSettingsChange;
Members
m_bChangeInitiatedFromThisSession
Set to 1 if this change in the database was the result of an operation that was initiated from this session.
m_ChangedByResourceID
The unique identifier of the resource that initiated the change.
m_ChangedByImpersonatedResourceID
The unique identifier of the impersonated resource that initiated the change.
m_ProjectID
The unique identifier the project that project history auto save settings was changed for.
See Also
EHPMChangeCallbackOperation, HPMChangeCallbackInfo
HPMChangeCallbackData_ProjectCustomColumnsChange
Callback data type for HPMChangeCallbackInfo::m_pCallbackData when HPMChangeCallbackInfo::m_Operation is set to EHPMChangeCallbackOperation_ProjectCustomColumnsChange.
struct HPMChangeCallbackData_ProjectCustomColumnsChange {
HPMInt32 m_bChangeInitiatedFromThisSession;
HPMUniqueID m_ChangedByResourceID;
HPMUniqueID m_ChangedByImpersonatedResourceID;
HPMUniqueID m_ProjectID;
HPMProjectCustomColumnChanges m_Changes;
} HPMChangeCallbackData_ProjectCustomColumnsChange;
Members
m_bChangeInitiatedFromThisSession
Set to 1 if this change in the database was the result of an operation that was initiated from this session.
m_ChangedByResourceID
The unique identifier of the resource that initiated the change.
m_ChangedByImpersonatedResourceID
The unique identifier of the impersonated resource that initiated the change.
m_ProjectID
The unique identifier for the project that had its custom columns changed.
m_Changes
All the actual changes done to the columns in the project
See Also
EHPMChangeCallbackOperation, HPMChangeCallbackInfo
HPMChangeCallbackData_ProjectCustomColumnsDeleteTaskData
Callback data type for HPMChangeCallbackInfo::m_pCallbackData when HPMChangeCallbackInfo::m_Operation is set to EHPMChangeCallbackOperation_ProjectCustomColumnsDeleteTaskData.
struct HPMChangeCallbackData_ProjectCustomColumnsDeleteTaskData {
HPMInt32 m_bChangeInitiatedFromThisSession;
HPMUniqueID m_ChangedByResourceID;
HPMUniqueID m_ChangedByImpersonatedResourceID;
HPMUniqueID m_ProjectID;
HPMUInt32 m_ColumnHash;
} HPMChangeCallbackData_ProjectCustomColumnsDeleteTaskData;
Members
m_bChangeInitiatedFromThisSession
Set to 1 if this change in the database was the result of an operation that was initiated from this session.
m_ChangedByResourceID
The unique identifier of the resource that initiated the change.
m_ChangedByImpersonatedResourceID
The unique identifier of the impersonated resource that initiated the change.
m_ProjectID
The unique identifier of the project that task custom column data was deleted in.
m_ColumnHash
The hash of the column that task data was deleted for.
See Also
EHPMChangeCallbackOperation, HPMChangeCallbackInfo
HPMChangeCallbackData_ProjectCustomColumnsRenameTaskData
Callback data type for HPMChangeCallbackInfo::m_pCallbackData when HPMChangeCallbackInfo::m_Operation is set to EHPMChangeCallbackOperation_ProjectCustomColumnsRenameTaskData.
struct HPMChangeCallbackData_ProjectCustomColumnsRenameTaskData {
HPMInt32 m_bChangeInitiatedFromThisSession;
HPMUniqueID m_ChangedByResourceID;
HPMUniqueID m_ChangedByImpersonatedResourceID;
HPMUniqueID m_ProjectID;
HPMUInt32 m_ColumnHashFrom;
HPMUInt32 m_ColumnHashTo;
} HPMChangeCallbackData_ProjectCustomColumnsRenameTaskData;
Members
m_bChangeInitiatedFromThisSession
Set to 1 if this change in the database was the result of an operation that was initiated from this session.
m_ChangedByResourceID
The unique identifier of the resource that initiated the change.
m_ChangedByImpersonatedResourceID
The unique identifier of the impersonated resource that initiated the change.
m_ProjectID
The unique identifier of the project that task custom column data was renamed in.
m_ColumnHashFrom
The hash of the column data to be moved.
m_ColumnHashTo
The hash to move the column data to.
See Also
EHPMChangeCallbackOperation, HPMChangeCallbackInfo
HPMChangeCallbackData_ProjectActiveDefaultColumnsChange
Callback data type for HPMChangeCallbackInfo::m_pCallbackData when HPMChangeCallbackInfo::m_Operation is set to EHPMChangeCallbackOperation_ProjectActiveDefaultColumnsChange.
struct HPMChangeCallbackData_ProjectActiveDefaultColumnsChange {
HPMInt32 m_bChangeInitiatedFromThisSession;
HPMUniqueID m_ChangedByResourceID;
HPMUniqueID m_ChangedByImpersonatedResourceID;
HPMUniqueID m_ProjectID;
} HPMChangeCallbackData_ProjectActiveDefaultColumnsChange;
Members
m_bChangeInitiatedFromThisSession
Set to 1 if this change in the database was the result of an operation that was initiated from this session.
m_ChangedByResourceID
The unique identifier of the resource that initiated the change.
m_ChangedByImpersonatedResourceID
The unique identifier of the impersonated resource that initiated the change.
m_ProjectID
The unique identifier of the project that active default columns was changed for.
See Also
EHPMChangeCallbackOperation, HPMChangeCallbackInfo
HPMChangeCallbackData_ProjectWallSettingsChange
Callback data type for HPMChangeCallbackInfo::m_pCallbackData when HPMChangeCallbackInfo::m_Operation is set to EHPMChangeCallbackOperation_ProjectWallSettingsChange.
struct HPMChangeCallbackData_ProjectWallSettingsChange {
HPMInt32 m_bChangeInitiatedFromThisSession;
HPMUniqueID m_ChangedByResourceID;
HPMUniqueID m_ChangedByImpersonatedResourceID;
HPMUniqueID m_ProjectID;
} HPMChangeCallbackData_ProjectWallSettingsChange;
Members
m_bChangeInitiatedFromThisSession
Set to 1 if this change in the database was the result of an operation that was initiated from this session.
m_ChangedByResourceID
The unique identifier of the resource that changed the wall settings.
m_ChangedByImpersonatedResourceID
The unique identifier of the impersonated resource that initiated the change.
m_ProjectID
The unique identifier of the project that wall settings was changed for.
See Also
EHPMChangeCallbackOperation, HPMChangeCallbackInfo
HPMChangeCallbackData_ProjectWallGroupsChange
Callback data type for HPMChangeCallbackInfo::m_pCallbackData when HPMChangeCallbackInfo::m_Operation is set to EHPMChangeCallbackOperation_ProjectWallGroupsChange.
struct HPMChangeCallbackData_ProjectWallGroupsChange {
HPMInt32 m_bChangeInitiatedFromThisSession;
HPMUniqueID m_ChangedByResourceID;
HPMUniqueID m_ChangedByImpersonatedResourceID;
HPMUniqueID m_ProjectID;
} HPMChangeCallbackData_ProjectWallGroupsChange;
Members
m_bChangeInitiatedFromThisSession
Set to 1 if this change in the database was the result of an operation that was initiated from this session.
m_ChangedByResourceID
The unique identifier of the resource that changed the wall groups.
m_ChangedByImpersonatedResourceID
The unique identifier of the impersonated resource that initiated the change.
m_ProjectID
The unique identifier of the project that wall groups was changed for.
See Also
EHPMChangeCallbackOperation, HPMChangeCallbackInfo
HPMChangeCallbackData_ProjectDetailedAccessRulesChange
Callback data type for HPMChangeCallbackInfo::m_pCallbackData when HPMChangeCallbackInfo::m_Operation is set to EHPMChangeCallbackOperation_ProjectDetailedAccessRulesChange.
struct HPMChangeCallbackData_ProjectDetailedAccessRulesChange {
HPMInt32 m_bChangeInitiatedFromThisSession;
HPMUniqueID m_ChangedByResourceID;
HPMUniqueID m_ChangedByImpersonatedResourceID;
HPMUniqueID m_ProjectID;
} HPMChangeCallbackData_ProjectDetailedAccessRulesChange;
Members
m_bChangeInitiatedFromThisSession
Set to 1 if this change in the database was the result of an operation that was initiated from this session.
m_ChangedByResourceID
The unique identifier of the resource that changed the detailed access rules.
m_ChangedByImpersonatedResourceID
The unique identifier of the impersonated resource that initiated the change.
m_ProjectID
The unique identifier of the project that detailed access rules was changed for.
See Also
EHPMChangeCallbackOperation, HPMChangeCallbackInfo
HPMChangeCallbackData_ProjectColumnResourcePermissionRulesChange
Callback data type for HPMChangeCallbackInfo::m_pCallbackData when HPMChangeCallbackInfo::m_Operation is set to EHPMChangeCallbackOperation_ProjectColumnResourcePermissionRulesChange.
struct HPMChangeCallbackData_ProjectColumnResourcePermissionRulesChange {
HPMInt32 m_bChangeInitiatedFromThisSession;
HPMUniqueID m_ChangedByResourceID;
HPMUniqueID m_ChangedByImpersonatedResourceID;
HPMUniqueID m_ProjectID;
} HPMChangeCallbackData_ProjectColumnResourcePermissionRulesChange;
Members
m_bChangeInitiatedFromThisSession
Set to 1 if this change in the database was the result of an operation that was initiated from this session.
m_ChangedByResourceID
The unique identifier of the resource that changed the column resource permission rules.
m_ChangedByImpersonatedResourceID
The unique identifier of the impersonated resource that initiated the change.
m_ProjectID
The unique identifier of the project that column resource permission rules was changed for.
See Also
EHPMChangeCallbackOperation, HPMChangeCallbackInfo
HPMChangeCallbackData_ProjectCustomStatisticsSettingsChange
Callback data type for HPMChangeCallbackInfo::m_pCallbackData when HPMChangeCallbackInfo::m_Operation is set to EHPMChangeCallbackOperation_ProjectCustomStatisticsSettingsChange.
struct HPMChangeCallbackData_ProjectCustomStatisticsSettingsChange {
HPMInt32 m_bChangeInitiatedFromThisSession;
HPMUniqueID m_ChangedByResourceID;
HPMUniqueID m_ChangedByImpersonatedResourceID;
HPMUniqueID m_ProjectID;
} HPMChangeCallbackData_ProjectCustomStatisticsSettingsChange;
Members
m_bChangeInitiatedFromThisSession
Set to 1 if this change in the database was the result of an operation that was initiated from this session.
m_ChangedByResourceID
The unique identifier of the resource that changed the custom statistics settings.
m_ChangedByImpersonatedResourceID
The unique identifier of the impersonated resource that initiated the change.
m_ProjectID
The unique identifier of the project that custom statistics settings was changed for.
See Also
EHPMChangeCallbackOperation, HPMChangeCallbackInfo
HPMChangeCallbackData_ProjectResourceAdd
Callback data type for HPMChangeCallbackInfo::m_pCallbackData when HPMChangeCallbackInfo::m_Operation is set to EHPMChangeCallbackOperation_ProjectResourceAdd.
struct HPMChangeCallbackData_ProjectResourceAdd {
HPMInt32 m_bChangeInitiatedFromThisSession;
HPMUniqueID m_ChangedByResourceID;
HPMUniqueID m_ChangedByImpersonatedResourceID;
HPMUniqueID m_ProjectID;
HPMUniqueID m_ResourceID;
} HPMChangeCallbackData_ProjectResourceAdd;
Members
m_bChangeInitiatedFromThisSession
Set to 1 if this change in the database was the result of an operation that was initiated from this session.
m_ChangedByResourceID
The unique identifier of the resource that initiated the change.
m_ChangedByImpersonatedResourceID
The unique identifier of the impersonated resource that initiated the change.
m_ProjectID
The unique identifier of the project that a resource was added to.
m_ResourceID
The unique identifier of the resource that was added to the project.
See Also
EHPMChangeCallbackOperation, HPMChangeCallbackInfo
HPMChangeCallbackData_ProjectResourceRemove
Callback data type for HPMChangeCallbackInfo::m_pCallbackData when HPMChangeCallbackInfo::m_Operation is set to EHPMChangeCallbackOperation_ProjectResourceRemove.
struct HPMChangeCallbackData_ProjectResourceRemove {
HPMInt32 m_bChangeInitiatedFromThisSession;
HPMUniqueID m_ChangedByResourceID;
HPMUniqueID m_ChangedByImpersonatedResourceID;
HPMUniqueID m_ProjectID;
HPMUniqueID m_ResourceID;
} HPMChangeCallbackData_ProjectResourceRemove;
Members
m_bChangeInitiatedFromThisSession
Set to 1 if this change in the database was the result of an operation that was initiated from this session.
m_ChangedByResourceID
The unique identifier of the resource that initiated the change.
m_ChangedByImpersonatedResourceID
The unique identifier of the impersonated resource that initiated the change.
m_ProjectID
The unique identifier of the project that a resource was removed from.
m_ResourceID
The unique identifier of the resource that was removed from the project.
See Also
EHPMChangeCallbackOperation, HPMChangeCallbackInfo
HPMChangeCallbackData_ProjectResourcePropertiesChange
Callback data type for HPMChangeCallbackInfo::m_pCallbackData when HPMChangeCallbackInfo::m_Operation is set to EHPMChangeCallbackOperation_ProjectResourcePropertiesChange.
struct HPMChangeCallbackData_ProjectResourcePropertiesChange {
HPMInt32 m_bChangeInitiatedFromThisSession;
HPMUniqueID m_ChangedByResourceID;
HPMUniqueID m_ChangedByImpersonatedResourceID;
HPMUniqueID m_ProjectID;
HPMUniqueID m_ResourceID;
} HPMChangeCallbackData_ProjectResourcePropertiesChange;
Members
m_bChangeInitiatedFromThisSession
Set to 1 if this change in the database was the result of an operation that was initiated from this session.
m_ChangedByResourceID
The unique identifier of the resource that initiated the change.
m_ChangedByImpersonatedResourceID
The unique identifier of the impersonated resource that initiated the change.
m_ProjectID
The unique identifier of the project that resource properties was changed for.
m_ResourceID
The unique identifier of the resource that project properties was changed for.
See Also
EHPMChangeCallbackOperation, HPMChangeCallbackInfo
HPMChangeCallbackData_TaskCreateUnifiedTask
Structure used for specifying a created task in HPMChangeCallbackData_TaskCreateUnified::m_pTasks.
struct HPMChangeCallbackData_TaskCreateUnifiedTask {
HPMInt32 m_bIsProxy;
HPMUniqueID m_LocalID;
HPMUniqueID m_TaskRefID;
} HPMChangeCallbackData_TaskCreateUnifiedTask;
Members
m_bIsProxy
Is set to true if the created task is a proxy.
m_LocalID
The local ID specified in HPMTaskCreateUnifiedEntry::m_LocalID.
m_TaskRefID
This will point to the unique identifiers of the task references of the created task, if this ID is -1 the creation of the proxy was unsuccessful, non-proxy tasks will always be created.
See Also
EHPMChangeCallbackOperation, HPMChangeCallbackInfo
HPMChangeCallbackData_TaskCreateUnified
Callback data type for HPMChangeCallbackInfo::m_pCallbackData when HPMChangeCallbackInfo::m_Operation is set to EHPMChangeCallbackOperation_TaskCreateUnified.
struct HPMChangeCallbackData_TaskCreateUnified {
HPMInt32 m_bChangeInitiatedFromThisSession;
HPMUniqueID m_ChangedByResourceID;
HPMUniqueID m_ChangedByImpersonatedResourceID;
HPMUniqueID m_ProjectID;
HPMUInt32 m_nTasks;
const HPMChangeCallbackData_TaskCreateUnifiedTask * m_pTasks;
} HPMChangeCallbackData_TaskCreateUnified;
Members
m_bChangeInitiatedFromThisSession
Set to 1 if this change in the database was the result of an operation that was initiated from this session.
m_ChangedByResourceID
The unique identifier of the resource that initiated the change.
m_ChangedByImpersonatedResourceID
The unique identifier of the impersonated resource that initiated the change.
m_ProjectID
The unique identifier of the project that tasks were created in.
m_nTasks
The number of tasks created.
m_pTasks
Pointer to a list of created tasks.
See Also
EHPMChangeCallbackOperation, HPMChangeCallbackInfo
HPMChangeCallbackData_TaskChangeDisposition
Callback data type for HPMChangeCallbackInfo::m_pCallbackData when HPMChangeCallbackInfo::m_Operation is set to EHPMChangeCallbackOperation_TaskChangeDisposition.
struct HPMChangeCallbackData_TaskChangeDisposition {
HPMInt32 m_bChangeInitiatedFromThisSession;
HPMUniqueID m_ChangedByResourceID;
HPMUniqueID m_ChangedByImpersonatedResourceID;
HPMUniqueID m_ProjectID;
HPMInt32 m_bChangeWorkPriorityDisposition;
HPMInt32 m_bDispositionChangedRejected;
const HPMChar * m_pRejectedDebugData;
HPMUInt32 m_nTasksRejected;
const HPMUniqueID * m_pTasksRejected;
} HPMChangeCallbackData_TaskChangeDisposition;
Members
m_bChangeInitiatedFromThisSession
Set to 1 if this change in the database was the result of an operation that was initiated from this session.
m_ChangedByResourceID
The unique identifier of the resource that initiated the change.
m_ChangedByImpersonatedResourceID
The unique identifier of the impersonated resource that initiated the change.
m_ProjectID
The unique identifier of the project that tasks were changed in.
m_bChangeWorkPriorityDisposition
Set to true if EHPMTaskChangeDispositionOptionFlag_ChangeWorkPriorityDisposition was specified.
m_bDispositionChangedRejected
Set to true when the disposition change was rejected as invalid by the server.
m_pRejectedDebugData
Filled in with a debug string when disposition change was rejected by the server and EHPMTaskChangeDispositionOptionFlag_ReportDebugInfoOnRejection was specified
m_nTasksRejected
The number of tasks references rejected.
m_pTasksRejected
Pointer to a list task references rejected. This list is only a help to match the task references that you sent with changes in HPMTaskCreateUnified. It is basically a copy of that list.
See Also
EHPMChangeCallbackOperation, HPMChangeCallbackInfo
HPMChangeCallbackData_TaskDelete
Callback data type for HPMChangeCallbackInfo::m_pCallbackData when HPMChangeCallbackInfo::m_Operation is set to EHPMChangeCallbackOperation_TaskDelete.
struct HPMChangeCallbackData_TaskDelete {
HPMInt32 m_bChangeInitiatedFromThisSession;
HPMUniqueID m_ChangedByResourceID;
HPMUniqueID m_ChangedByImpersonatedResourceID;
HPMUniqueID m_TaskID;
HPMUniqueID m_ProjectID;
} HPMChangeCallbackData_TaskDelete;
Members
m_bChangeInitiatedFromThisSession
Set to 1 if this change in the database was the result of an operation that was initiated from this session.
m_ChangedByResourceID
The unique identifier of the resource that initiated the change.
m_ChangedByImpersonatedResourceID
The unique identifier of the impersonated resource that initiated the change.
m_TaskID
The unique identifier of the deleted task.
m_ProjectID
The unique identifier of the project of the deleted task.
See Also
EHPMChangeCallbackOperation, HPMChangeCallbackInfo
HPMChangeCallbackData_TaskCreateComment
Callback data type for HPMChangeCallbackInfo::m_pCallbackData when HPMChangeCallbackInfo::m_Operation is set to EHPMChangeCallbackOperation_TaskCreateComment.
struct HPMChangeCallbackData_TaskCreateComment {
HPMInt32 m_bChangeInitiatedFromThisSession;
HPMUniqueID m_ChangedByResourceID;
HPMUniqueID m_ChangedByImpersonatedResourceID;
HPMUniqueID m_TaskID;
HPMInt32 m_PostID;
} HPMChangeCallbackData_TaskCreateComment;
Members
m_bChangeInitiatedFromThisSession
Set to 1 if this change in the database was the result of an operation that was initiated from this session.
m_ChangedByResourceID
The unique identifier of the resource that initiated the change.
m_ChangedByImpersonatedResourceID
The unique identifier of the impersonated resource that initiated the change.
m_TaskID
The unique identifier of the task that a comment was created on.
m_PostID
The post identifier of the created comment. Can be -1 if several comments were created in one database message.
See Also
EHPMChangeCallbackOperation, HPMChangeCallbackInfo
HPMChangeCallbackData_TaskCommentSDKInternalDataChange
Callback data type for HPMChangeCallbackInfo::m_pCallbackData when HPMChangeCallbackInfo::m_Operation is set to EHPMChangeCallbackOperation_TaskCommentSDKInternalDataChange.
struct HPMChangeCallbackData_TaskCommentSDKInternalDataChange {
HPMInt32 m_bChangeInitiatedFromThisSession;
HPMUniqueID m_ChangedByResourceID;
HPMUniqueID m_ChangedByImpersonatedResourceID;
HPMUniqueID m_TaskID;
HPMInt32 m_PostID;
HPMUInt32 m_IdentifierHash;
} HPMChangeCallbackData_TaskCommentSDKInternalDataChange;
Members
m_bChangeInitiatedFromThisSession
Set to 1 if this change in the database was the result of an operation that was initiated from this session.
m_ChangedByResourceID
The unique identifier of the resource that initiated the change.
m_ChangedByImpersonatedResourceID
The unique identifier of the impersonated resource that initiated the change.
m_TaskID
The unique identifier of the task that a comment was created on.
m_PostID
The post identifier of the created comment. Can be -1 if several comments were created in one database message.
m_IdentifierHash
The identifier hash of the SDK internal data identifier for which the comment SDK internal data value was changed. See GlobalGetSDKInternalDataIdentifierHash.
See Also
EHPMChangeCallbackOperation, HPMChangeCallbackInfo, GlobalGetSDKInternalDataIdentifierHash
HPMChangeCallbackData_TaskEditComment
Callback data type for HPMChangeCallbackInfo::m_pCallbackData when HPMChangeCallbackInfo::m_Operation is set to EHPMChangeCallbackOperation_TaskEditComment.
struct HPMChangeCallbackData_TaskEditComment {
HPMInt32 m_bChangeInitiatedFromThisSession;
HPMUniqueID m_ChangedByResourceID;
HPMUniqueID m_ChangedByImpersonatedResourceID;
HPMUniqueID m_TaskID;
HPMInt32 m_PostID;
} HPMChangeCallbackData_TaskEditComment;
Members
m_bChangeInitiatedFromThisSession
Set to 1 if this change in the database was the result of an operation that was initiated from this session.
m_ChangedByResourceID
The unique identifier of the resource that initiated the change.
m_ChangedByImpersonatedResourceID
The unique identifier of the impersonated resource that initiated the change.
m_TaskID
The unique identifier of the task that a comment was created on.
m_PostID
The post identifier of the edited comment.
See Also
EHPMChangeCallbackOperation, HPMChangeCallbackInfo
HPMChangeCallbackData_TaskDeleteComment
Callback data type for HPMChangeCallbackInfo::m_pCallbackData when HPMChangeCallbackInfo::m_Operation is set to EHPMChangeCallbackOperation_TaskDeleteComment.
struct HPMChangeCallbackData_TaskDeleteComment {
HPMInt32 m_bChangeInitiatedFromThisSession;
HPMUniqueID m_ChangedByResourceID;
HPMUniqueID m_ChangedByImpersonatedResourceID;
HPMUniqueID m_TaskID;
HPMInt32 m_PostID;
} HPMChangeCallbackData_TaskDeleteComment;
Members
m_bChangeInitiatedFromThisSession
Set to 1 if this change in the database was the result of an operation that was initiated from this session.
m_ChangedByResourceID
The unique identifier of the resource that initiated the change.
m_ChangedByImpersonatedResourceID
The unique identifier of the impersonated resource that initiated the change.
m_TaskID
The unique identifier of the task a comment was deleted on.
m_PostID
The post identifier of the deleted comment post.
See Also
EHPMChangeCallbackOperation, HPMChangeCallbackInfo
HPMChangeCallbackData_TaskCommentPosted
Callback data type for HPMChangeCallbackInfo::m_pCallbackData when HPMChangeCallbackInfo::m_Operation is set to EHPMChangeCallbackOperation_TaskCommentPosted.
struct HPMChangeCallbackData_TaskCommentPosted {
HPMInt32 m_bChangeInitiatedFromThisSession;
HPMUniqueID m_ChangedByResourceID;
HPMUniqueID m_ChangedByImpersonatedResourceID;
HPMUniqueID m_TaskID;
HPMInt32 m_PostID;
} HPMChangeCallbackData_TaskCommentPosted;
Members
m_bChangeInitiatedFromThisSession
Set to 1 if this change in the database was the result of an operation that was initiated from this session.
m_ChangedByResourceID
The unique identifier of the resource that initiated the change.
m_ChangedByImpersonatedResourceID
The unique identifier of the impersonated resource that initiated the change.
m_TaskID
The unique identifier of the task that a comment was posted on.
m_PostID
The post identifier of the posted comment.
See Also
EHPMChangeCallbackOperation, HPMChangeCallbackInfo
HPMChangeCallbackData_TaskChange
Callback data type for HPMChangeCallbackInfo::m_pCallbackData when HPMChangeCallbackInfo::m_Operation is set to EHPMChangeCallbackOperation_TaskChange.
struct HPMChangeCallbackData_TaskChange {
HPMInt32 m_bChangeInitiatedFromThisSession;
HPMUniqueID m_ChangedByResourceID;
HPMUniqueID m_ChangedByImpersonatedResourceID;
HPMUniqueID m_TaskID;
HPMUInt32 m_FieldChanged;
} HPMChangeCallbackData_TaskChange;
Members
m_bChangeInitiatedFromThisSession
Set to 1 if this change in the database was the result of an operation that was initiated from this session.
m_ChangedByResourceID
The unique identifier of the resource that initiated the change.
m_ChangedByImpersonatedResourceID
The unique identifier of the impersonated resource that initiated the change.
m_TaskID
The unique identifier of the task that was changed.
m_FieldChanged
The type of data in the task that was changed. Can be one of EHPMTaskField.
See Also
EHPMChangeCallbackOperation, HPMChangeCallbackInfo, EHPMTaskField
HPMChangeCallbackData_TaskLastExitWorkflowStatusChange
Callback data type for HPMChangeCallbackInfo::m_pCallbackData when HPMChangeCallbackInfo::m_Operation is set to EHPMChangeCallbackOperation_TaskLastExitWorkflowStatusChange.
struct HPMChangeCallbackData_TaskLastExitWorkflowStatusChange {
HPMInt32 m_bChangeInitiatedFromThisSession;
HPMUniqueID m_ChangedByResourceID;
HPMUniqueID m_ChangedByImpersonatedResourceID;
HPMUniqueID m_TaskID;
HPMUInt32 m_WorkflowID;
HPMUInt32 m_WorkflowObjectID;
} HPMChangeCallbackData_TaskLastExitWorkflowStatusChange;
Members
m_bChangeInitiatedFromThisSession
Set to 1 if this change in the database was the result of an operation that was initiated from this session.
m_ChangedByResourceID
The unique identifier of the resource that initiated the change.
m_ChangedByImpersonatedResourceID
The unique identifier of the impersonated resource that initiated the change.
m_TaskID
The unique identifier of the task the workflow is set on.
m_WorkflowID
The identifier of the workflow that had a status change.
m_WorkflowObjectID
The identifier of the old status in the workflow.
See Also
EHPMChangeCallbackOperation, HPMChangeCallbackInfo, EHPMTaskField
HPMChangeCallbackData_TaskLastEnterWorkflowStatusChange
Callback data type for HPMChangeCallbackInfo::m_pCallbackData when HPMChangeCallbackInfo::m_Operation is set to EHPMChangeCallbackOperation_TaskLastEnterWorkflowStatusChange.
struct HPMChangeCallbackData_TaskLastEnterWorkflowStatusChange {
HPMInt32 m_bChangeInitiatedFromThisSession;
HPMUniqueID m_ChangedByResourceID;
HPMUniqueID m_ChangedByImpersonatedResourceID;
HPMUniqueID m_TaskID;
HPMUInt32 m_WorkflowID;
HPMUInt32 m_WorkflowObjectID;
} HPMChangeCallbackData_TaskLastEnterWorkflowStatusChange;
Members
m_bChangeInitiatedFromThisSession
Set to 1 if this change in the database was the result of an operation that was initiated from this session.
m_ChangedByResourceID
The unique identifier of the resource that initiated the change.
m_ChangedByImpersonatedResourceID
The unique identifier of the impersonated resource that initiated the change.
m_TaskID
The unique identifier of the task that was changed.
m_WorkflowID
The identifier of the workflow that had a status change.
m_WorkflowObjectID
The identifier of the new status in the workflow.
See Also
EHPMChangeCallbackOperation, HPMChangeCallbackInfo
HPMChangeCallbackData_TaskLastAssignedInWorkflowStatusChange
Callback data type for HPMChangeCallbackInfo::m_pCallbackData when HPMChangeCallbackInfo::m_Operation is set to EHPMChangeCallbackOperation_TaskLastAssignedInWorkflowStatusChange.
struct HPMChangeCallbackData_TaskLastAssignedInWorkflowStatusChange {
HPMInt32 m_bChangeInitiatedFromThisSession;
HPMUniqueID m_ChangedByResourceID;
HPMUniqueID m_ChangedByImpersonatedResourceID;
HPMUniqueID m_TaskID;
HPMUInt32 m_WorkflowID;
HPMUInt32 m_WorkflowObjectID;
} HPMChangeCallbackData_TaskLastAssignedInWorkflowStatusChange;
Members
m_bChangeInitiatedFromThisSession
Set to 1 if this change in the database was the result of an operation that was initiated from this session.
m_ChangedByResourceID
The unique identifier of the resource that initiated the change.
m_ChangedByImpersonatedResourceID
The unique identifier of the impersonated resource that initiated the change.
m_TaskID
The unique identifier of the task that was changed.
m_WorkflowID
The identifier of the workflow that had a status change. If set to -1 all status assignments for all workflows on this task might have changed.
m_WorkflowObjectID
The identifier of the old status in the workflow.
See Also
EHPMChangeCallbackOperation, HPMChangeCallbackInfo
HPMChangeCallbackData_TaskChangeCustomColumnData
Callback data type for HPMChangeCallbackInfo::m_pCallbackData when HPMChangeCallbackInfo::m_Operation is set to EHPMChangeCallbackOperation_TaskChangeCustomColumnData.
struct HPMChangeCallbackData_TaskChangeCustomColumnData {
HPMInt32 m_bChangeInitiatedFromThisSession;
HPMUniqueID m_ChangedByResourceID;
HPMUniqueID m_ChangedByImpersonatedResourceID;
HPMUniqueID m_TaskID;
HPMUInt32 m_ColumnHash;
} HPMChangeCallbackData_TaskChangeCustomColumnData;
Members
m_bChangeInitiatedFromThisSession
Set to 1 if this change in the database was the result of an operation that was initiated from this session.
m_ChangedByResourceID
The unique identifier of the resource that initiated the change.
m_ChangedByImpersonatedResourceID
The unique identifier of the impersonated resource that initiated the change.
m_TaskID
The unique identifier of the task that a custom column data entry was changed for.
m_ColumnHash
The hash of the column of which data on the task was changed.
See Also
EHPMChangeCallbackOperation, HPMChangeCallbackInfo
HPMChangeCallbackData_TaskChangeLastResourceCommentReadTime
Callback data type for HPMChangeCallbackInfo::m_pCallbackData when HPMChangeCallbackInfo::m_Operation is set to EHPMChangeCallbackOperation_TaskChangeLastResourceCommentReadTime.
struct HPMChangeCallbackData_TaskChangeLastResourceCommentReadTime {
HPMInt32 m_bChangeInitiatedFromThisSession;
HPMUniqueID m_ChangedByResourceID;
HPMUniqueID m_ChangedByImpersonatedResourceID;
HPMUniqueID m_TaskID;
HPMUniqueID m_ResourceID;
} HPMChangeCallbackData_TaskChangeLastResourceCommentReadTime;
Members
m_bChangeInitiatedFromThisSession
Set to 1 if this change in the database was the result of an operation that was initiated from this session.
m_ChangedByResourceID
The unique identifier of the resource that initiated the change.
m_ChangedByImpersonatedResourceID
The unique identifier of the impersonated resource that initiated the change.
m_TaskID
The unique identifier of the task that a last resource comment read time was changed for.
m_ResourceID
The unique identifier of the resource that last resource comment read time was changed for.
See Also
EHPMChangeCallbackOperation, HPMChangeCallbackInfo
HPMChangeCallbackData_TaskChangeWorkRemainingHistory
Callback data type for HPMChangeCallbackInfo::m_pCallbackData when HPMChangeCallbackInfo::m_Operation is set to EHPMChangeCallbackOperation_TaskChangeWorkRemainingHistory.
struct HPMChangeCallbackData_TaskChangeWorkRemainingHistory {
HPMInt32 m_bChangeInitiatedFromThisSession;
HPMUniqueID m_ChangedByResourceID;
HPMUniqueID m_ChangedByImpersonatedResourceID;
HPMUniqueID m_TaskID;
HPMUInt32 m_DayInSprint;
} HPMChangeCallbackData_TaskChangeWorkRemainingHistory;
Members
m_bChangeInitiatedFromThisSession
Set to 1 if this change in the database was the result of an operation that was initiated from this session.
m_ChangedByResourceID
The unique identifier of the resource that initiated the change.
m_ChangedByImpersonatedResourceID
The unique identifier of the impersonated resource that initiated the change.
m_TaskID
The unique identifier of the task that work remaining history was changed for.
m_DayInSprint
The day in the sprint that work remaining was changed for.
See Also
EHPMChangeCallbackOperation, HPMChangeCallbackInfo
HPMChangeCallbackData_TaskChangePointsHistory
Callback data type for HPMChangeCallbackInfo::m_pCallbackData when HPMChangeCallbackInfo::m_Operation is set to or EHPMChangeCallbackOperation_TaskChangePointsHistory.
struct HPMChangeCallbackData_TaskChangePointsHistory {
HPMInt32 m_bChangeInitiatedFromThisSession;
HPMUniqueID m_ChangedByResourceID;
HPMUniqueID m_ChangedByImpersonatedResourceID;
HPMUniqueID m_TaskID;
HPMUInt32 m_DayInSprint;
} HPMChangeCallbackData_TaskChangePointsHistory;
Members
m_bChangeInitiatedFromThisSession
Set to 1 if this change in the database was the result of an operation that was initiated from this session.
m_ChangedByResourceID
The unique identifier of the resource that initiated the change.
m_ChangedByImpersonatedResourceID
The unique identifier of the impersonated resource that initiated the change.
m_TaskID
The unique identifier of the task that history was changed for.
m_DayInSprint
The day in the sprint that history was changed for.
See Also
EHPMChangeCallbackOperation, HPMChangeCallbackInfo
HPMChangeCallbackData_TaskChangeIdealDaysHistory
Callback data type for HPMChangeCallbackInfo::m_pCallbackData when HPMChangeCallbackInfo::m_Operation is set to EHPMChangeCallbackOperation_TaskChangeIdealDaysHistory.
struct HPMChangeCallbackData_TaskChangeIdealDaysHistory {
HPMInt32 m_bChangeInitiatedFromThisSession;
HPMUniqueID m_ChangedByResourceID;
HPMUniqueID m_ChangedByImpersonatedResourceID;
HPMUniqueID m_TaskID;
HPMUInt32 m_DayInSprint;
} HPMChangeCallbackData_TaskChangeIdealDaysHistory;
Members
m_bChangeInitiatedFromThisSession
Set to 1 if this change in the database was the result of an operation that was initiated from this session.
m_ChangedByResourceID
The unique identifier of the resource that initiated the change.
m_ChangedByImpersonatedResourceID
The unique identifier of the impersonated resource that initiated the change.
m_TaskID
The unique identifier of the task that history was changed for.
m_DayInSprint
The day in the sprint that history was changed for.
See Also
EHPMChangeCallbackOperation, HPMChangeCallbackInfo
HPMChangeCallbackData_TaskRefChange
Callback data type for HPMChangeCallbackInfo::m_pCallbackData when HPMChangeCallbackInfo::m_Operation is set to EHPMChangeCallbackOperation_TaskRefChange.
struct HPMChangeCallbackData_TaskRefChange {
HPMInt32 m_bChangeInitiatedFromThisSession;
HPMUniqueID m_ChangedByResourceID;
HPMUniqueID m_ChangedByImpersonatedResourceID;
HPMUniqueID m_TaskRefID;
HPMUInt32 m_FieldChanged;
} HPMChangeCallbackData_TaskRefChange;
Members
m_bChangeInitiatedFromThisSession
Set to 1 if this change in the database was the result of an operation that was initiated from this session.
m_ChangedByResourceID
The unique identifier of the resource that initiated the change.
m_ChangedByImpersonatedResourceID
The unique identifier of the impersonated resource that initiated the change.
m_TaskRefID
The unique identifier of the task reference that data was changed for.
m_FieldChanged
The type of data in the task reference that was changed. Can be one of EHPMTaskRefField.
See Also
EHPMChangeCallbackOperation, HPMChangeCallbackInfo, EHPMTaskRefField
HPMChangeCallbackData_TaskRefDelete
Callback data type for HPMChangeCallbackInfo::m_pCallbackData when HPMChangeCallbackInfo::m_Operation is set to EHPMChangeCallbackOperation_TaskRefDelete.
struct HPMChangeCallbackData_TaskRefDelete {
HPMInt32 m_bChangeInitiatedFromThisSession;
HPMUniqueID m_ChangedByResourceID;
HPMUniqueID m_ChangedByImpersonatedResourceID;
HPMUniqueID m_TaskRefID;
HPMUniqueID m_TaskID;
HPMUniqueID m_TaskRefContainerID;
HPMUniqueID m_TaskProjectID;
HPMUniqueID m_RealProjectID;
HPMUniqueID m_BacklogProjectID;
HPMUniqueID m_QAProjectID;
} HPMChangeCallbackData_TaskRefDelete;
Members
m_bChangeInitiatedFromThisSession
Set to 1 if this change in the database was the result of an operation that was initiated from this session.
m_ChangedByResourceID
The unique identifier of the resource that initiated the change.
m_ChangedByImpersonatedResourceID
The unique identifier of the impersonated resource that initiated the change.
m_TaskRefID
The unique identifier of the task reference that was deleted.
m_TaskID
The unique identifier of the task for the deleted task reference.
m_TaskRefContainerID
The unique identifier of the deleted task reference container. Can be a project or a resource.
m_TaskProjectID
The unique identifier of the container project of the task for the deleted task reference.
m_RealProjectID
The unique identifier of the main project of the task for the deleted task reference.
m_BacklogProjectID
The unique identifier of the backlog project of the task for the deleted task reference.
m_QAProjectID
The unique identifier of the QA project of the task for the deleted task reference.
See Also
EHPMChangeCallbackOperation, HPMChangeCallbackInfo
HPMChangeCallbackData_TaskRefConnect
Callback data type for HPMChangeCallbackInfo::m_pCallbackData when HPMChangeCallbackInfo::m_Operation is set to EHPMChangeCallbackOperation_TaskRefConnect.
struct HPMChangeCallbackData_TaskRefConnect {
HPMInt32 m_bChangeInitiatedFromThisSession;
HPMUniqueID m_ChangedByResourceID;
HPMUniqueID m_ChangedByImpersonatedResourceID;
HPMUniqueID m_LocalTempConnectionID;
HPMUniqueID m_ConnectionID;
HPMUniqueID m_TaskRefIDFrom;
HPMUniqueID m_TaskRefIDTo;
} HPMChangeCallbackData_TaskRefConnect;
Members
m_bChangeInitiatedFromThisSession
Set to 1 if this change in the database was the result of an operation that was initiated from this session.
m_ChangedByResourceID
The unique identifier of the resource that initiated the change.
m_ChangedByImpersonatedResourceID
The unique identifier of the impersonated resource that initiated the change.
m_LocalTempConnectionID
When in nonblocking mode this is the identifier returned from the TaskRefConnect function.
m_ConnectionID
The unique identifier of the created connection.
m_TaskRefIDFrom
The unique identifier of the task a task was connected from.
m_TaskRefIDTo
The unique identifier of the task a task was connected to.
See Also
EHPMChangeCallbackOperation, HPMChangeCallbackInfo
HPMChangeCallbackData_TaskConnectionDelete
Callback data type for HPMChangeCallbackInfo::m_pCallbackData when HPMChangeCallbackInfo::m_Operation is set to EHPMChangeCallbackOperation_TaskConnectionDelete.
struct HPMChangeCallbackData_TaskConnectionDelete {
HPMInt32 m_bChangeInitiatedFromThisSession;
HPMUniqueID m_ChangedByResourceID;
HPMUniqueID m_ChangedByImpersonatedResourceID;
HPMUniqueID m_ConnectionID;
} HPMChangeCallbackData_TaskConnectionDelete;
Members
m_bChangeInitiatedFromThisSession
Set to 1 if this change in the database was the result of an operation that was initiated from this session.
m_ChangedByResourceID
The unique identifier of the resource that initiated the change.
m_ChangedByImpersonatedResourceID
The unique identifier of the impersonated resource that initiated the change.
m_ConnectionID
The unique identifier of
See Also
EHPMChangeCallbackOperation, HPMChangeCallbackInfo
HPMChangeCallbackData_TaskConnectionChangeType
Callback data type for HPMChangeCallbackInfo::m_pCallbackData when HPMChangeCallbackInfo::m_Operation is set to EHPMChangeCallbackOperation_TaskConnectionChangeType.
struct HPMChangeCallbackData_TaskConnectionChangeType {
HPMInt32 m_bChangeInitiatedFromThisSession;
HPMUniqueID m_ChangedByResourceID;
HPMUniqueID m_ChangedByImpersonatedResourceID;
HPMUniqueID m_ConnectionID;
} HPMChangeCallbackData_TaskConnectionChangeType;
Members
m_bChangeInitiatedFromThisSession
Set to 1 if this change in the database was the result of an operation that was initiated from this session.
m_ChangedByResourceID
The unique identifier of the resource that initiated the change.
m_ChangedByImpersonatedResourceID
The unique identifier of the impersonated resource that initiated the change.
m_ConnectionID
The unique identifier of the connection that the type was changed for.
See Also
EHPMChangeCallbackOperation, HPMChangeCallbackInfo
HPMChangeCallbackData_TaskConnectionChangeLeadLagTime
Callback data type for HPMChangeCallbackInfo::m_pCallbackData when HPMChangeCallbackInfo::m_Operation is set to EHPMChangeCallbackOperation_TaskConnectionChangeLeadLagTime.
struct HPMChangeCallbackData_TaskConnectionChangeLeadLagTime {
HPMInt32 m_bChangeInitiatedFromThisSession;
HPMUniqueID m_ChangedByResourceID;
HPMUniqueID m_ChangedByImpersonatedResourceID;
HPMUniqueID m_ConnectionID;
} HPMChangeCallbackData_TaskConnectionChangeLeadLagTime;
Members
m_bChangeInitiatedFromThisSession
Set to 1 if this change in the database was the result of an operation that was initiated from this session.
m_ChangedByResourceID
The unique identifier of the resource that initiated the change.
m_ChangedByImpersonatedResourceID
The unique identifier of the impersonated resource that initiated the change.
m_ConnectionID
The unique identifier of the connection that the type was changed for.
See Also
EHPMChangeCallbackOperation, HPMChangeCallbackInfo
HPMChangeCallbackData_DataHistoryReceived
Callback data type for HPMChangeCallbackInfo::m_pCallbackData when HPMChangeCallbackInfo::m_Operation is set to EHPMChangeCallbackOperation_DataHistoryReceived.
struct HPMChangeCallbackData_DataHistoryReceived {
HPMInt32 m_bChangeInitiatedFromThisSession;
HPMUniqueID m_ChangedByResourceID;
HPMUniqueID m_ChangedByImpersonatedResourceID;
HPMUniqueID m_UniqueIdentifier;
HPMInt32 m_FieldID;
HPMUInt32 m_FieldData;
HPMUInt32 m_DataIdent0;
HPMUInt32 m_DataIdent1;
} HPMChangeCallbackData_DataHistoryReceived;
Members
m_bChangeInitiatedFromThisSession
Set to 1 if this change in the database was the result of an operation that was initiated from this session.
m_ChangedByResourceID
The unique identifier of the resource that initiated the change.
m_ChangedByImpersonatedResourceID
The unique identifier of the impersonated resource that initiated the change.
m_UniqueIdentifier
The unique identifier of the data received.
m_FieldID
The field id of the data received.
m_FieldData
The field data of the data received.
m_DataIdent0
The first data identifier of the data received.
m_DataIdent1
The second data identifier of the data received.
See Also
EHPMChangeCallbackOperation, HPMChangeCallbackInfo
HPMChangeCallbackData_ChatHistoryReceived
Callback data type for HPMChangeCallbackInfo::m_pCallbackData when HPMChangeCallbackInfo::m_Operation is set to EHPMChangeCallbackOperation_ChatHistoryReceived.
struct HPMChangeCallbackData_ChatHistoryReceived {
HPMInt32 m_bChangeInitiatedFromThisSession;
HPMUniqueID m_ChangedByResourceID;
HPMUniqueID m_ChangedByImpersonatedResourceID;
HPMUniqueID m_UniqueIdentifier;
HPMChatRoom m_ChatRoom;
} HPMChangeCallbackData_ChatHistoryReceived;
Members
m_bChangeInitiatedFromThisSession
Set to 1 if this change in the database was the result of an operation that was initiated from this session.
m_ChangedByResourceID
The unique identifier of the resource that initiated the change.
m_ChangedByImpersonatedResourceID
The unique identifier of the impersonated resource that initiated the change.
m_UniqueIdentifier
The unique identifier of the data received.
m_ChatRoom
The chat room identifier of the chat history data received.
See Also
EHPMChangeCallbackOperation, HPMChangeCallbackInfo
HPMChangeCallbackData_CalendarChangeHolidays
Callback data type for HPMChangeCallbackInfo::m_pCallbackData when HPMChangeCallbackInfo::m_Operation is set to EHPMChangeCallbackOperation_CalendarChangeHolidays
struct HPMChangeCallbackData_CalendarChangeHolidays {
HPMInt32 m_bChangeInitiatedFromThisSession;
HPMUniqueID m_ChangedByResourceID;
HPMUniqueID m_ChangedByImpersonatedResourceID;
HPMUniqueID m_ProjectID;
} HPMChangeCallbackData_CalendarChangeHolidays;
Members
m_bChangeInitiatedFromThisSession
Set to 1 if this change in the database was the result of an operation that was initiated from this session.
m_ChangedByResourceID
The unique identifier of the resource that initiated the change.
m_ChangedByImpersonatedResourceID
The unique identifier of the impersonated resource that initiated the change.
m_ProjectID
The unique identifier of the project where the calendar was changed.
See Also
EHPMChangeCallbackOperation, HPMChangeCallbackInfo
HPMChangeCallbackData_CalendarChangeCustomWorkingHours
Callback data type for HPMChangeCallbackInfo::m_pCallbackData when HPMChangeCallbackInfo::m_Operation is set to EHPMChangeCallbackOperation_CalendarChangeChangedWorkingHours
struct HPMChangeCallbackData_CalendarChangeCustomWorkingHours {
HPMInt32 m_bChangeInitiatedFromThisSession;
HPMUniqueID m_ChangedByResourceID;
HPMUniqueID m_ChangedByImpersonatedResourceID;
HPMUniqueID m_ProjectID;
} HPMChangeCallbackData_CalendarChangeCustomWorkingHours;
Members
m_bChangeInitiatedFromThisSession
Set to 1 if this change in the database was the result of an operation that was initiated from this session.
m_ChangedByResourceID
The unique identifier of the resource that initiated the change.
m_ChangedByImpersonatedResourceID
The unique identifier of the impersonated resource that initiated the change.
m_ProjectID
The unique identifier of the project where the calendar was changed.
See Also
EHPMChangeCallbackOperation, HPMChangeCallbackInfo
HPMChangeCallbackData_CalendarChangeWorkingHours
Callback data type for HPMChangeCallbackInfo::m_pCallbackData when HPMChangeCallbackInfo::m_Operation is set to EHPMChangeCallbackOperation_CalendarChangeWorkingHours
struct HPMChangeCallbackData_CalendarChangeWorkingHours {
HPMInt32 m_bChangeInitiatedFromThisSession;
HPMUniqueID m_ChangedByResourceID;
HPMUniqueID m_ChangedByImpersonatedResourceID;
HPMUniqueID m_ProjectID;
} HPMChangeCallbackData_CalendarChangeWorkingHours;
Members
m_bChangeInitiatedFromThisSession
Set to 1 if this change in the database was the result of an operation that was initiated from this session.
m_ChangedByResourceID
The unique identifier of the resource that initiated the change.
m_ChangedByImpersonatedResourceID
The unique identifier of the impersonated resource that initiated the change.
m_ProjectID
The unique identifier of the project where the calendar was changed.
See Also
EHPMChangeCallbackOperation, HPMChangeCallbackInfo
HPMChangeCallbackData_CalendarChangeCustomWorkingDays
Callback data type for HPMChangeCallbackInfo::m_pCallbackData when HPMChangeCallbackInfo::m_Operation is set to EHPMChangeCallbackOperation_CalendarChangeChangedWorkingDays
struct HPMChangeCallbackData_CalendarChangeCustomWorkingDays {
HPMInt32 m_bChangeInitiatedFromThisSession;
HPMUniqueID m_ChangedByResourceID;
HPMUniqueID m_ChangedByImpersonatedResourceID;
HPMUniqueID m_ProjectID;
} HPMChangeCallbackData_CalendarChangeCustomWorkingDays;
Members
m_bChangeInitiatedFromThisSession
Set to 1 if this change in the database was the result of an operation that was initiated from this session.
m_ChangedByResourceID
The unique identifier of the resource that initiated the change.
m_ChangedByImpersonatedResourceID
The unique identifier of the impersonated resource that initiated the change.
m_ProjectID
The unique identifier of the project where the calendar was changed.
See Also
EHPMChangeCallbackOperation, HPMChangeCallbackInfo
HPMChangeCallbackData_CalendarChangeWorkingDays
Callback data type for HPMChangeCallbackInfo::m_pCallbackData when HPMChangeCallbackInfo::m_Operation is set to EHPMChangeCallbackOperation_CalendarChangeWorkingDays
struct HPMChangeCallbackData_CalendarChangeWorkingDays {
HPMInt32 m_bChangeInitiatedFromThisSession;
HPMUniqueID m_ChangedByResourceID;
HPMUniqueID m_ChangedByImpersonatedResourceID;
HPMUniqueID m_ProjectID;
} HPMChangeCallbackData_CalendarChangeWorkingDays;
Members
m_bChangeInitiatedFromThisSession
Set to 1 if this change in the database was the result of an operation that was initiated from this session.
m_ChangedByResourceID
The unique identifier of the resource that initiated the change.
m_ChangedByImpersonatedResourceID
The unique identifier of the impersonated resource that initiated the change.
m_ProjectID
The unique identifier of the project where the calendar was changed.
See Also
EHPMChangeCallbackOperation, HPMChangeCallbackInfo
HPMChangeCallbackData_VersionControlAllCommandsFinished
Callback data type for HPMChangeCallbackInfo::m_pCallbackData when HPMChangeCallbackInfo::m_Operation is set to EHPMChangeCallbackOperation_VersionControlAllCommandsFinished.
struct HPMChangeCallbackData_VersionControlAllCommandsFinished {
HPMUInt32 m_Dummy;
} HPMChangeCallbackData_VersionControlAllCommandsFinished;
Members
m_Dummy
No data needed.
See Also
EHPMChangeCallbackOperation, HPMChangeCallbackInfo
HPMChangeCallbackData_VersionControlFileInfoChanged
Callback data type for HPMChangeCallbackInfo::m_pCallbackData when HPMChangeCallbackInfo::m_Operation is set to EHPMChangeCallbackOperation_VersionControlFileInfoChanged.
struct HPMChangeCallbackData_VersionControlFileInfoChanged {
HPMUInt32 m_Dummy;
} HPMChangeCallbackData_VersionControlFileInfoChanged;
Members
m_Dummy
No data needed.
See Also
EHPMChangeCallbackOperation, HPMChangeCallbackInfo
HPMChangeCallbackData_VersionControlFileTreeAvailable
Callback data type for HPMChangeCallbackInfo::m_pCallbackData when HPMChangeCallbackInfo::m_Operation is set to EHPMChangeCallbackOperation_VersionControlFileTreeAvailable.
struct HPMChangeCallbackData_VersionControlFileTreeAvailable {
HPMUInt32 m_Dummy;
} HPMChangeCallbackData_VersionControlFileTreeAvailable;
Members
m_Dummy
No data needed.
Comments
This callback will be received when the file tree has changed on the server. The new file tree will be downloaded the next time you enumerate files.
See Also
EHPMChangeCallbackOperation, HPMChangeCallbackInfo
HPMChangeCallbackData_VersionControlWarnFileOverwriteDelete
Callback data type for HPMChangeCallbackInfo::m_pCallbackData when HPMChangeCallbackInfo::m_Operation is set to EHPMChangeCallbackOperation_VersionControlWarnFileOverwriteDelete.
struct HPMChangeCallbackData_VersionControlWarnFileOverwriteDelete {
HPMUInt32 m_nFilesToDelete;
const HPMString * m_pFilesToDelete;
HPMUInt32 m_nFilesToOverwrite;
const HPMString * m_pFilesToOverwrite;
} HPMChangeCallbackData_VersionControlWarnFileOverwriteDelete;
Members
m_nFilesToDelete
The number of files that will be deleted that wasn't in document management before.
m_pFilesToDelete
Pointer to a list of strings that are the files to be deleted.
m_nFilesToOverwrite
The number of changed files that will be overwritten.
m_pFilesToOverwrite
Pointer to a list of strings that are the files to be overwritten.
Comments
The HPMChangeCallback callback should return 1 if it is ok to delete and overwrite the files. If it is not ok it should return 0 and the operation will not be performed.
See Also
EHPMChangeCallbackOperation, HPMChangeCallbackInfo
HPMChangeCallbackData_VersionControlWarnCheckOutShouldSync
Callback data type for HPMChangeCallbackInfo::m_pCallbackData when HPMChangeCallbackInfo::m_Operation is set to EHPMChangeCallbackOperation_VersionControlWarnCheckOutShouldSync.
struct HPMChangeCallbackData_VersionControlWarnCheckOutShouldSync {
HPMUInt32 m_nFilesToDelete;
const HPMString * m_pFilesToDelete;
HPMUInt32 m_nFilesToOverwrite;
const HPMString * m_pFilesToOverwrite;
} HPMChangeCallbackData_VersionControlWarnCheckOutShouldSync;
Members
m_nFilesToDelete
The number of files that will be deleted that wasn't in document management before.
m_pFilesToDelete
Pointer to a list of strings that are the files to be deleted.
m_nFilesToOverwrite
The number of changed files that will be overwritten.
m_pFilesToOverwrite
Pointer to a list of strings that are the files to be overwritten.
Comments
The HPMChangeCallback callback should return 1 if it is ok to delete and overwrite the files. If it is not ok it should return 0 to check out the files without syncing them first. Otherwise return 2 and the operation will be canceled.
See Also
EHPMChangeCallbackOperation, HPMChangeCallbackInfo
HPMChangeCallbackData_VersionControlErrorResponse
Used to describe an error that occurred for a file in a version control operation.
struct HPMChangeCallbackData_VersionControlErrorResponse {
const HPMChar * m_pFile;
HPMUInt64 m_FileID;
HPMUInt32 m_Error;
const HPMUntranslatedString * m_pCustomError;
} HPMChangeCallbackData_VersionControlErrorResponse;
Members
m_pFile
The file that the error occurred for.
m_FileID
The file id of the file that the error occurred for.
m_Error
The error that occurred for the file. Can be one of EHPMVersionControlError.
m_pCustomError
A custom error string containing extra information about the error.
See Also
EHPMVersionControlError, HPMChangeCallbackData_VersionControlSyncFilesResponse, HPMChangeCallbackData_VersionControlRestoreDeletedFilesResponse, HPMChangeCallbackData_VersionControlDeleteFilesResponse, HPMChangeCallbackData_VersionControlRenameResponse, HPMChangeCallbackData_VersionControlCheckInFilesResponse, HPMChangeCallbackData_VersionControlAddFilesResponse, HPMChangeCallbackData_VersionControlCheckOutFilesResponse, HPMChangeCallbackData_VersionControlSetAccessRightsResponse, HPMChangeCallbackData_VersionControlRollbackFileResponse, HPMChangeCallbackData_VersionControlDeleteVersionsResponse,
HPMChangeCallbackData_VersionControlSyncFilesResponse
Callback data type for HPMChangeCallbackInfo::m_pCallbackData when HPMChangeCallbackInfo::m_Operation is set to EHPMChangeCallbackOperation_SyncFilesResponse.
struct HPMChangeCallbackData_VersionControlSyncFilesResponse {
HPMUInt32 m_nErrors;
const HPMChangeCallbackData_VersionControlErrorResponse * m_pErrors;
HPMUInt32 m_nNotSyncedBecauseCheckedOut;
const HPMChangeCallbackData_VersionControlErrorResponse * m_pNotSyncedBecauseCheckedOut;
HPMUInt32 m_nLocalFiles;
const HPMString * m_pLocalFiles;
} HPMChangeCallbackData_VersionControlSyncFilesResponse;
Members
m_nErrors
The number of errors that occurred.
m_pErrors
Pointer to a list of errors that occurred.
m_nNotSyncedBecauseCheckedOut
The number of files that were not synced because they are checked out.
m_pNotSyncedBecauseCheckedOut
Pointer to a list of files that were not synced because they are checked out.
m_nLocalFiles
The number of files of local files received. This member will only be valid if you specified to sync a specified version.
m_pLocalFiles
Pointer to a list of local files received. This member will only be valid if you specified to sync a specified version.
See Also
EHPMChangeCallbackOperation, HPMChangeCallbackInfo
HPMChangeCallbackData_VersionControlAddFilesResponse
Callback data type for HPMChangeCallbackInfo::m_pCallbackData when HPMChangeCallbackInfo::m_Operation is set to EHPMChangeCallbackOperation_VersionControlAddFilesResponse.
struct HPMChangeCallbackData_VersionControlAddFilesResponse {
HPMUInt32 m_nErrors;
const HPMChangeCallbackData_VersionControlErrorResponse * m_pErrors;
HPMUInt32 m_nSucceeded;
const HPMChangeCallbackData_VersionControlErrorResponse * m_pSucceeded;
HPMUInt32 m_nAlreadyExists;
const HPMChangeCallbackData_VersionControlErrorResponse * m_pAlreadyExists;
HPMUInt32 m_nExtraData;
const HPMUInt8 * m_pExtraData;
} HPMChangeCallbackData_VersionControlAddFilesResponse;
Members
m_nErrors
The number of errors that occurred.
m_pErrors
Pointer to a list of errors that occurred.
m_nSucceeded
The number of files that succeeded.
m_pSucceeded
Pointer to a list of files that succeeded.
m_nAlreadyExists
The number of files that were not synced because they are checked out.
m_pAlreadyExists
Pointer to a list of files that were not synced because they are checked out.
m_nExtraData
The number of bytes of extra data in the response. The extra data is the same as specified in HPMVersionControlAddFiles.
m_pExtraData
Pointer to a buffer of bytes. The extra data is the same as specified in HPMVersionControlAddFiles.
See Also
EHPMChangeCallbackOperation, HPMChangeCallbackInfo, HPMVersionControlAddFiles
HPMChangeCallbackData_VersionControlUploadAvatarFilesResponse
Callback data type for HPMChangeCallbackInfo::m_pCallbackData when HPMChangeCallbackInfo::m_Operation is set to EHPMChangeCallbackOperation_VersionControlUploadAvatarFilesResponse.
struct HPMChangeCallbackData_VersionControlUploadAvatarFilesResponse {
HPMUInt32 m_nDeleteErrors;
const HPMChangeCallbackData_VersionControlErrorResponse * m_pDeleteErrors;
HPMUInt32 m_nDeleteSucceeded;
const HPMChangeCallbackData_VersionControlErrorResponse * m_pDeleteSucceeded;
HPMUInt32 m_nErrors;
const HPMChangeCallbackData_VersionControlErrorResponse * m_pErrors;
HPMUInt32 m_nSucceeded;
const HPMChangeCallbackData_VersionControlErrorResponse * m_pSucceeded;
HPMUInt32 m_nAlreadyExists;
const HPMChangeCallbackData_VersionControlErrorResponse * m_pAlreadyExists;
HPMUInt32 m_nExtraData;
const HPMUInt8 * m_pExtraData;
} HPMChangeCallbackData_VersionControlUploadAvatarFilesResponse;
Members
m_nDeleteErrors
The number of delete previous avatar files errors that occurred.
m_pDeleteErrors
Pointer to a list of delete previous avatar files errors that occurred.
m_nDeleteSucceeded
The number of delete previous avatar files that succeeded.
m_pDeleteSucceeded
Pointer to a list of delete previous avatar files that succeeded.
m_nErrors
The number of errors that occurred.
m_pErrors
Pointer to a list of errors that occurred.
m_nSucceeded
The number of files that succeeded.
m_pSucceeded
Pointer to a list of files that succeeded.
m_nAlreadyExists
The number of files that were not synced because they are checked out.
m_pAlreadyExists
Pointer to a list of files that were not synced because they are checked out.
m_nExtraData
The number of bytes of extra data in the response. The extra data is the same as specified in HPMVersionControlAddFiles.
m_pExtraData
Pointer to a buffer of bytes. The extra data is the same as specified in HPMVersionControlAddFiles.
See Also
EHPMChangeCallbackOperation, HPMChangeCallbackInfo
HPMChangeCallbackData_VersionControlCheckInFilesResponse
Callback data type for HPMChangeCallbackInfo::m_pCallbackData when HPMChangeCallbackInfo::m_Operation is set to EHPMChangeCallbackOperation_VersionControlCheckInFilesResponse.
struct HPMChangeCallbackData_VersionControlCheckInFilesResponse {
HPMUInt32 m_nErrors;
const HPMChangeCallbackData_VersionControlErrorResponse * m_pErrors;
HPMUInt32 m_nSucceeded;
const HPMChangeCallbackData_VersionControlErrorResponse * m_pSucceeded;
HPMUInt32 m_nSkippedFiles;
HPMInt32 m_bForceReverted;
HPMUInt32 m_nExtraData;
const HPMUInt8 * m_pExtraData;
} HPMChangeCallbackData_VersionControlCheckInFilesResponse;
Members
m_nErrors
The number of errors that occurred.
m_pErrors
Pointer to a list of errors that occurred.
m_nSucceeded
The number of files that succeeded.
m_pSucceeded
Pointer to a list of files that succeeded.
m_nSkippedFiles
The number of files that were skipped.
m_bForceReverted
If set to 1 the files where force reverted, 0 otherwise.
m_nExtraData
The number of bytes of extra data in the response. The extra data is the same as specified in HPMVersionControlCheckInFiles.
m_pExtraData
Pointer to a buffer of bytes. The extra data is the same as specified in HPMVersionControlCheckInFiles.
See Also
EHPMChangeCallbackOperation, HPMChangeCallbackInfo, HPMVersionControlCheckInFiles
HPMChangeCallbackData_VersionControlCheckOutFilesResponse
Callback data type for HPMChangeCallbackInfo::m_pCallbackData when HPMChangeCallbackInfo::m_Operation is set to EHPMChangeCallbackOperation_VersionControlCheckOutFilesResponse.
struct HPMChangeCallbackData_VersionControlCheckOutFilesResponse {
HPMUInt32 m_nErrors;
const HPMChangeCallbackData_VersionControlErrorResponse * m_pErrors;
HPMUInt32 m_nSucceeded;
const HPMChangeCallbackData_VersionControlErrorResponse * m_pSucceeded;
HPMUInt32 m_nAlreadyCheckedOut;
const HPMChangeCallbackData_VersionControlErrorResponse * m_pAlreadyCheckedOut;
} HPMChangeCallbackData_VersionControlCheckOutFilesResponse;
Members
m_nErrors
The number of errors that occurred.
m_pErrors
Pointer to a list of errors that occurred.
m_nSucceeded
The number of files that succeeded.
m_pSucceeded
Pointer to a list of files that succeeded.
m_nAlreadyCheckedOut
The number of files that were already checked out.
m_pAlreadyCheckedOut
Pointer to a list of files that were already checked out.
See Also
EHPMChangeCallbackOperation, HPMChangeCallbackInfo, HPMVersionControlCheckInFiles
HPMChangeCallbackData_VersionControlRenameResponse
Callback data type for HPMChangeCallbackInfo::m_pCallbackData when HPMChangeCallbackInfo::m_Operation is set to EHPMChangeCallbackOperation_VersionControlRenameResponse.
struct HPMChangeCallbackData_VersionControlRenameResponse {
HPMUInt32 m_nErrors;
const HPMChangeCallbackData_VersionControlErrorResponse * m_pErrors;
HPMUInt32 m_nSucceeded;
const HPMChangeCallbackData_VersionControlErrorResponse * m_pSucceeded;
} HPMChangeCallbackData_VersionControlRenameResponse;
Members
m_nErrors
The number of errors that occurred.
m_pErrors
Pointer to a list of errors that occurred.
m_nSucceeded
The number of files that succeeded.
m_pSucceeded
Pointer to a list of files that succeeded.
See Also
EHPMChangeCallbackOperation, HPMChangeCallbackInfo, HPMVersionControlCheckInFiles
HPMChangeCallbackData_VersionControlDeleteFilesResponse
Callback data type for HPMChangeCallbackInfo::m_pCallbackData when HPMChangeCallbackInfo::m_Operation is set to EHPMChangeCallbackOperation_VersionControlDeleteFilesResponse.
struct HPMChangeCallbackData_VersionControlDeleteFilesResponse {
HPMUInt32 m_nErrors;
const HPMChangeCallbackData_VersionControlErrorResponse * m_pErrors;
HPMUInt32 m_nSucceeded;
const HPMChangeCallbackData_VersionControlErrorResponse * m_pSucceeded;
} HPMChangeCallbackData_VersionControlDeleteFilesResponse;
Members
m_nErrors
The number of errors that occurred.
m_pErrors
Pointer to a list of errors that occurred.
m_nSucceeded
The number of files that succeeded.
m_pSucceeded
Pointer to a list of files that succeeded.
See Also
EHPMChangeCallbackOperation, HPMChangeCallbackInfo, HPMVersionControlCheckInFiles
HPMChangeCallbackData_VersionControlRestoreDeletedFilesResponse
Callback data type for HPMChangeCallbackInfo::m_pCallbackData when HPMChangeCallbackInfo::m_Operation is set to EHPMChangeCallbackOperation_VersionControlRestoreDeletedFilesResponse.
struct HPMChangeCallbackData_VersionControlRestoreDeletedFilesResponse {
HPMUInt32 m_nErrors;
const HPMChangeCallbackData_VersionControlErrorResponse * m_pErrors;
HPMUInt32 m_nSucceeded;
const HPMChangeCallbackData_VersionControlErrorResponse * m_pSucceeded;
} HPMChangeCallbackData_VersionControlRestoreDeletedFilesResponse;
Members
m_nErrors
The number of errors that occurred.
m_pErrors
Pointer to a list of errors that occurred.
m_nSucceeded
The number of files that succeeded.
m_pSucceeded
Pointer to a list of files that succeeded.
See Also
EHPMChangeCallbackOperation, HPMChangeCallbackInfo, HPMVersionControlCheckInFiles
HPMChangeCallbackData_VersionControlSetAccessRightsResponse
Callback data type for HPMChangeCallbackInfo::m_pCallbackData when HPMChangeCallbackInfo::m_Operation is set to EHPMChangeCallbackOperation_VersionControlSetAccessRightsResponse.
struct HPMChangeCallbackData_VersionControlSetAccessRightsResponse {
HPMUInt32 m_nErrors;
const HPMChangeCallbackData_VersionControlErrorResponse * m_pErrors;
HPMUInt32 m_nSucceeded;
const HPMChangeCallbackData_VersionControlErrorResponse * m_pSucceeded;
} HPMChangeCallbackData_VersionControlSetAccessRightsResponse;
Members
m_nErrors
The number of errors that occurred.
m_pErrors
Pointer to a list of errors that occurred.
m_nSucceeded
The number of files that succeeded.
m_pSucceeded
Pointer to a list of files that succeeded.
See Also
EHPMChangeCallbackOperation, HPMChangeCallbackInfo, HPMVersionControlCheckInFiles
HPMChangeCallbackData_VersionControlRollbackFileResponse
Callback data type for HPMChangeCallbackInfo::m_pCallbackData when HPMChangeCallbackInfo::m_Operation is set to EHPMChangeCallbackOperation_VersionControlRollbackFileResponse.
struct HPMChangeCallbackData_VersionControlRollbackFileResponse {
HPMUInt32 m_nErrors;
const HPMChangeCallbackData_VersionControlErrorResponse * m_pErrors;
HPMUInt32 m_nSucceeded;
const HPMChangeCallbackData_VersionControlErrorResponse * m_pSucceeded;
} HPMChangeCallbackData_VersionControlRollbackFileResponse;
Members
m_nErrors
The number of errors that occurred.
m_pErrors
Pointer to a list of errors that occurred.
m_nSucceeded
The number of files that succeeded.
m_pSucceeded
Pointer to a list of files that succeeded.
See Also
EHPMChangeCallbackOperation, HPMChangeCallbackInfo, HPMVersionControlCheckInFiles
HPMChangeCallbackData_VersionControlDeleteVersionsResponse
Callback data type for HPMChangeCallbackInfo::m_pCallbackData when HPMChangeCallbackInfo::m_Operation is set to EHPMChangeCallbackOperation_VersionControlDeleteVersionResponse.
struct HPMChangeCallbackData_VersionControlDeleteVersionsResponse {
HPMUInt32 m_nErrors;
const HPMChangeCallbackData_VersionControlErrorResponse * m_pErrors;
HPMUInt32 m_nSucceeded;
const HPMChangeCallbackData_VersionControlErrorResponse * m_pSucceeded;
} HPMChangeCallbackData_VersionControlDeleteVersionsResponse;
Members
m_nErrors
The number of errors that occurred.
m_pErrors
Pointer to a list of errors that occurred.
m_nSucceeded
The number of files that succeeded.
m_pSucceeded
Pointer to a list of files that succeeded.
See Also
EHPMChangeCallbackOperation, HPMChangeCallbackInfo, HPMVersionControlCheckInFiles
HPMChangeCallbackData_VersionControlGetAccessRightsResponse
Callback data type for HPMChangeCallbackInfo::m_pCallbackData when HPMChangeCallbackInfo::m_Operation is set to EHPMChangeCallbackOperation_VersionControlGetAccessRightsResponse.
struct HPMChangeCallbackData_VersionControlGetAccessRightsResponse {
const HPMChar * m_pFile;
HPMInt32 m_bAccessDenied;
} HPMChangeCallbackData_VersionControlGetAccessRightsResponse;
Members
m_pFile
The file that now has access rights cached locally.
m_bAccessDenied
Access to getting access rights was denied.
See Also
EHPMChangeCallbackOperation, HPMChangeCallbackInfo, VersionControlGetAccessRights
HPMChangeCallbackData_VersionControlGetFileHistoryResponse
Callback data type for HPMChangeCallbackInfo::m_pCallbackData when HPMChangeCallbackInfo::m_Operation is set to EHPMChangeCallbackOperation_VersionControlGetFileHistoryResponse.
struct HPMChangeCallbackData_VersionControlGetFileHistoryResponse {
const HPMChar * m_pFile;
HPMInt32 m_bAccessDenied;
} HPMChangeCallbackData_VersionControlGetFileHistoryResponse;
Members
m_pFile
The file that now has file history cached locally.
m_bAccessDenied
Access to getting file history rights was denied.
See Also
EHPMChangeCallbackOperation, HPMChangeCallbackInfo, VersionControlGetFileHistory
HPMChangeCallbackData_GlobalCustomSettingsChange
Callback data type for HPMChangeCallbackInfo::m_pCallbackData when HPMChangeCallbackInfo::m_Operation is set to EHPMChangeCallbackOperation_GlobalCustomSettingsChange.
struct HPMChangeCallbackData_GlobalCustomSettingsChange {
HPMInt32 m_bChangeInitiatedFromThisSession;
HPMUniqueID m_ChangedByResourceID;
HPMUniqueID m_ChangedByImpersonatedResourceID;
HPMUInt32 m_IdentifierHash;
} HPMChangeCallbackData_GlobalCustomSettingsChange;
Members
m_bChangeInitiatedFromThisSession
Set to 1 if this change in the database was the result of an operation that was initiated from this session.
m_ChangedByResourceID
The unique identifier of the resource that initiated the change.
m_ChangedByImpersonatedResourceID
The unique identifier of the impersonated resource that initiated the change.
m_IdentifierHash
The identifier hash of the integration identifier for which custom settings changed. See GlobalGetCustomSettingsIdentifierHash.
See Also
EHPMChangeCallbackOperation, HPMChangeCallbackInfo, GlobalGetCustomSettingsIdentifierHash
HPMChangeCallbackData_GlobalCustomSettingsUnregister
Callback data type for HPMChangeCallbackInfo::m_pCallbackData when HPMChangeCallbackInfo::m_Operation is set to EHPMChangeCallbackOperation_GlobalCustomSettingsUnregister.
struct HPMChangeCallbackData_GlobalCustomSettingsUnregister {
HPMInt32 m_bChangeInitiatedFromThisSession;
HPMUniqueID m_ChangedByResourceID;
HPMUniqueID m_ChangedByImpersonatedResourceID;
HPMUInt32 m_IdentifierHash;
} HPMChangeCallbackData_GlobalCustomSettingsUnregister;
Members
m_bChangeInitiatedFromThisSession
Set to 1 if this change in the database was the result of an operation that was initiated from this session.
m_ChangedByResourceID
The unique identifier of the resource that initiated the change.
m_ChangedByImpersonatedResourceID
The unique identifier of the impersonated resource that initiated the change.
m_IdentifierHash
The identifier hash of the integration identifier for which custom settings was unregistered. See GlobalGetCustomSettingsIdentifierHash.
See Also
EHPMChangeCallbackOperation, HPMChangeCallbackInfo, GlobalGetCustomSettingsIdentifierHash
HPMChangeCallbackData_GlobalCustomSettingsValueChange
Callback data type for HPMChangeCallbackInfo::m_pCallbackData when HPMChangeCallbackInfo::m_Operation is set to EHPMChangeCallbackOperation_GlobalCustomSettingsValueChange.
struct HPMChangeCallbackData_GlobalCustomSettingsValueChange {
HPMInt32 m_bChangeInitiatedFromThisSession;
HPMUniqueID m_ChangedByResourceID;
HPMUniqueID m_ChangedByImpersonatedResourceID;
HPMUInt32 m_SettingsType;
HPMUInt32 m_IdentifierHash;
const HPMChar * m_pSettingsPath;
} HPMChangeCallbackData_GlobalCustomSettingsValueChange;
Members
m_bChangeInitiatedFromThisSession
Set to 1 if this change in the database was the result of an operation that was initiated from this session.
m_ChangedByResourceID
The unique identifier of the resource that initiated the change.
m_ChangedByImpersonatedResourceID
The unique identifier of the impersonated resource that initiated the change.
m_SettingsType
The settings type that changed. Will be one of EHPMCustomSettingsType.
m_IdentifierHash
The identifier hash of the integration identifier for which the custom settings value was changed. See GlobalGetCustomSettingsIdentifierHash.
m_pSettingsPath
The path of the setting that changed.
See Also
EHPMChangeCallbackOperation, HPMChangeCallbackInfo, GlobalGetCustomSettingsIdentifierHash, EHPMCustomSettingsType
HPMChangeCallbackData_ProjectCustomSettingsValueChange
Callback data type for HPMChangeCallbackInfo::m_pCallbackData when HPMChangeCallbackInfo::m_Operation is set to EHPMChangeCallbackOperation_ProjectCustomSettingsValueChange.
struct HPMChangeCallbackData_ProjectCustomSettingsValueChange {
HPMInt32 m_bChangeInitiatedFromThisSession;
HPMUniqueID m_ChangedByResourceID;
HPMUniqueID m_ChangedByImpersonatedResourceID;
HPMUInt32 m_SettingsType;
HPMUniqueID m_ProjectID;
HPMUInt32 m_IdentifierHash;
const HPMChar * m_pSettingsPath;
} HPMChangeCallbackData_ProjectCustomSettingsValueChange;
Members
m_bChangeInitiatedFromThisSession
Set to 1 if this change in the database was the result of an operation that was initiated from this session.
m_ChangedByResourceID
The unique identifier of the resource that initiated the change.
m_ChangedByImpersonatedResourceID
The unique identifier of the impersonated resource that initiated the change.
m_SettingsType
The settings type that changed. Will be one of EHPMCustomSettingsType.
m_ProjectID
The unique identifier of the project that the custom settings value changed for.
m_IdentifierHash
The identifier hash of the integration identifier for which the custom settings value was changed. See GlobalGetCustomSettingsIdentifierHash.
m_pSettingsPath
The path of the setting that changed.
See Also
EHPMChangeCallbackOperation, HPMChangeCallbackInfo, GlobalGetCustomSettingsIdentifierHash, EHPMCustomSettingsType
HPMChangeCallbackData_ProjectResourceCustomSettingsValueChange
Callback data type for HPMChangeCallbackInfo::m_pCallbackData when HPMChangeCallbackInfo::m_Operation is set to EHPMChangeCallbackOperation_ProjectResourceCustomSettingsValueChange.
struct HPMChangeCallbackData_ProjectResourceCustomSettingsValueChange {
HPMInt32 m_bChangeInitiatedFromThisSession;
HPMUniqueID m_ChangedByResourceID;
HPMUniqueID m_ChangedByImpersonatedResourceID;
HPMUInt32 m_SettingsType;
HPMUniqueID m_ProjectID;
HPMUniqueID m_ResourceID;
HPMUInt32 m_IdentifierHash;
const HPMChar * m_pSettingsPath;
} HPMChangeCallbackData_ProjectResourceCustomSettingsValueChange;
Members
m_bChangeInitiatedFromThisSession
Set to 1 if this change in the database was the result of an operation that was initiated from this session.
m_ChangedByResourceID
The unique identifier of the resource that initiated the change.
m_ChangedByImpersonatedResourceID
The unique identifier of the impersonated resource that initiated the change.
m_SettingsType
The settings type that changed. Will be one of EHPMCustomSettingsType.
m_ProjectID
The unique identifier of the project that the custom settings value changed for.
m_ResourceID
The unique identifier of the resource that the custom settings value changed for.
m_IdentifierHash
The identifier hash of the integration identifier for which the custom settings value was changed. See GlobalGetCustomSettingsIdentifierHash.
m_pSettingsPath
The path of the setting that changed.
See Also
EHPMChangeCallbackOperation, HPMChangeCallbackInfo, GlobalGetCustomSettingsIdentifierHash, EHPMCustomSettingsType
HPMChangeCallbackData_ResourceCustomSettingsValueChange
Callback data type for HPMChangeCallbackInfo::m_pCallbackData when HPMChangeCallbackInfo::m_Operation is set to EHPMChangeCallbackOperation_ResourceCustomSettingsValueChange.
struct HPMChangeCallbackData_ResourceCustomSettingsValueChange {
HPMInt32 m_bChangeInitiatedFromThisSession;
HPMUniqueID m_ChangedByResourceID;
HPMUniqueID m_ChangedByImpersonatedResourceID;
HPMUInt32 m_SettingsType;
HPMUniqueID m_ResourceID;
HPMUInt32 m_IdentifierHash;
const HPMChar * m_pSettingsPath;
} HPMChangeCallbackData_ResourceCustomSettingsValueChange;
Members
m_bChangeInitiatedFromThisSession
Set to 1 if this change in the database was the result of an operation that was initiated from this session.
m_ChangedByResourceID
The unique identifier of the resource that initiated the change.
m_ChangedByImpersonatedResourceID
The unique identifier of the impersonated resource that initiated the change.
m_SettingsType
The settings type that changed. Will be one of EHPMCustomSettingsType.
m_ResourceID
The unique identifier of the resource that the custom settings value changed for.
m_IdentifierHash
The identifier hash of the integration identifier for which the custom settings value was changed. See GlobalGetCustomSettingsIdentifierHash.
m_pSettingsPath
The path of the setting that changed.
See Also
EHPMChangeCallbackOperation, HPMChangeCallbackInfo, GlobalGetCustomSettingsIdentifierHash, EHPMCustomSettingsType
HPMChangeCallbackData_GlobalSDKInternalDataChange
Callback data type for HPMChangeCallbackInfo::m_pCallbackData when HPMChangeCallbackInfo::m_Operation is set to EHPMChangeCallbackOperation_GlobalSDKInternalDataChange.
struct HPMChangeCallbackData_GlobalSDKInternalDataChange {
HPMInt32 m_bChangeInitiatedFromThisSession;
HPMUniqueID m_ChangedByResourceID;
HPMUniqueID m_ChangedByImpersonatedResourceID;
HPMUInt32 m_IdentifierHash;
} HPMChangeCallbackData_GlobalSDKInternalDataChange;
Members
m_bChangeInitiatedFromThisSession
Set to 1 if this change in the database was the result of an operation that was initiated from this session.
m_ChangedByResourceID
The unique identifier of the resource that initiated the change.
m_ChangedByImpersonatedResourceID
The unique identifier of the impersonated resource that initiated the change.
m_IdentifierHash
The identifier hash of the SDK internal data identifier for which the SDK internal data was changed. See GlobalGetSDKInternalDataIdentifierHash.
See Also
EHPMChangeCallbackOperation, HPMChangeCallbackInfo, GlobalGetSDKInternalDataIdentifierHash
HPMChangeCallbackData_ProjectSDKInternalDataChange
Callback data type for HPMChangeCallbackInfo::m_pCallbackData when HPMChangeCallbackInfo::m_Operation is set to EHPMChangeCallbackOperation_ProjectSDKInternalDataChange.
struct HPMChangeCallbackData_ProjectSDKInternalDataChange {
HPMInt32 m_bChangeInitiatedFromThisSession;
HPMUniqueID m_ChangedByResourceID;
HPMUniqueID m_ChangedByImpersonatedResourceID;
HPMUniqueID m_ProjectID;
HPMUInt32 m_IdentifierHash;
} HPMChangeCallbackData_ProjectSDKInternalDataChange;
Members
m_bChangeInitiatedFromThisSession
Set to 1 if this change in the database was the result of an operation that was initiated from this session.
m_ChangedByResourceID
The unique identifier of the resource that initiated the change.
m_ChangedByImpersonatedResourceID
The unique identifier of the impersonated resource that initiated the change.
m_ProjectID
The unique identifier of the project that the SDK internal data changed for.
m_IdentifierHash
The identifier hash of the SDK internal data identifier for which the SDK internal data was changed. See GlobalGetSDKInternalDataIdentifierHash.
See Also
EHPMChangeCallbackOperation, HPMChangeCallbackInfo, GlobalGetSDKInternalDataIdentifierHash
HPMChangeCallbackData_ProjectResourceSDKInternalDataChange
Callback data type for HPMChangeCallbackInfo::m_pCallbackData when HPMChangeCallbackInfo::m_Operation is set to EHPMChangeCallbackOperation_ProjectResourceSDKInternalDataChange.
struct HPMChangeCallbackData_ProjectResourceSDKInternalDataChange {
HPMInt32 m_bChangeInitiatedFromThisSession;
HPMUniqueID m_ChangedByResourceID;
HPMUniqueID m_ChangedByImpersonatedResourceID;
HPMUniqueID m_ProjectID;
HPMUniqueID m_ResourceID;
HPMUInt32 m_IdentifierHash;
} HPMChangeCallbackData_ProjectResourceSDKInternalDataChange;
Members
m_bChangeInitiatedFromThisSession
Set to 1 if this change in the database was the result of an operation that was initiated from this session.
m_ChangedByResourceID
The unique identifier of the resource that initiated the change.
m_ChangedByImpersonatedResourceID
The unique identifier of the impersonated resource that initiated the change.
m_ProjectID
The unique identifier of the project that the SDK internal data changed for.
m_ResourceID
The unique identifier of the resource that the SDK internal data changed for.
m_IdentifierHash
The identifier hash of the SDK internal data identifier for which the SDK internal data was changed. See GlobalGetSDKInternalDataIdentifierHash.
See Also
EHPMChangeCallbackOperation, HPMChangeCallbackInfo, GlobalGetSDKInternalDataIdentifierHash
HPMChangeCallbackData_ResourceSDKInternalDataChange
Callback data type for HPMChangeCallbackInfo::m_pCallbackData when HPMChangeCallbackInfo::m_Operation is set to EHPMChangeCallbackOperation_ResourceSDKInternalDataChange.
struct HPMChangeCallbackData_ResourceSDKInternalDataChange {
HPMInt32 m_bChangeInitiatedFromThisSession;
HPMUniqueID m_ChangedByResourceID;
HPMUniqueID m_ChangedByImpersonatedResourceID;
HPMUniqueID m_ResourceID;
HPMUInt32 m_IdentifierHash;
} HPMChangeCallbackData_ResourceSDKInternalDataChange;
Members
m_bChangeInitiatedFromThisSession
Set to 1 if this change in the database was the result of an operation that was initiated from this session.
m_ChangedByResourceID
The unique identifier of the resource that initiated the change.
m_ChangedByImpersonatedResourceID
The unique identifier of the impersonated resource that initiated the change.
m_ResourceID
The unique identifier of the resource that the SDK internal data changed for.
m_IdentifierHash
The identifier hash of the SDK internal data identifier for which the SDK internal data was changed. See GlobalGetSDKInternalDataIdentifierHash.
See Also
EHPMChangeCallbackOperation, HPMChangeCallbackInfo, GlobalGetSDKInternalDataIdentifierHash
HPMChangeCallbackData_TaskSDKInternalDataChange
Callback data type for HPMChangeCallbackInfo::m_pCallbackData when HPMChangeCallbackInfo::m_Operation is set to EHPMChangeCallbackOperation_TaskSDKInternalDataChange.
struct HPMChangeCallbackData_TaskSDKInternalDataChange {
HPMInt32 m_bChangeInitiatedFromThisSession;
HPMUniqueID m_ChangedByResourceID;
HPMUniqueID m_ChangedByImpersonatedResourceID;
HPMUniqueID m_TaskID;
HPMUInt32 m_IdentifierHash;
} HPMChangeCallbackData_TaskSDKInternalDataChange;
Members
m_bChangeInitiatedFromThisSession
Set to 1 if this change in the database was the result of an operation that was initiated from this session.
m_ChangedByResourceID
The unique identifier of the resource that initiated the change.
m_ChangedByImpersonatedResourceID
The unique identifier of the impersonated resource that initiated the change.
m_TaskID
The unique identifier of the task that the SDK internal data changed for.
m_IdentifierHash
The identifier hash of the SDK internal data identifier for which the SDK internal data was changed. See GlobalGetSDKInternalDataIdentifierHash.
See Also
EHPMChangeCallbackOperation, HPMChangeCallbackInfo, GlobalGetSDKInternalDataIdentifierHash
HPMChangeCallbackData_TaskRefSDKInternalDataChange
Callback data type for HPMChangeCallbackInfo::m_pCallbackData when HPMChangeCallbackInfo::m_Operation is set to EHPMChangeCallbackOperation_TaskRefSDKInternalDataChange.
struct HPMChangeCallbackData_TaskRefSDKInternalDataChange {
HPMInt32 m_bChangeInitiatedFromThisSession;
HPMUniqueID m_ChangedByResourceID;
HPMUniqueID m_ChangedByImpersonatedResourceID;
HPMUniqueID m_TaskRefID;
HPMUInt32 m_IdentifierHash;
} HPMChangeCallbackData_TaskRefSDKInternalDataChange;
Members
m_bChangeInitiatedFromThisSession
Set to 1 if this change in the database was the result of an operation that was initiated from this session.
m_ChangedByResourceID
The unique identifier of the resource that initiated the change.
m_ChangedByImpersonatedResourceID
The unique identifier of the impersonated resource that initiated the change.
m_TaskRefID
The unique identifier of the task reference that the SDK internal data changed for.
m_IdentifierHash
The identifier hash of the SDK internal data identifier for which the SDK internal data was changed. See GlobalGetSDKInternalDataIdentifierHash.
See Also
EHPMChangeCallbackOperation, HPMChangeCallbackInfo, GlobalGetSDKInternalDataIdentifierHash
HPMChangeCallbackData_ClientExecuteURL
Callback data type for HPMChangeCallbackInfo::m_pCallbackData when HPMChangeCallbackInfo::m_Operation is set to EHPMChangeCallbackOperation_ClientExecuteURL.
struct HPMChangeCallbackData_ClientExecuteURL {
const HPMChar * m_pURL;
} HPMChangeCallbackData_ClientExecuteURL;
Members
m_pURL
The URL to execute.
Comments
The HPMChangeCallback callback should return 1 if the URL was parsed and executed. This will prevent further processing of this URL by other integration DLLs. If no integration dll handles the URL it will be executed by the default OS implementation.
See Also
EHPMChangeCallbackOperation, HPMChangeCallbackInfo
HPMChangeCallbackData_DynamicCustomSettingsValueChanged
Callback data type for HPMChangeCallbackInfo::m_pCallbackData when HPMChangeCallbackInfo::m_Operation is set to EHPMChangeCallbackOperation_DynamicCustomSettingsValueChanged.
struct HPMChangeCallbackData_DynamicCustomSettingsValueChanged {
HPMDynamicCustomSettingsContext const * m_pDynamicContext;
HPMUserContext m_UserContext;
HPMUniqueID m_ProjectID;
HPMUniqueID m_ResourceID;
HPMInt32 m_SettingsType;
HPMInt32 m_bTemporary;
const HPMChar * m_pPath;
const HPMChar * m_pValue;
} HPMChangeCallbackData_DynamicCustomSettingsValueChanged;
Members
m_pDynamicContext
The context of the dialog that changes
m_UserContext
The value sent in as user context to GlobalRegisterForDynamicCustomSettingsNotifications;
m_ProjectID
The unique identifier of the project that the setting changed in. Only set when applicable.
m_ResourceID
The unique identiier of the resource that the setting changed for. Only set when applicable.
m_SettingsType
The settings type this change originates from
m_bTemporary
Set to true when the user is writing in a edit box. You will get another notification when the edit box looses focus.
m_pPath
The path of the changed data.
m_pValue
The value that was changed to.
See Also
EHPMChangeCallbackOperation, HPMChangeCallbackInfo
HPMChangeCallbackData_DynamicCustomSettingsValuesRequestResponse
Callback data type for HPMChangeCallbackInfo::m_pCallbackData when HPMChangeCallbackInfo::m_Operation is set to EHPMChangeCallbackOperation_DynamicCustomSettingsValuesRequestResponse.
struct HPMChangeCallbackData_DynamicCustomSettingsValuesRequestResponse {
HPMDynamicCustomSettingsContext const * m_pDynamicContext;
HPMUserContext m_UserContext;
HPMDynamicCustomSettingsValues m_Values;
} HPMChangeCallbackData_DynamicCustomSettingsValuesRequestResponse;
Members
m_pDynamicContext
The context of the dialog that changes
m_UserContext
The value sent in as user context to GlobalRequestDynamicCustomSettingsValues;
m_Values
The result of the values requested.
See Also
EHPMChangeCallbackOperation, HPMChangeCallbackInfo
HPMChangeCallbackData_DynamicCustomSettingsNotification
Callback data type for HPMChangeCallbackInfo::m_pCallbackData when HPMChangeCallbackInfo::m_Operation is set to EHPMChangeCallbackOperation_DynamicCustomSettingsNotification.
struct HPMChangeCallbackData_DynamicCustomSettingsNotification {
HPMDynamicCustomSettingsContext const * m_pDynamicContext;
HPMUserContext m_UserContext;
HPMUniqueID m_ProjectID;
HPMUniqueID m_ResourceID;
HPMInt32 m_SettingsType;
HPMInt32 m_Notification;
HPMInt32 m_CustomNotification;
HPMUInt32 m_nTabIdentifiers;
HPMString const * m_pTabIdentifiers;
} HPMChangeCallbackData_DynamicCustomSettingsNotification;
Members
m_pDynamicContext
The context of the dialog that changes.
m_UserContext
The value sent in as user context to GlobalRegisterForDynamicCustomSettingsNotifications;
m_ProjectID
The unique identifier of the project that the setting changed in. Only set when applicable.
m_ResourceID
The unique identfier of the resource that the setting changed for. Only set when applicable.
m_SettingsType
The settings type this change originates from
m_Notification
The notification.
m_CustomNotification
The return value of the dialog box if m_Notification is EHPMDynamicCustomSettingsNotification_DialogEndCustom. This corresponds to the order of defined buttons.
m_nTabIdentifiers
The number of SDK tab identifiers in the dialog.
m_pTabIdentifiers
The SDK tab identifiers.
See Also
EHPMChangeCallbackOperation, HPMChangeCallbackInfo
HPMChangeCallbackData_CustomTaskStatusNotification
Callback data type for HPMChangeCallbackInfo::m_pCallbackData when HPMChangeCallbackInfo::m_Operation is set to EHPMChangeCallbackOperation_CustomTaskStatusNotification.
struct HPMChangeCallbackData_CustomTaskStatusNotification {
HPMDynamicCustomSettingsContext const * m_pDynamicContext;
HPMUserContext m_UserContext;
HPMInt32 m_Notification;
HPMUInt32 m_nSelectedTasks;
HPMUniqueID const * m_pSelectedTasks;
} HPMChangeCallbackData_CustomTaskStatusNotification;
Members
m_pDynamicContext
The context of the dialog that changes.
m_UserContext
The value sent in as user context to GlobalAddTasksCustomTaskStatusDialog;
m_Notification
The notification.
m_nSelectedTasks
The number of selected tasks when m_Notification is EHPMCustomTaskStatusNotification_DialogEndedOk.
m_pSelectedTasks
The selected tasks when m_Notification is EHPMCustomTaskStatusNotification_DialogEndedOk.
See Also
EHPMChangeCallbackOperation, HPMChangeCallbackInfo
HPMChangeCallbackData_DashboardChartReceive
Callback data type for HPMChangeCallbackInfo::m_pCallbackData when HPMChangeCallbackInfo::m_Operation is set to EHPMChangeCallbackOperation_DashboardChartReceive.
struct HPMChangeCallbackData_DashboardChartReceive {
HPMUniqueID m_ChartID;
HPMUInt64 m_FirstSampledAt;
HPMUInt64 m_LastSampledAt;
} HPMChangeCallbackData_DashboardChartReceive;
Members
m_ChartID
The unique identifier of the subscribed chart.
m_FirstSampledAt
Time of the first sample taken for sampled data. Invalid if the chart is not sampled. Expressed as the number of microseconds since 1970 UTC.
m_LastSampledAt
Time of the last sample taken for sampled data. Invalid if the chart is not sampled. Expressed as the number of microseconds since 1970 UTC.
See Also
EHPMChangeCallbackOperation, HPMChangeCallbackInfo
HPMChangeCallbackData_DashboardChartStatusUpdated
Callback data type for HPMChangeCallbackInfo::m_pCallbackData when HPMChangeCallbackInfo::m_Operation is set to EHPMChangeCallbackOperation_DashboardChartStatusUpdated.
struct HPMChangeCallbackData_DashboardChartStatusUpdated {
HPMUniqueID m_ChartID;
HPMInt32 m_Status;
HPMUInt64 m_LastUpdatedAt;
} HPMChangeCallbackData_DashboardChartStatusUpdated;
Members
m_ChartID
The unique identifier of the subscribed chart.
m_Status
// Current chart status.
m_LastUpdatedAt
Time when chart became up to date last time. Expressed as the number of microseconds since 1970 UTC.
See Also
EHPMChangeCallbackOperation, HPMChangeCallbackInfo
HPMChangeCallbackData_DashboardChartCreate
Callback data type for HPMChangeCallbackInfo::m_pCallbackData when HPMChangeCallbackInfo::m_Operation is set to EHPMChangeCallbackOperation_DashboardChartCreate.
struct HPMChangeCallbackData_DashboardChartCreate {
HPMInt32 m_bChangeInitiatedFromThisSession;
HPMUniqueID m_ChangedByResourceID;
HPMUniqueID m_ChangedByImpersonatedResourceID;
HPMUniqueID m_ChartID;
HPMUniqueID m_LocalObjectID;
HPMUniqueID m_PageID;
} HPMChangeCallbackData_DashboardChartCreate;
Members
m_bChangeInitiatedFromThisSession
Set to 1 if this change in the database was the result of an operation that was initiated from this session.
m_ChangedByResourceID
The unique identifier of the resource that initiated the change.
m_ChangedByImpersonatedResourceID
The unique identifier of the impersonated resource that initiated the change.
m_ChartID
The unique identifier of the created chart.
m_LocalObjectID
The local identifier optionally sent in with DashboardChartCreate.
m_PageID
The unique identifier of the page the chart was created on.
See Also
EHPMChangeCallbackOperation, HPMChangeCallbackInfo
HPMChangeCallbackData_DashboardComputationConfigurationChange
Callback data type for HPMChangeCallbackInfo::m_pCallbackData when HPMChangeCallbackInfo::m_Operation is set to EHPMChangeCallbackOperation_DashboardComputationConfigurationChange.
struct HPMChangeCallbackData_DashboardComputationConfigurationChange {
HPMInt32 m_bChangeInitiatedFromThisSession;
HPMUniqueID m_ChangedByResourceID;
HPMUniqueID m_ChangedByImpersonatedResourceID;
HPMUniqueID m_ChartID;
} HPMChangeCallbackData_DashboardComputationConfigurationChange;
Members
m_bChangeInitiatedFromThisSession
Set to 1 if this change in the database was the result of an operation that was initiated from this session.
m_ChangedByResourceID
The unique identifier of the resource that initiated the change.
m_ChangedByImpersonatedResourceID
The unique identifier of the impersonated resource that initiated the change.
m_ChartID
The unique identifier of the chart with configuration changes.
See Also
EHPMChangeCallbackOperation, HPMChangeCallbackInfo
HPMChangeCallbackData_DashboardPresentationConfigurationChange
Callback data type for HPMChangeCallbackInfo::m_pCallbackData when HPMChangeCallbackInfo::m_Operation is set to EHPMChangeCallbackOperation_DashboardPresentationConfigurationChange.
struct HPMChangeCallbackData_DashboardPresentationConfigurationChange {
HPMInt32 m_bChangeInitiatedFromThisSession;
HPMUniqueID m_ChangedByResourceID;
HPMUniqueID m_ChangedByImpersonatedResourceID;
HPMUniqueID m_ChartID;
} HPMChangeCallbackData_DashboardPresentationConfigurationChange;
Members
m_bChangeInitiatedFromThisSession
Set to 1 if this change in the database was the result of an operation that was initiated from this session.
m_ChangedByResourceID
The unique identifier of the resource that initiated the change.
m_ChangedByImpersonatedResourceID
The unique identifier of the impersonated resource that initiated the change.
m_ChartID
The unique identifier of the chart with configuration changes.
See Also
EHPMChangeCallbackOperation, HPMChangeCallbackInfo
HPMChangeCallbackData_DashboardChartDelete
Callback data type for HPMChangeCallbackInfo::m_pCallbackData when HPMChangeCallbackInfo::m_Operation is set to EHPMChangeCallbackOperation_DashboardChartDelete.
struct HPMChangeCallbackData_DashboardChartDelete {
HPMInt32 m_bChangeInitiatedFromThisSession;
HPMUniqueID m_ChangedByResourceID;
HPMUniqueID m_ChangedByImpersonatedResourceID;
HPMUniqueID m_ChartID;
HPMUniqueID m_PageID;
} HPMChangeCallbackData_DashboardChartDelete;
Members
m_bChangeInitiatedFromThisSession
Set to 1 if this change in the database was the result of an operation that was initiated from this session.
m_ChangedByResourceID
The unique identifier of the resource that initiated the change.
m_ChangedByImpersonatedResourceID
The unique identifier of the impersonated resource that initiated the change.
m_ChartID
The unique identifier of the chart that was deleted.
m_PageID
The unique identifier of the page the deleted chart was deleted on.
See Also
EHPMChangeCallbackOperation, HPMChangeCallbackInfo
HPMChangeCallbackData_DashboardChartNameChange
Callback data type for HPMChangeCallbackInfo::m_pCallbackData when HPMChangeCallbackInfo::m_Operation is set to EHPMChangeCallbackOperation_DashboardChartNameChange.
struct HPMChangeCallbackData_DashboardChartNameChange {
HPMInt32 m_bChangeInitiatedFromThisSession;
HPMUniqueID m_ChangedByResourceID;
HPMUniqueID m_ChangedByImpersonatedResourceID;
HPMUniqueID m_ChartID;
} HPMChangeCallbackData_DashboardChartNameChange;
Members
m_bChangeInitiatedFromThisSession
Set to 1 if this change in the database was the result of an operation that was initiated from this session.
m_ChangedByResourceID
The unique identifier of the resource that initiated the change.
m_ChangedByImpersonatedResourceID
The unique identifier of the impersonated resource that initiated the change.
m_ChartID
The unique identifier of the chart whose name was changed.
See Also
EHPMChangeCallbackOperation, HPMChangeCallbackInfo
HPMChangeCallbackData_DashboardPageCreate
Callback data type for HPMChangeCallbackInfo::m_pCallbackData when HPMChangeCallbackInfo::m_Operation is set to EHPMChangeCallbackOperation_DashboardPageCreate.
struct HPMChangeCallbackData_DashboardPageCreate {
HPMInt32 m_bChangeInitiatedFromThisSession;
HPMUniqueID m_ChangedByResourceID;
HPMUniqueID m_ChangedByImpersonatedResourceID;
HPMUniqueID m_PageID;
HPMUniqueID m_LocalObjectID;
HPMUniqueID m_ResourceID;
} HPMChangeCallbackData_DashboardPageCreate;
Members
m_bChangeInitiatedFromThisSession
Set to 1 if this change in the database was the result of an operation that was initiated from this session.
m_ChangedByResourceID
The unique identifier of the resource that initiated the change.
m_ChangedByImpersonatedResourceID
The unique identifier of the impersonated resource that initiated the change.
m_PageID
The unique identifier of the created page.
m_LocalObjectID
The local identifier optionally sent in with DashboardPageCreate.
m_ResourceID
The unique identifier of the resource that created the page.
See Also
EHPMChangeCallbackOperation, HPMChangeCallbackInfo
HPMChangeCallbackData_DashboardPageNameChange
Callback data type for HPMChangeCallbackInfo::m_pCallbackData when HPMChangeCallbackInfo::m_Operation is set to EHPMChangeCallbackOperation_DashboardPageNameChange.
struct HPMChangeCallbackData_DashboardPageNameChange {
HPMInt32 m_bChangeInitiatedFromThisSession;
HPMUniqueID m_ChangedByResourceID;
HPMUniqueID m_ChangedByImpersonatedResourceID;
HPMUniqueID m_PageID;
} HPMChangeCallbackData_DashboardPageNameChange;
Members
m_bChangeInitiatedFromThisSession
Set to 1 if this change in the database was the result of an operation that was initiated from this session.
m_ChangedByResourceID
The unique identifier of the resource that initiated the change.
m_ChangedByImpersonatedResourceID
The unique identifier of the impersonated resource that initiated the change.
m_PageID
The unique identifier of the page whose name was changed.
See Also
EHPMChangeCallbackOperation, HPMChangeCallbackInfo
HPMChangeCallbackData_DashboardThemeChange
Callback data type for HPMChangeCallbackInfo::m_pCallbackData when HPMChangeCallbackInfo::m_Operation is set to EHPMChangeCallbackOperation_DashboardThemeChange.
struct HPMChangeCallbackData_DashboardThemeChange {
HPMInt32 m_bChangeInitiatedFromThisSession;
HPMUniqueID m_ChangedByResourceID;
HPMUniqueID m_ChangedByImpersonatedResourceID;
HPMUniqueID m_PageID;
} HPMChangeCallbackData_DashboardThemeChange;
Members
m_bChangeInitiatedFromThisSession
Set to 1 if this change in the database was the result of an operation that was initiated from this session.
m_ChangedByResourceID
The unique identifier of the resource that initiated the change.
m_ChangedByImpersonatedResourceID
The unique identifier of the impersonated resource that initiated the change.
m_PageID
The unique identifier of the page whose theme was changed.
See Also
EHPMChangeCallbackOperation, HPMChangeCallbackInfo
HPMChangeCallbackData_DashboardPageLayoutChange
Callback data type for HPMChangeCallbackInfo::m_pCallbackData when HPMChangeCallbackInfo::m_Operation is set to EHPMChangeCallbackOperation_DashboardPageLayoutChange.
struct HPMChangeCallbackData_DashboardPageLayoutChange {
HPMInt32 m_bChangeInitiatedFromThisSession;
HPMUniqueID m_ChangedByResourceID;
HPMUniqueID m_ChangedByImpersonatedResourceID;
HPMUniqueID m_PageID;
} HPMChangeCallbackData_DashboardPageLayoutChange;
Members
m_bChangeInitiatedFromThisSession
Set to 1 if this change in the database was the result of an operation that was initiated from this session.
m_ChangedByResourceID
The unique identifier of the resource that initiated the change.
m_ChangedByImpersonatedResourceID
The unique identifier of the impersonated resource that initiated the change.
m_PageID
The unique identifier of the page whose layout was changed.
See Also
EHPMChangeCallbackOperation, HPMChangeCallbackInfo
HPMChangeCallbackData_DashboardPageSharedToWithViewingRightsChange
Callback data type for HPMChangeCallbackInfo::m_pCallbackData when HPMChangeCallbackInfo::m_Operation is set to EHPMChangeCallbackOperation_DashboardPageSharedToWithViewingRightsChange.
struct HPMChangeCallbackData_DashboardPageSharedToWithViewingRightsChange {
HPMInt32 m_bChangeInitiatedFromThisSession;
HPMUniqueID m_ChangedByResourceID;
HPMUniqueID m_ChangedByImpersonatedResourceID;
HPMUniqueID m_PageID;
} HPMChangeCallbackData_DashboardPageSharedToWithViewingRightsChange;
Members
m_bChangeInitiatedFromThisSession
Set to 1 if this change in the database was the result of an operation that was initiated from this session.
m_ChangedByResourceID
The unique identifier of the resource that initiated the change.
m_ChangedByImpersonatedResourceID
The unique identifier of the impersonated resource that initiated the change.
m_PageID
The unique identifier of the page whose shared to viewing rights was changed.
See Also
EHPMChangeCallbackOperation, HPMChangeCallbackInfo
HPMChangeCallbackData_DashboardPageSharedToWithEditingRightsChange
Callback data type for HPMChangeCallbackInfo::m_pCallbackData when HPMChangeCallbackInfo::m_Operation is set to EHPMChangeCallbackOperation_DashboardPageSharedToWithEditingRightsChange.
struct HPMChangeCallbackData_DashboardPageSharedToWithEditingRightsChange {
HPMInt32 m_bChangeInitiatedFromThisSession;
HPMUniqueID m_ChangedByResourceID;
HPMUniqueID m_ChangedByImpersonatedResourceID;
HPMUniqueID m_PageID;
} HPMChangeCallbackData_DashboardPageSharedToWithEditingRightsChange;
Members
m_bChangeInitiatedFromThisSession
Set to 1 if this change in the database was the result of an operation that was initiated from this session.
m_ChangedByResourceID
The unique identifier of the resource that initiated the change.
m_ChangedByImpersonatedResourceID
The unique identifier of the impersonated resource that initiated the change.
m_PageID
The unique identifier of the page whose shared to editing was changed.
See Also
EHPMChangeCallbackOperation, HPMChangeCallbackInfo
HPMChangeCallbackData_DashboardPageDelete
Callback data type for HPMChangeCallbackInfo::m_pCallbackData when HPMChangeCallbackInfo::m_Operation is set to EHPMChangeCallbackOperation_DashboardPageDelete.
struct HPMChangeCallbackData_DashboardPageDelete {
HPMInt32 m_bChangeInitiatedFromThisSession;
HPMUniqueID m_ChangedByResourceID;
HPMUniqueID m_ChangedByImpersonatedResourceID;
HPMUniqueID m_PageID;
} HPMChangeCallbackData_DashboardPageDelete;
Members
m_bChangeInitiatedFromThisSession
Set to 1 if this change in the database was the result of an operation that was initiated from this session.
m_ChangedByResourceID
The unique identifier of the resource that initiated the change.
m_ChangedByImpersonatedResourceID
The unique identifier of the impersonated resource that initiated the change.
m_PageID
The unique identifier of the page that was deleted.
See Also
EHPMChangeCallbackOperation, HPMChangeCallbackInfo
HPMChangeCallbackData_UserNotMemberOfProject
Callback data type for HPMChangeCallbackInfo::m_pCallbackData when HPMChangeCallbackInfo::m_Operation is set to EHPMChangeCallbackOperation_UserNotMemberOfProject.
struct HPMChangeCallbackData_UserNotMemberOfProject {
HPMInt32 m_bChangeInitiatedFromThisSession;
} HPMChangeCallbackData_UserNotMemberOfProject;
Members
m_bChangeInitiatedFromThisSession
Set to 1 if this change in the database was the result of an operation that was initiated from this session.
See Also
EHPMChangeCallbackOperation, HPMChangeCallbackInfo
HPMChangeCallbackData_RightClickDisplayTaskMenu
Callback data type for HPMChangeCallbackInfo::m_pCallbackData when HPMChangeCallbackInfo::m_Operation is set to EHPMChangeCallbackOperation_RightClickDisplayTaskMenu.
struct HPMChangeCallbackData_RightClickDisplayTaskMenu {
HPMRightClickContext const * m_pRightClickContext;
HPMInt32 m_bMenuDisplayed;
HPMUserContext m_UserContext;
HPMUniqueID m_ProjectID;
HPMUInt32 m_nSelectedTasks;
HPMUniqueID const * m_pSelectedTasks;
} HPMChangeCallbackData_RightClickDisplayTaskMenu;
Members
m_pRightClickContext
The context of the popup menu that is displayed.
m_bMenuDisplayed
Set to 1 when menu is displayed, otherwise set to 0 when menu is dismissed.
m_UserContext
The value sent in as user context to GlobalRegisterForRightClickNotifications;
m_ProjectID
The unique identifier of the project where tasks were right clicked.
m_nSelectedTasks
The number of selected tasks.
m_pSelectedTasks
The selected tasks.
See Also
EHPMChangeCallbackOperation, HPMChangeCallbackInfo
HPMChangeCallbackData_RightClickDisplayWorkflowStepMenu
Callback data type for HPMChangeCallbackInfo::m_pCallbackData when HPMChangeCallbackInfo::m_Operation is set to EHPMChangeCallbackOperation_RightClickDisplayWorkflowStepMenu.
struct HPMChangeCallbackData_RightClickDisplayWorkflowStepMenu {
HPMRightClickContext const * m_pRightClickContext;
HPMInt32 m_bMenuDisplayed;
HPMUserContext m_UserContext;
HPMUniqueID m_ProjectID;
HPMUInt32 m_WorkflowID;
HPMUInt32 m_WorkflowObjectID;
} HPMChangeCallbackData_RightClickDisplayWorkflowStepMenu;
Members
m_pRightClickContext
The context of the popup menu that is displayed.
m_bMenuDisplayed
Set to 1 when menu is displayed, otherwise set to 0 when menu is dismissed.
m_UserContext
The value sent in as user context to GlobalRegisterForRightClickNotifications;
m_ProjectID
The unique identifier of the project where workflow object was right clicked.
m_WorkflowID
The identifier of the workflow that was right clicked.
m_WorkflowObjectID
The identifier of the workflow object that was right clicked.
See Also
EHPMChangeCallbackOperation, HPMChangeCallbackInfo
HPMChangeCallbackData_RightClickMenuItemSelected
Callback data type for HPMChangeCallbackInfo::m_pCallbackData when HPMChangeCallbackInfo::m_Operation is set to EHPMChangeCallbackOperation_RightClickMenuItemSelected.
struct HPMChangeCallbackData_RightClickMenuItemSelected {
HPMChar const * m_pUniqueName;
HPMUserContext m_MenuItemContext;
} HPMChangeCallbackData_RightClickMenuItemSelected;
Members
m_pUniqueName
The unique name passed to GlobalAddRightClickMenuItem.
m_MenuItemContext
The value sent in as user context to GlobalAddRightClickMenuItem;
See Also
EHPMChangeCallbackOperation, HPMChangeCallbackInfo
HPMChangeCallbackData_ProjectBugReportResourcesChange
Callback data type for HPMChangeCallbackInfo::m_pCallbackData when HPMChangeCallbackInfo::m_Operation is set to EHPMChangeCallbackOperation_ProjectBugReportResourcesChange.
struct HPMChangeCallbackData_ProjectBugReportResourcesChange {
HPMInt32 m_bChangeInitiatedFromThisSession;
HPMUniqueID m_ChangedByResourceID;
HPMUniqueID m_ChangedByImpersonatedResourceID;
HPMUniqueID m_ProjectID;
} HPMChangeCallbackData_ProjectBugReportResourcesChange;
Members
m_bChangeInitiatedFromThisSession
Set to 1 if this change in the database was the result of an operation that was initiated from this session.
m_ChangedByResourceID
The unique identifier of the resource that initiated the change.
m_ChangedByImpersonatedResourceID
The unique identifier of the impersonated resource that initiated the change.
m_ProjectID
The unique identifier of the project where the bug reporting resources changed.
See Also
EHPMChangeCallbackOperation, HPMChangeCallbackInfo
HPMChangeCallbackData_ProjectDefaultQAWorkflowChange
Callback data type for HPMChangeCallbackInfo::m_pCallbackData when HPMChangeCallbackInfo::m_Operation is set to EHPMChangeCallbackOperation_ProjectDefaultQAWorkflowChange.
struct HPMChangeCallbackData_ProjectDefaultQAWorkflowChange {
HPMInt32 m_bChangeInitiatedFromThisSession;
HPMUniqueID m_ChangedByResourceID;
HPMUniqueID m_ChangedByImpersonatedResourceID;
HPMUniqueID m_ProjectID;
HPMInt32 m_bValidChange;
} HPMChangeCallbackData_ProjectDefaultQAWorkflowChange;
Members
m_bChangeInitiatedFromThisSession
Set to 1 if this change in the database was the result of an operation that was initiated from this session.
m_ChangedByResourceID
The unique identifier of the resource that initiated the change.
m_ChangedByImpersonatedResourceID
The unique identifier of the impersonated resource that initiated the change.
m_ProjectID
The unique identifier of the project where the default QA worflow changed.
m_bValidChange
Set to 1 if the change succeeded, 0 otherwise.
See Also
EHPMChangeCallbackOperation, HPMChangeCallbackInfo
HPMChangeCallbackData_SharesUpdate
Callback data type for HPMChangeCallbackInfo::m_pCallbackData when HPMChangeCallbackInfo::m_Operation is set to EHPMChangeCallbackOperation_SharesUpdate.
struct HPMChangeCallbackData_SharesUpdate {
HPMInt32 m_bChangeInitiatedFromThisSession;
HPMUniqueID m_ChangedByResourceID;
HPMUniqueID m_ChangedByImpersonatedResourceID;
} HPMChangeCallbackData_SharesUpdate;
Members
m_bChangeInitiatedFromThisSession
Set to 1 if this change in the database was the result of an operation that was initiated from this session.
m_ChangedByResourceID
The unique identifier of the resource that initiated the change.
m_ChangedByImpersonatedResourceID
The unique identifier of the impersonated resource that initiated the change.
See Also
EHPMChangeCallbackOperation, HPMChangeCallbackInfo
HPMChangeCallbackData_SprintConvertedToBoard
Callback data type for HPMChangeCallbackInfo::m_pCallbackData when HPMChangeCallbackInfo::m_Operation is set to EHPMChangeCallbackOperation_SprintConvertedToBoard.
struct HPMChangeCallbackData_SprintConvertedToBoard {
HPMInt32 m_bChangeInitiatedFromThisSession;
HPMUniqueID m_ChangedByResourceID;
HPMUniqueID m_ChangedByImpersonatedResourceID;
HPMUniqueID m_TaskID;
HPMUInt32 m_bSuccess;
} HPMChangeCallbackData_SprintConvertedToBoard;
Members
m_bChangeInitiatedFromThisSession
Set to 1 if this change in the database was the result of an operation that was initiated from this session.
m_ChangedByResourceID
The unique identifier of the resource that initiated the change.
m_ChangedByImpersonatedResourceID
The unique identifier of the impersonated resource that initiated the change.
m_TaskID
The unique identifier of the sprint task.
m_bSuccess
Success or not.
See Also
EHPMChangeCallbackOperation, HPMChangeCallbackInfo
HPMChangeCallbackData_BoardCreate
Callback data type for HPMChangeCallbackInfo::m_pCallbackData when HPMChangeCallbackInfo::m_Operation is set to EHPMChangeCallbackOperation_BoardCreate.
struct HPMChangeCallbackData_BoardCreate {
HPMInt32 m_bChangeInitiatedFromThisSession;
HPMUniqueID m_ChangedByResourceID;
HPMUniqueID m_ChangedByImpersonatedResourceID;
HPMUniqueID m_BoardID;
HPMUniqueEnum m_ElementLocalIDs;
HPMUniqueEnum m_ElementIDs;
} HPMChangeCallbackData_BoardCreate;
Members
m_bChangeInitiatedFromThisSession
Set to 1 if this change in the database was the result of an operation that was initiated from this session.
m_ChangedByResourceID
The unique identifier of the resource that initiated the change.
m_ChangedByImpersonatedResourceID
The unique identifier of the impersonated resource that initiated the change.
m_BoardID
The unique identifier of the created board.
m_ElementLocalIDs
The list of local element identifiers optionally sent in HPMBoardConfiguration.
m_ElementIDs
The list unique identifiers of the created elements, order matches the local IDs in m_ElementLocalIDs.
See Also
EHPMChangeCallbackOperation, HPMChangeCallbackInfo
HPMChangeCallbackData_BoardAttributesChanged
Callback data type for HPMChangeCallbackInfo::m_pCallbackData when HPMChangeCallbackInfo::m_Operation is set to EHPMChangeCallbackOperation_AttributesChanged.
struct HPMChangeCallbackData_BoardAttributesChanged {
HPMInt32 m_bChangeInitiatedFromThisSession;
HPMUniqueID m_ChangedByResourceID;
HPMUniqueID m_ChangedByImpersonatedResourceID;
HPMUniqueID m_BoardID;
HPMColumnList m_AttributeColumns;
HPMInt32 m_ClientLocalOperationID;
HPMInt32 m_bSuccess;
} HPMChangeCallbackData_BoardAttributesChanged;
Members
m_bChangeInitiatedFromThisSession
Set to 1 if this change in the database was the result of an operation that was initiated from this session.
m_ChangedByResourceID
The unique identifier of the resource that initiated the change.
m_ChangedByImpersonatedResourceID
The unique identifier of the impersonated resource that initiated the change.
m_BoardID
The unique identifier of the created board.
m_AttributeColumns
The list of visible attribute project columns on board.
m_ClientLocalOperationID
The client local operation ID that caused the callback.
m_bSuccess
Success or not.
See Also
EHPMChangeCallbackOperation, HPMChangeCallbackInfo
HPMChangeCallbackData_ColumnStatusMappingChanged
Callback data type for HPMChangeCallbackInfo::m_pCallbackData when HPMChangeCallbackInfo::m_Operation is set to EHPMChangeCallbackOperation_ColumnStatusMappingChanged.
struct HPMChangeCallbackData_ColumnStatusMappingChanged {
HPMInt32 m_bChangeInitiatedFromThisSession;
HPMUniqueID m_ChangedByResourceID;
HPMUniqueID m_ChangedByImpersonatedResourceID;
HPMUniqueID m_BoardID;
HPMUniqueID m_ColumnID;
HPMUInt32 m_Status;
HPMInt32 m_ClientLocalOperationID;
HPMInt32 m_bSuccess;
} HPMChangeCallbackData_ColumnStatusMappingChanged;
Members
m_bChangeInitiatedFromThisSession
Set to 1 if this change in the database was the result of an operation that was initiated from this session.
m_ChangedByResourceID
The unique identifier of the resource that initiated the change.
m_ChangedByImpersonatedResourceID
The unique identifier of the impersonated resource that initiated the change.
m_BoardID
The unique identifier of the created board.
m_ColumnID
The unique identifier of the column for which mapping changed. Makes sense only if m_bSuccess is true.
m_Status
New status that column was mapped to
m_ClientLocalOperationID
The client local operation ID that caused the callback.
m_bSuccess
Success or not.
See Also
EHPMChangeCallbackOperation, HPMChangeCallbackInfo
HPMChangeCallbackData_BoardElementUpdated
Callback data type for HPMChangeCallbackInfo::m_pCallbackData when HPMChangeCallbackInfo::m_Operation is set to EHPMChangeCallbackOperation_BoardElementUpdated.
struct HPMChangeCallbackData_BoardElementUpdated {
HPMInt32 m_bChangeInitiatedFromThisSession;
HPMUniqueID m_ChangedByResourceID;
HPMUniqueID m_ChangedByImpersonatedResourceID;
HPMUniqueID m_BoardID;
HPMUniqueID m_ParentLaneID;
HPMBoardElementDefinition m_Definition;
HPMInt32 m_ClientLocalOperationID;
HPMInt32 m_bWasRepositioning;
HPMInt32 m_Reason;
HPMInt32 m_bSuccess;
} HPMChangeCallbackData_BoardElementUpdated;
Members
m_bChangeInitiatedFromThisSession
Set to 1 if this change in the database was the result of an operation that was initiated from this session.
m_ChangedByResourceID
The unique identifier of the resource that initiated the change.
m_ChangedByImpersonatedResourceID
The unique identifier of the impersonated resource that initiated the change.
m_BoardID
The unique identifier of the board where element is updated/created.
m_ParentLaneID
The unique identifier of parent lane. -1 for if updated/created element is lane.
m_Definition
Definition of updated / created element.
m_ClientLocalOperationID
The client local operation ID that caused the callback.
m_bWasRepositioning
True if element updation / creation caused repositioning.
m_Reason
The reason of the updation
m_bSuccess
Success or not.
See Also
EHPMChangeCallbackOperation, HPMChangeCallbackInfo
HPMChangeCallbackData_BoardElementDeleted
Callback data type for HPMChangeCallbackInfo::m_pCallbackData when HPMChangeCallbackInfo::m_Operation is set to EHPMChangeCallbackOperation_BoardElementDeleted.
struct HPMChangeCallbackData_BoardElementDeleted {
HPMInt32 m_bChangeInitiatedFromThisSession;
HPMUniqueID m_ChangedByResourceID;
HPMUniqueID m_ChangedByImpersonatedResourceID;
HPMUniqueID m_BoardID;
HPMUniqueID m_ElementLocalID;
HPMUniqueID m_DeletedLane;
HPMUniqueEnum m_DeletedColumns;
HPMInt32 m_ClientLocalOperationID;
HPMInt32 m_bSuccess;
} HPMChangeCallbackData_BoardElementDeleted;
Members
m_bChangeInitiatedFromThisSession
Set to 1 if this change in the database was the result of an operation that was initiated from this session.
m_ChangedByResourceID
The unique identifier of the resource that initiated the change.
m_ChangedByImpersonatedResourceID
The unique identifier of the impersonated resource that initiated the change.
m_BoardID
The unique identifier of the board where element is updated/created.
m_ElementLocalID
The unique identifier of local element ID to delete. Optional.
m_DeletedLane
The unique identifier of lane that was deleted. -1 If deleted element requested is column.
m_DeletedColumns
The unique identifier of all columns that were deleted. Contains one element if deleted element requested is column.
m_ClientLocalOperationID
The client local operation ID that caused the callback.
m_bSuccess
Success or not.
See Also
EHPMChangeCallbackOperation, HPMChangeCallbackInfo
HPMTaskBoardCellMoveResult
Board cell move result.
struct HPMTaskBoardCellMoveResult {
HPMUniqueID m_LaneID;
HPMUniqueID m_ColumnID;
HPMBoardCardPositionPairEnum m_MovedCards;
HPMInt32 m_bSuccess;
} HPMTaskBoardCellMoveResult;
Members
m_LaneID
Lane of the cell.
m_ColumnID
Column of the cell.
m_MovedCards
The list of moved cards and their new position.
m_bSuccess
Success or not.
See Also
HPMChangeCallbackData_BoardCardMove
HPMChangeCallbackData_BoardCardMove
Callback data type for HPMChangeCallbackInfo::m_pCallbackData when HPMChangeCallbackInfo::m_Operation is set to EHPMChangeCallbackOperation_BoardCardMove.
struct HPMChangeCallbackData_BoardCardMove {
HPMInt32 m_bChangeInitiatedFromThisSession;
HPMUniqueID m_ChangedByResourceID;
HPMUniqueID m_ChangedByImpersonatedResourceID;
HPMUniqueID m_BoardID;
HPMInt32 m_Reason;
HPMInt32 m_nCellResults;
HPMTaskBoardCellMoveResult const * m_pCellResults;
HPMInt32 m_ClientLocalOperationID;
} HPMChangeCallbackData_BoardCardMove;
Members
m_bChangeInitiatedFromThisSession
Set to 1 if this change in the database was the result of an operation that was initiated from this session.
m_ChangedByResourceID
The unique identifier of the resource that initiated the change.
m_ChangedByImpersonatedResourceID
The unique identifier of the impersonated resource that initiated the change.
m_BoardID
The unique identifier of the board where the cards were moved.
m_Reason
The reason of the move.
m_nCellResults
Number of move cell results
m_pCellResults
Cell move results.
m_ClientLocalOperationID
The client local operation ID that caused the callback, always equals to -1 if m_Reason == EHPMBoardMoveReason_CardCreated
See Also
EHPMChangeCallbackOperation, HPMChangeCallbackInfo
HPMChangeCallbackData_BoardCardHide
Callback data type for HPMChangeCallbackInfo::m_pCallbackData when HPMChangeCallbackInfo::m_Operation is set to EHPMChangeCallbackOperation_BoardCardHide.
struct HPMChangeCallbackData_BoardCardHide {
HPMInt32 m_bChangeInitiatedFromThisSession;
HPMUniqueID m_ChangedByResourceID;
HPMUniqueID m_ChangedByImpersonatedResourceID;
HPMUniqueID m_BoardID;
HPMUniqueEnum m_HiddenCards;
HPMInt32 m_ClientLocalOperationID;
} HPMChangeCallbackData_BoardCardHide;
Members
m_bChangeInitiatedFromThisSession
Set to 1 if this change in the database was the result of an operation that was initiated from this session.
m_ChangedByResourceID
The unique identifier of the resource that initiated the change.
m_ChangedByImpersonatedResourceID
The unique identifier of the impersonated resource that initiated the change.
m_BoardID
The unique identifier of the board where the cards were moved.
m_HiddenCards
The list of ids of tasks that were hidden.
m_ClientLocalOperationID
The client local operation ID that caused the callback, always equals to -1 if m_Reason == EHPMBoardMoveReason_CardCreated
See Also
EHPMChangeCallbackOperation, HPMChangeCallbackInfo
HPMChangeCallbackData_BoardElementSettingsChanged
Callback data type for HPMChangeCallbackInfo::m_pCallbackData when HPMChangeCallbackInfo::m_Operation is set to EHPMChangeCallbackOperation_BoardElementSettingsChanged.
struct HPMChangeCallbackData_BoardElementSettingsChanged {
HPMInt32 m_bChangeInitiatedFromThisSession;
HPMUniqueID m_ChangedByResourceID;
HPMUniqueID m_ChangedByImpersonatedResourceID;
HPMUniqueID m_BoardID;
HPMUniqueID m_ElementID;
HPMInt32 m_Field;
HPMInt32 m_ClientLocalOperationID;
HPMInt32 m_bSuccess;
} HPMChangeCallbackData_BoardElementSettingsChanged;
Members
m_bChangeInitiatedFromThisSession
Set to 1 if this change in the database was the result of an operation that was initiated from this session.
m_ChangedByResourceID
The unique identifier of the resource that initiated the change.
m_ChangedByImpersonatedResourceID
The unique identifier of the impersonated resource that initiated the change.
m_BoardID
The unique identifier of the board where the element was changed.
m_ElementID
The unique identifier of changed element.
m_Field
Changed field.
m_ClientLocalOperationID
The client local operation ID that caused the callback.
m_bSuccess
Success or not.
See Also
EHPMChangeCallbackOperation, HPMChangeCallbackInfo
HPMChangeCallbackData_ClientSyncDone
Callback data type for HPMChangeCallbackInfo::m_pCallbackData when HPMChangeCallbackInfo::m_Operation is set to EHPMChangeCallbackOperation_ClientSyncDone.
struct HPMChangeCallbackData_ClientSyncDone {
HPMUniqueID m_ResourceID;
} HPMChangeCallbackData_ClientSyncDone;
Members
m_ResourceID
The resource id of the user that is logged in
See Also
EHPMChangeCallbackOperation, HPMChangeCallbackInfo
HPMChangeCallbackInfo
This structure is sent to the callback that is called when something in the database changes.
struct HPMChangeCallbackInfo {
void * m_pContext;
HPMUInt32 m_Operation;
const void * m_pCallbackData;
} HPMChangeCallbackInfo;
Members
m_pContext
User context. This is the context specified when calling RegisterChangeCallback.
m_Operation
The operation that was performed in the database. Can be one of EHPMChangeCallbackOperation.
m_pCallbackData
The data for the operation. This needs to be cast to the correct type depending on the m_Operation member.
See Also
EHPMChangeCallbackOperation, HPMChangeCallback, RegisterChangeCallback, UnregisterChangeCallback
HPMChangeCallbackData_TaskAssignmentChange
Callback data type for HPMChangeCallbackInfo::m_pCallbackData when HPMChangeCallbackInfo::m_Operation is set to EHPMChangeCallbackOperation_TaskAssignmentChange.
struct HPMChangeCallbackData_TaskAssignmentChange {
HPMInt32 m_bChangeInitiatedFromThisSession;
HPMUniqueID m_ChangedByResourceID;
HPMUniqueID m_ChangedByImpersonatedResourceID;
HPMUniqueID m_TaskID;
HPMUniqueID m_ResourceID;
HPMInt32 m_bAssigned;
HPMUniqueID m_ToDoTaskRefID;
} HPMChangeCallbackData_TaskAssignmentChange;
Members
m_bChangeInitiatedFromThisSession
Set to 1 if this change in the database was the result of an operation that was initiated from this session.
m_ChangedByResourceID
The unique identifier of the resource that initiated the change.
m_ChangedByImpersonatedResourceID
The unique identifier of the impersonated resource that initiated the change.
m_TaskID
The unique identifier of the task that was assigned/unassigned.
m_ResourceID
The unique identifier of the resource whose relationship with the task changed.
m_bAssigned
true if m_ResourceID was assigned to m_TaskID, false if m_ResourceID was unassigned from m_TaskID
m_ToDoTaskRefID
The unique id of the task reference that was created/deleted in m_ResourceIDs to do list. If nothing was changed in the to do the value is -1
See Also
EHPMChangeCallbackOperation, HPMChangeCallbackInfo
HPMChangeCallbackData_ResourceGroupAdded
Callback data type for HPMChangeCallbackInfo::m_pCallbackData when HPMChangeCallbackInfo::m_Operation is set to EHPMChangeCallbackOperation_ResourceGroupAdded.
struct HPMChangeCallbackData_ResourceGroupAdded {
HPMInt32 m_bChangeInitiatedFromThisSession;
HPMUniqueID m_ChangedByResourceID;
HPMUniqueID m_ChangedByImpersonatedResourceID;
HPMInt32 m_bSuccess;
HPMResourceGroupInfo m_Info;
HPMInt32 m_ClientLocalOperationID;
} HPMChangeCallbackData_ResourceGroupAdded;
Members
m_bChangeInitiatedFromThisSession
Set to 1 if this change in the database was the result of an operation that was initiated from this session.
m_ChangedByResourceID
The unique identifier of the resource that initiated the change.
m_ChangedByImpersonatedResourceID
The unique identifier of the impersonated resource that initiated the change.
m_bSuccess
Success or not.
m_Info
Created group info
m_ClientLocalOperationID
The client local operation ID that caused the EHPMChangeCallbackOperation_ResourceGroupAdded callback.
See Also
EHPMChangeCallbackOperation, HPMChangeCallbackInfo
HPMChangeCallbackData_ResourceGroupEdited
Callback data type for HPMChangeCallbackInfo::m_pCallbackData when HPMChangeCallbackInfo::m_Operation is set to EHPMChangeCallbackOperation_ResourceGroupEdited.
struct HPMChangeCallbackData_ResourceGroupEdited {
HPMInt32 m_bChangeInitiatedFromThisSession;
HPMUniqueID m_ChangedByResourceID;
HPMUniqueID m_ChangedByImpersonatedResourceID;
HPMInt32 m_bSuccess;
HPMResourceGroupInfo m_Info;
HPMUniqueEnum m_AddedResources;
HPMUniqueEnum m_RemovedResources;
HPMInt32 m_ClientLocalOperationID;
} HPMChangeCallbackData_ResourceGroupEdited;
Members
m_bChangeInitiatedFromThisSession
Set to 1 if this change in the database was the result of an operation that was initiated from this session.
m_ChangedByResourceID
The unique identifier of the resource that initiated the change.
m_ChangedByImpersonatedResourceID
The unique identifier of the impersonated resource that initiated the change.
m_bSuccess
Success or not.
m_Info
Changed group info. (Valid only if m_bSuccess is true)
m_AddedResources
Real IDs of users that were added to group as the result of the command. (Valid only if m_bSuccess is true)
m_RemovedResources
Real IDs of users that were removed from group as the result of the command. (Valid only if m_bSuccess is true)
m_ClientLocalOperationID
The client local operation ID that caused the EHPMChangeCallbackOperation_ResourceGroupEdited callback.
See Also
EHPMChangeCallbackOperation, HPMChangeCallbackInfo
HPMChangeCallbackData_ResourceGroupDeleted
Callback data type for HPMChangeCallbackInfo::m_pCallbackData when HPMChangeCallbackInfo::m_Operation is set to EHPMChangeCallbackOperation_ResourceGroupDeleted.
struct HPMChangeCallbackData_ResourceGroupDeleted {
HPMInt32 m_bChangeInitiatedFromThisSession;
HPMUniqueID m_ChangedByResourceID;
HPMUniqueID m_ChangedByImpersonatedResourceID;
HPMInt32 m_bSuccess;
HPMInt32 m_GroupID;
HPMUniqueEnum m_Resources;
HPMInt32 m_ClientLocalOperationID;
} HPMChangeCallbackData_ResourceGroupDeleted;
Members
m_bChangeInitiatedFromThisSession
Set to 1 if this change in the database was the result of an operation that was initiated from this session.
m_ChangedByResourceID
The unique identifier of the resource that initiated the change.
m_ChangedByImpersonatedResourceID
The unique identifier of the impersonated resource that initiated the change.
m_bSuccess
Success or not.
m_GroupID
ID of the deleted group.
m_Resources
Real IDs of users that were members of deleted group. (Valid only if m_bSuccess is true)
m_ClientLocalOperationID
The client local operation ID that caused the EHPMChangeCallbackOperation_ResourceGroupDeleted callback.
See Also
EHPMChangeCallbackOperation, HPMChangeCallbackInfo
HPMChangeCallbackData_ProjectResourceGroupAdd
Callback data type for HPMChangeCallbackInfo::m_pCallbackData when HPMChangeCallbackInfo::m_Operation is set to EHPMChangeCallbackOperation_ProjectResourceGroupAdd.
struct HPMChangeCallbackData_ProjectResourceGroupAdd {
HPMInt32 m_bChangeInitiatedFromThisSession;
HPMUniqueID m_ChangedByResourceID;
HPMUniqueID m_ChangedByImpersonatedResourceID;
HPMUniqueID m_ProjectID;
HPMUniqueID m_GroupID;
} HPMChangeCallbackData_ProjectResourceGroupAdd;
Members
m_bChangeInitiatedFromThisSession
Set to 1 if this change in the database was the result of an operation that was initiated from this session.
m_ChangedByResourceID
The unique identifier of the resource that initiated the change.
m_ChangedByImpersonatedResourceID
The unique identifier of the impersonated resource that initiated the change.
m_ProjectID
The unique identifier of the project that a resource was added to.
m_GroupID
The unique identifier of the resource group that was added to the project.
See Also
EHPMChangeCallbackOperation, HPMChangeCallbackInfo
HPMChangeCallbackData_ProjectResourceGroupRemove
Callback data type for HPMChangeCallbackInfo::m_pCallbackData when HPMChangeCallbackInfo::m_Operation is set to EHPMChangeCallbackOperation_ProjectResourceGroupRemove.
struct HPMChangeCallbackData_ProjectResourceGroupRemove {
HPMInt32 m_bChangeInitiatedFromThisSession;
HPMUniqueID m_ChangedByResourceID;
HPMUniqueID m_ChangedByImpersonatedResourceID;
HPMUniqueID m_ProjectID;
HPMUniqueID m_GroupID;
} HPMChangeCallbackData_ProjectResourceGroupRemove;
Members
m_bChangeInitiatedFromThisSession
Set to 1 if this change in the database was the result of an operation that was initiated from this session.
m_ChangedByResourceID
The unique identifier of the resource that initiated the change.
m_ChangedByImpersonatedResourceID
The unique identifier of the impersonated resource that initiated the change.
m_ProjectID
The unique identifier of the project that a resource was removed from.
m_GroupID
The unique identifier of the resource group that was removed from the project.
See Also
EHPMChangeCallbackOperation, HPMChangeCallbackInfo
HPMChangeCallbackData_ResourceAccessTokensChanged
Callback data type for HPMChangeCallbackInfo::m_pCallbackData when HPMChangeCallbackInfo::m_Operation is set to EHPMChangeCallbackOperation_ResourceAccessTokensChanged.
struct HPMChangeCallbackData_ResourceAccessTokensChanged {
HPMInt32 m_bChangeInitiatedFromThisSession;
HPMUniqueID m_ChangedByResourceID;
HPMUniqueID m_ResourceID;
} HPMChangeCallbackData_ResourceAccessTokensChanged;
Members
m_bChangeInitiatedFromThisSession
Set to 1 if this change in the database was the result of an operation that was initiated from this session.
m_ChangedByResourceID
The unique identifier of the resource that initiated the change.
m_ResourceID
The unique identifier of the resource whose access tokens changed.
See Also
EHPMChangeCallbackOperation, HPMChangeCallbackInfo
HPMChangeCallbackData_GlobalSecurityOptionsChanged
Callback data type for HPMChangeCallbackInfo::m_pCallbackData when HPMChangeCallbackInfo::m_Operation is set to EHPMChangeCallbackOperation_GlobalSecurityOptionsChanged.
struct HPMChangeCallbackData_GlobalSecurityOptionsChanged {
HPMInt32 m_bChangeInitiatedFromThisSession;
HPMUniqueID m_ChangedByResourceID;
HPMGlobalSecurityOptions m_Options;
} HPMChangeCallbackData_GlobalSecurityOptionsChanged;
Members
m_bChangeInitiatedFromThisSession
Set to 1 if this change in the database was the result of an operation that was initiated from this session.
m_ChangedByResourceID
The unique identifier of the resource that initiated the change.
m_Options
The option settings
See Also
EHPMChangeCallbackOperation, HPMChangeCallbackInfo
HPMChangeCallbackData_GlobalSecurityPolicyChanged
Callback data type for HPMChangeCallbackInfo::m_pCallbackData when HPMChangeCallbackInfo::m_Operation is set to EHPMChangeCallbackOperation_GlobalSecurityPolicyChanged.
struct HPMChangeCallbackData_GlobalSecurityPolicyChanged {
HPMInt32 m_bChangeInitiatedFromThisSession;
HPMUniqueID m_ChangedByResourceID;
HPMUInt32 m_MinPasswordLength;
HPMUInt32 m_MinPasswordAlpha;
HPMUInt32 m_MinPasswordNumeric;
HPMUInt32 m_MinPasswordNonAlphaNumeric;
HPMUInt32 m_MinPasswordUpperCase;
HPMUInt32 m_MinPasswordLowerCase;
HPMUInt32 m_PasswordExpireDays;
HPMUInt32 m_TokensExpireDays;
HPMUInt32 m_PasswordsInHistory;
HPMInt32 m_bAdminsCanChangePolicy;
} HPMChangeCallbackData_GlobalSecurityPolicyChanged;
Members
m_bChangeInitiatedFromThisSession
Set to 1 if this change in the database was the result of an operation that was initiated from this session.
m_ChangedByResourceID
The unique identifier of the resource that initiated the change.
m_MinPasswordLength
Minimum password length
m_MinPasswordAlpha
Minimum number of alphabetic characters in passwords
m_MinPasswordNumeric
Minimum number of numeric characters in passwords
m_MinPasswordNonAlphaNumeric
Minimum number of symbol characters in passwords
m_MinPasswordUpperCase
Minimum number of upper case characters in passwords
m_MinPasswordLowerCase
Minimum number of lower case characters in passwords
m_PasswordExpireDays
Number of days until passwords expire
m_TokensExpireDays
Number of days until tokens expire
m_PasswordsInHistory
Number of passwords to save in history
m_bAdminsCanChangePolicy
Set to 1 of users with administration rights can change security policy
See Also
EHPMChangeCallbackOperation, HPMChangeCallbackInfo
HPMChangeCallback
Definition of the callback function called when something in the database changes.
HPMInt32 HPMChangeCallback (
    const HPMChangeCallbackInfo * _pCallback
    );
Parameters
_pCallback
[in] Information about the callback
Return Value
The return value should be different depending on the callback operation. See the documentation for the different callback data structures for information. If you don't handle the callback you should return 1.
See Also
RegisterChangeCallback
Registers a database change callback.
HPMError RegisterChangeCallback (
    void * _pSession,
    HPMChangeCallback _pCallback,
    void * _pContext
    );
Parameters
_pSession
[in] A connected session. See SessionOpen.
_pCallback
[in] The callback to call when something changes in the database.
_pContext
[in] The user context sent to HPMChangeCallbackInfo::m_pContext when the callback is called.
Return Value
Returns an error code. See EHPMError.
Comments
A callback is uniquely identified by the callback function and user context, thus you cannot specify the same callback and user context or the function will fail and EHPMError_CallbackAlreadyExists will be returned. The callback is called from the SessionProcess function. Before closing the session you must make sure to call UnregisterChangeCallback for all callbacks.
See Also
HPMSdkFunctions, UnregisterChangeCallback, HPMChangeCallbackInfo
UnregisterChangeCallback
Unregisters a database change callback
HPMError UnregisterChangeCallback (
    void * _pSession,
    HPMChangeCallback _pCallback,
    void * _pContext
    );
Parameters
_pSession
[in] A connected session. See SessionOpen.
_pCallback
[in] The callback specified to RegisterChangeCallback.
_pContext
[in] The user context specified to RegisterChangeCallback.
Return Value
Returns an error code. See EHPMError.
See Also
HPMSdkFunctions, RegisterChangeCallback
EHPMBoardElementType
Type used for TaskBoardElementGetType
enum EHPMBoardElementType {
EHPMBoardElementType_NewVersionOfSDKRequired = 0,
EHPMBoardElementType_Lane = 1,
EHPMBoardElementType_Column = 2,
};
Values
EHPMBoardElementType_NewVersionOfSDKRequired
The type did not exist when this SDK was created. Upgrade to a newer version of the SDK to be able to use this format.
EHPMBoardElementType_Lane
Board element type lane
EHPMBoardElementType_Column
Board element type column
See Also
EHPMBoardCardFlag
Board card flags used for HPMBoardCardFlagsPair::m_Flags
enum EHPMBoardCardFlag {
EHPMBoardCardFlag_None = 0,
EHPMBoardCardFlag_Hidden = 1,
};
Values
EHPMBoardCardFlag_None
No flags are set
EHPMBoardCardFlag_Hidden
The card is hidden
See Also
EHPMBoardElementField
Board element field identifier used in HPMChangeCallbackData_BoardElementSettingsChanged}::m_FieldID and HPMProjectDetailedAccessRuleFunction::m_FunctionID.
enum EHPMBoardElementField {
EHPMBoardElementField_NewVersionOfSDKRequired = 0,
EHPMBoardElementField_CardsLimit = 1,
};
Values
EHPMBoardElementField_NewVersionOfSDKRequired
TBD
EHPMBoardElementField_CardsLimit
TBD
Comments
The board element fields
See Also
HPMChangeCallbackData_BoardElementSettingsChanged,
HPMBoardElementDefinitionEnum
List of board element pairs.
struct HPMBoardElementDefinitionEnum {
HPMUInt32 m_nElements;
HPMBoardElementDefinition const * m_pElements;
} HPMBoardElementDefinitionEnum;
Members
m_nElements
Number of elements.
m_pElements
List of elements.
See Also
HPMBoardElementDefinition, HPMBoardConfiguration |
HPMBoardElementDefinitionEnumWithParent
Element enum with parent element ID. Needed to represent board columns inside board lane
struct HPMBoardElementDefinitionEnumWithParent {
HPMUniqueID m_ParentID;
HPMBoardElementDefinitionEnum m_Enum;
} HPMBoardElementDefinitionEnumWithParent;
Members
m_ParentID
Parent ID. Makes sense only for board columns. Must be specified during board creation
m_Enum
List of elements
See Also
HPMBoardElementDefinition, HPMBoardConfiguration HPMBoardElementDefinitionEnum
HPMBoardElementDefinitionEnumWithParentEnum
List of HPMBoardElementDefinitionEnumWithParent elements. Represents all columns in the board with their parent lane IDs.
struct HPMBoardElementDefinitionEnumWithParentEnum {
HPMUInt32 m_nEnums;
HPMBoardElementDefinitionEnumWithParent const * m_pEnums;
} HPMBoardElementDefinitionEnumWithParentEnum;
Members
m_nEnums
Number of lists.
m_pEnums
List of lists.
See Also
HPMBoardElementDefinition, HPMBoardConfiguration HPMBoardElementDefinitionEnum, HPMBoardElementDefinitionEnumWithParent
HPMTaskBoardColumnStatusPair
Board membership info.
struct HPMTaskBoardColumnStatusPair {
HPMUniqueID m_ColumnID;
HPMUInt32 m_Status;
} HPMTaskBoardColumnStatusPair;
Members
m_ColumnID
Board Column ID
m_Status
Status mapped to column
See Also
HPMTaskBoardColumnStatusMapping
HPMTaskBoardColumnStatusMapping
Board membership info.
struct HPMTaskBoardColumnStatusMapping {
HPMUInt32 m_nPairs;
HPMTaskBoardColumnStatusPair const * m_pPairs;
} HPMTaskBoardColumnStatusMapping;
Members
m_nPairs
Number of pairs.
m_pPairs
List of pairs.
See Also
HPMTaskBoardColumnStatusPair, HPMBoardConfiguration , TaskBoardGetColumnToStatusMapping
HPMBoardConfiguration
Board configuration.
struct HPMBoardConfiguration {
HPMBoardElementDefinitionEnum m_Lanes;
HPMBoardElementDefinitionEnumWithParentEnum m_Columns;
HPMUInt32 m_nCardAttributeColumns;
const HPMColumn * m_pCardAttributeColumns;
HPMTaskBoardColumnStatusMapping m_ColumnToStatusMap;
} HPMBoardConfiguration;
Members
m_Lanes
List of lanes this board will have. See HPMBoardElementDefinitionEnum.
m_Columns
List of columns this board will have. See HPMBoardElementDefinitionEnumWithParentEnum.
m_nCardAttributeColumns
Number of columns visible on cards on this board.
m_pCardAttributeColumns
List of columns that this board will show on the cards. See HPMColumn.
m_ColumnToStatusMap
List of pairs of column and status mapped to that column. See HPMTaskBoardColumnStatusMapping.
See Also
HPMTaskBoardMembershipInfo
Board membership info.
struct HPMTaskBoardMembershipInfo {
HPMUniqueID m_LaneID;
HPMUniqueID m_ColumnID;
HPMFP64 m_Position;
HPMInt32 m_bHidden;
} HPMTaskBoardMembershipInfo;
Members
m_LaneID
Lane that contains a task
m_ColumnID
Column that contains a task
m_Position
Position of Task in board
m_bHidden
True if task is hidden on board
See Also
TaskBoardConvertSprintToBoard
Converts board to sprint.
HPMError TaskBoardConvertSprintToBoard (
    void * _pSession,
    HPMUniqueID _TaskID,
    HPMInt32 _bUseNonDefaultBoardConfiguration,
    HPMBoardConfiguration const * _pOptionalBoardConfiguration,
    HPMChangeCallbackData_SprintConvertedToBoard const * * _pReturn
    );
Parameters
_pSession
[in] A connected session. See SessionOpen.
_TaskID
[in] Sprint Task ID.
_bUseNonDefaultBoardConfiguration
[in] If you create board and want to create it with non default configuration set this to true and specify _pOptionalBoardConfiguration.
_pOptionalBoardConfiguration
[in] Optional board configuration.
_pReturn
[out] Pointer to a pointer of a HPMChangeCallbackData_SprintConvertedToBoard object, representing the returned data. If this parameter is not NULL, the function will block.
Return Value
Returns an error code. See EHPMError.
See Also
HPMSdkFunctions, HPMBoardConfiguration
TaskGetSprintIsBoard
Checks whether sprint is converted to board.
HPMError TaskGetSprintIsBoard (
    void * _pSession,
    HPMUniqueID _TaskID,
    HPMInt32 * _pbResult
    );
Parameters
_pSession
[in] A connected session. See SessionOpen.
_TaskID
[in] Sprint Task ID.
_pbResult
[out] Pointer to result.
Return Value
Returns an error code. See EHPMError.
See Also
TaskBoardElementGetType
Gets board element type.
HPMError TaskBoardElementGetType (
    void * _pSession,
    HPMUniqueID _ElementID,
    HPMInt32 * _pData
    );
Parameters
_pSession
[in] A connected session. See SessionOpen.
_ElementID
[in] Element ID.
_pData
[out] Pointer to a variable that will receive the type. Will be one of EHPMBoardElementType.
Return Value
Returns an error code. See EHPMError.
See Also
TaskBoardColumnGetParentLane
Gets parent lane for board column.
HPMError TaskBoardColumnGetParentLane (
    void * _pSession,
    HPMUniqueID _ColumnID,
    HPMUniqueID * _pLaneID
    );
Parameters
_pSession
[in] A connected session. See SessionOpen.
_ColumnID
[in] Column ID.
_pLaneID
[out] Pointer to the Lane ID.
Return Value
Returns an error code. See EHPMError.
See Also
TaskBoardElementGetPosition
Gets position of element. Position in board for lanes, and position in parent lane for column.
HPMError TaskBoardElementGetPosition (
    void * _pSession,
    HPMUniqueID _ColumnID,
    HPMFP64 * _pPosition
    );
Parameters
_pSession
[in] A connected session. See SessionOpen.
_ColumnID
[in] Column ID.
_pPosition
[out] Pointer to the position.
Return Value
Returns an error code. See EHPMError.
See Also
TaskBoardGetCardAttributeColumns
Gets the list of card attribute columns for the board.
HPMError TaskBoardGetCardAttributeColumns (
    void * _pSession,
    HPMUniqueID _TaskID,
    HPMColumnList const * * _pResult
    );
Parameters
_pSession
[in] A connected session. See SessionOpen.
_TaskID
[in] The unique identifier of the task to get the list of card attribute columns for.
_pResult
[out] The columns. See HPMResourceDefinitionList.
Return Value
Returns an error code. See EHPMError.
Comments
The returned object must be freed with ObjectFree or a memory leak will result.
See Also
HPMSdkFunctions, HPMColumnList
TaskBoardGetColumnToStatusMapping
Gets the list of pair of column and it's mapped status.
HPMError TaskBoardGetColumnToStatusMapping (
    void * _pSession,
    HPMUniqueID _TaskID,
    HPMTaskBoardColumnStatusMapping const * * _pResult
    );
Parameters
_pSession
[in] A connected session. See SessionOpen.
_TaskID
[in] The unique identifier of the board task to get the list of card attribute columns for.
_pResult
[out] The columns. See HPMResourceDefinitionList.
Return Value
Returns an error code. See EHPMError.
Comments
The returned object must be freed with ObjectFree or a memory leak will result.
See Also
HPMSdkFunctions, HPMTaskBoardColumnStatusMapping
TaskBoardLaneEnum
Enumerates lane IDs on a board.
HPMError TaskBoardLaneEnum (
    void * _pSession,
    HPMUniqueID _BoardID,
    HPMUniqueEnum const * * _pEnum
    );
Parameters
_pSession
[in] A connected session. See SessionOpen.
_BoardID
[in] The unique identifier of the board to get the lane IDs for.
_pEnum
[out] Pointer to a pointer of a HPMUniqueEnum object, representing the returned lane IDs.
Return Value
Returns an error code. See EHPMError.
Comments
The returned object must be freed with ObjectFree or a memory leak will result.
See Also
HPMSdkFunctions, ObjectFree, HPMUniqueEnum
TaskBoardLaneColumnEnum
Enumerates lane IDs in parent lane.
HPMError TaskBoardLaneColumnEnum (
    void * _pSession,
    HPMUniqueID _ParentLaneID,
    HPMUniqueEnum const * * _pEnum
    );
Parameters
_pSession
[in] A connected session. See SessionOpen.
_ParentLaneID
[in] The parent lane id to enumerate columns in.
_pEnum
[out] Pointer to a pointer of a HPMUniqueEnum object, representing the returned column IDs.
Return Value
Returns an error code. See EHPMError.
Comments
The returned object must be freed with ObjectFree or a memory leak will result.
See Also
HPMSdkFunctions, ObjectFree, HPMUniqueEnum
TaskBoardElementGetBoard
Gets ID of the board in which element exist
HPMError TaskBoardElementGetBoard (
    void * _pSession,
    HPMUniqueID _ElementID,
    HPMUniqueID * _pBoardID
    );
Parameters
_pSession
[in] A connected session. See SessionOpen.
_ElementID
[in] Element ID.
_pBoardID
[out] The returned board id.
Return Value
Returns an error code. See EHPMError.
Comments
The returned object must be freed with ObjectFree or a memory leak will result.
See Also
TaskBoardElementGetName
Gets board element name.
HPMError TaskBoardElementGetName (
    void * _pSession,
    HPMUniqueID _ElementID,
    HPMString const * * _pData
    );
Parameters
_pSession
[in] A connected session. See SessionOpen.
_ElementID
[in] Element ID.
_pData
[out] The returned element name.
Return Value
Returns an error code. See EHPMError.
Comments
The returned object must be freed with ObjectFree or a memory leak will result.
See Also
TaskBoardUpdateAttributes
Updates board's attributes
HPMError TaskBoardUpdateAttributes (
    void * _pSession,
    HPMUniqueID _BoardID,
    HPMColumnList const * _pCardAttributes,
    HPMInt32 _LocalOperationID,
    HPMChangeCallbackData_BoardAttributesChanged const * * _pReturn
    );
Parameters
_pSession
[in] A connected session. See SessionOpen.
_BoardID
[in] The unique id of the board.
_pCardAttributes
[in] Board's card attribute columns.
_LocalOperationID
[in] Local operation ID to identify the callback from the server. See HPMChangeCallbackData_BoardAttributesChanged.
_pReturn
[out] Pointer to a pointer of a HPMChangeCallbackData_BoardAttributesChanged object, representing the returned data. If this parameter is not NULL, the function will block.
Return Value
Returns an error code. See EHPMError.
See Also
HPMSdkFunctions, HPMColumnList
TaskBoardMapColumnToStatus
Maps board's column to new status
HPMError TaskBoardMapColumnToStatus (
    void * _pSession,
    HPMUniqueID _BoardID,
    HPMUniqueID _ColumnID,
    HPMInt32 _Status,
    HPMInt32 _LocalOperationID,
    HPMChangeCallbackData_ColumnStatusMappingChanged const * * _pReturn
    );
Parameters
_pSession
[in] A connected session. See SessionOpen.
_BoardID
[in] The unique id of the board.
_ColumnID
[in] The unique ID of column.
_Status
[in] Status to map column to.
_LocalOperationID
[in] Local operation ID to identify the callback from the server. See HPMChangeCallbackData_BoardAttributesChanged.
_pReturn
[out] Pointer to a pointer of a HPMChangeCallbackData_ColumnStatusMappingChanged object, representing the returned data. If this parameter is not NULL, the function will block.
Return Value
Returns an error code. See EHPMError.
See Also
HPMSdkFunctions, EHPMTaskStatus
TaskBoardCreateLane
Creates lane in board.
HPMError TaskBoardCreateLane (
    void * _pSession,
    HPMUniqueID _BoardID,
    HPMBoardElementDefinition const * _pElementDefinition,
    HPMInt32 _LocalOperationID,
    HPMChangeCallbackData_BoardElementUpdated const * * _pReturn
    );
Parameters
_pSession
[in] A connected session. See SessionOpen.
_BoardID
[in] The unique id of the board.
_pElementDefinition
[in] Lane definition.
_LocalOperationID
[in] Local operation ID to identify the callback from the server. See HPMChangeCallbackData_BoardElementUpdated.
_pReturn
[out] Pointer to a pointer of a HPMChangeCallbackData_BoardElementUpdated object, representing the returned data. If this parameter is not NULL, the function will block.
Return Value
Returns an error code. See EHPMError.
See Also
HPMSdkFunctions, HPMBoardElementDefinition
TaskBoardCreateColumn
Creates column in parent lane in board.
HPMError TaskBoardCreateColumn (
    void * _pSession,
    HPMUniqueID _BoardID,
    HPMBoardElementDefinition const * _pElementDefinition,
    HPMInt32 _LocalOperationID,
    HPMUniqueID _ParentLaneID,
    HPMChangeCallbackData_BoardElementUpdated const * * _pReturn
    );
Parameters
_pSession
[in] A connected session. See SessionOpen.
_BoardID
[in] The unique id of the board.
_pElementDefinition
[in] Column definition.
_LocalOperationID
[in] Local operation ID to identify the callback from the server. See HPMChangeCallbackData_BoardElementUpdated.
_ParentLaneID
[in] Id of a lane to create column in.
_pReturn
[out] Pointer to a pointer of a HPMChangeCallbackData_BoardElementUpdated object, representing the returned data. If this parameter is not NULL, the function will block.
Return Value
Returns an error code. See EHPMError.
See Also
HPMSdkFunctions, HPMBoardElementDefinition
TaskBoardUpdateElement
Updates element in board.
HPMError TaskBoardUpdateElement (
    void * _pSession,
    HPMUniqueID _BoardID,
    HPMBoardElementDefinition const * _pElementDefinition,
    HPMInt32 _LocalOperationID,
    HPMChangeCallbackData_BoardElementUpdated const * * _pReturn
    );
Parameters
_pSession
[in] A connected session. See SessionOpen.
_BoardID
[in] The unique id of the board.
_pElementDefinition
[in] Element definition.
_LocalOperationID
[in] Local operation ID to identify the callback from the server. See HPMChangeCallbackData_BoardElementUpdated.
_pReturn
[out] Pointer to a pointer of a HPMChangeCallbackData_BoardElementUpdated object, representing the returned data. If this parameter is not NULL, the function will block.
Return Value
Returns an error code. See EHPMError.
See Also
HPMSdkFunctions, HPMBoardElementDefinition
TaskBoardDeleteElement
Deletes element from board.
HPMError TaskBoardDeleteElement (
    void * _pSession,
    HPMUniqueID _BoardID,
    HPMUniqueID _ElementID,
    HPMUniqueID _LocalElementID,
    HPMInt32 _LocalOperationID,
    HPMChangeCallbackData_BoardElementDeleted const * * _pReturn
    );
Parameters
_pSession
[in] A connected session. See SessionOpen.
_BoardID
[in] The unique id of the board.
_ElementID
[in] The unique id of the element to delete in board
_LocalElementID
[in] Optional local element id.
_LocalOperationID
[in] Local operation ID to identify the callback from the server. See HPMChangeCallbackData_BoardElementDeleted.
_pReturn
[out] Pointer to a pointer of a HPMChangeCallbackData_BoardElementDeleted object, representing the returned data. If this parameter is not NULL, the function will block.
Return Value
Returns an error code. See EHPMError.
See Also
TaskBoardGetMembershipInfo
Get membership info for task that exists on board.
HPMError TaskBoardGetMembershipInfo (
    void * _pSession,
    HPMUniqueID _TaskID,
    HPMTaskBoardMembershipInfo const * * _pResult
    );
Parameters
_pSession
[in] A connected session. See SessionOpen.
_TaskID
[in] The unique identifier of the task to get info for
_pResult
[out] Pointer to a pointer of a HPMTaskBoardMembershipInfo object, representing the returned data.
Return Value
Returns an error code. See EHPMError.
Comments
The returned object must be freed with ObjectFree or a memory leak will result.
See Also
HPMSdkFunctions, HPMTaskBoardMembershipInfo
TaskBoardMove
Moves cards to a new position on a board.
HPMError TaskBoardMove (
    void * _pSession,
    HPMUniqueID _BoardID,
    HPMUniqueID _CardColumnID,
    HPMBoardCardPositionPairEnum const * _pTasks,
    HPMInt32 _LocalOperationID,
    HPMChangeCallbackData_BoardCardMove const * * _pReturn
    );
Parameters
_pSession
[in] A connected session. See SessionOpen.
_BoardID
[in] The unique id of the board where the element will be moved.
_CardColumnID
[in] Column ID.
_pTasks
[in] The list of task positions.
_LocalOperationID
[in] Local operation ID to identify the callback from the server. See HPMChangeCallbackData_BoardCardMove.
_pReturn
[out] Pointer to a pointer of a HPMChangeCallbackData_BoardCardMove object, representing the returned data. If this parameter is not NULL, the function will block.
Return Value
Returns an error code. See EHPMError.
See Also
HPMSdkFunctions, HPMBoardCardPositionPairEnum, HPMChangeCallbackData_BoardCardMove
TaskBoardHide
Hides cards on a board.
HPMError TaskBoardHide (
    void * _pSession,
    HPMUniqueID _BoardID,
    HPMUniqueEnum const * _pTaskIDs,
    HPMInt32 _LocalOperationID,
    HPMChangeCallbackData_BoardCardHide const * * _pReturn
    );
Parameters
_pSession
[in] A connected session. See SessionOpen.
_BoardID
[in] The unique id of the board where the tasks will be hidden.
_pTaskIDs
[in] The list of task ids to hide.
_LocalOperationID
[in] Local operation ID to identify the callback from the server. See HPMChangeCallbackData_BoardCardHide.
_pReturn
[out] Pointer to a pointer of a HPMChangeCallbackData_BoardCardHide object, representing the returned data. If this parameter is not NULL, the function will block.
Return Value
Returns an error code. See EHPMError.
See Also
HPMSdkFunctions, HPMUniqueEnum
TaskBoardUnhide
Unhides cards on a board ands moves them to the end of their cells.
HPMError TaskBoardUnhide (
    void * _pSession,
    HPMUniqueID _BoardID,
    HPMUniqueEnum const * _pTaskIDs,
    HPMInt32 _LocalOperationID,
    HPMChangeCallbackData_BoardCardMove const * * _pReturn
    );
Parameters
_pSession
[in] A connected session. See SessionOpen.
_BoardID
[in] The unique id of the board where the tasks will be unhidden.
_pTaskIDs
[in] The list of task ids to unhide.
_LocalOperationID
[in] Local operation ID to identify the callback from the server. See HPMChangeCallbackData_BoardCardMove.
_pReturn
[out] Pointer to a pointer of a HPMChangeCallbackData_BoardCardMove object, representing the returned data. If this parameter is not NULL, the function will block.
Return Value
Returns an error code. See EHPMError.
See Also
HPMSdkFunctions, HPMUniqueEnum
TaskBoardElementGetCardLimit
Updates card limit for element in a board.
HPMError TaskBoardElementGetCardLimit (
    void * _pSession,
    HPMUniqueID _ElementID,
    HPMInt32 * _pLimit
    );
Parameters
_pSession
[in] A connected session. See SessionOpen.
_ElementID
[in] Element ID to get card limit for.
_pLimit
[out] The returned card's limit.
Return Value
Returns an error code. See EHPMError.
See Also
HPMSdkFunctions, TaskBoardElementSetCardLimit
TaskBoardElementSetCardLimit
Updates card limit for element in a board.
HPMError TaskBoardElementSetCardLimit (
    void * _pSession,
    HPMUniqueID _BoardID,
    HPMUniqueID _ElementID,
    HPMInt32 _Limit,
    HPMInt32 _LocalOperationID,
    HPMChangeCallbackData_BoardElementSettingsChanged const * * _pReturn
    );
Parameters
_pSession
[in] A connected session. See SessionOpen.
_BoardID
[in] The unique id of the board where the tasks will be unhidden.
_ElementID
[in] Element ID.
_Limit
[in] New limit
_LocalOperationID
[in] Local operation ID to identify the callback from the server. See HPMChangeCallbackData_BoardCardMove.
_pReturn
[out] Pointer to a pointer of a HPMChangeCallbackData_BoardElementSettingsChanged object, representing the returned data. If this parameter is not NULL, the function will block.
Return Value
Returns an error code. See EHPMError.
See Also
HPMSdkFunctions, TaskBoardElementGetCardLimit
EHPMResourceFlag
Flags to specify for HPMResourceProperties::m_Flags
enum EHPMResourceFlag {
EHPMResourceFlag_None = 0,
EHPMResourceFlag_ActiveAccount = 1,
EHPMResourceFlag_AdminAccess = 2,
EHPMResourceFlag_ResourceAllocationAccess = 4,
EHPMResourceFlag_DocumentManagementAccess = 8,
EHPMResourceFlag_AuthenticationProvider = 16,
EHPMResourceFlag_CredentialCheckProvider = 32,
EHPMResourceFlag_AvatarManagementAccess = 64,
EHPMResourceFlag_SdkChatUser = 128,
EHPMResourceFlag_ChatAccess = 256,
EHPMResourceFlag_DashboardAccess = 512,
EHPMResourceFlag_DashboardCanSharePages = 1024,
};
Values
EHPMResourceFlag_None
TBD
EHPMResourceFlag_ActiveAccount
The resource account is active. When the account is active the resource can log on to the server, when inactive the resource can not log in.
EHPMResourceFlag_AdminAccess
The resource has administrative access and is able to manage resources and projects in the database.
EHPMResourceFlag_ResourceAllocationAccess
The resource has access to resource allocation pane in client.
EHPMResourceFlag_DocumentManagementAccess
The resource has access to document management pane in client.
EHPMResourceFlag_AuthenticationProvider
For SDK users only: the resource is allowed to provide custom authentication services. The SDK is not allowed to set this flag.
EHPMResourceFlag_CredentialCheckProvider
For SDK users only: the resource is allowed to provide credential check services. The SDK is not allowed to set this flag.
EHPMResourceFlag_AvatarManagementAccess
The resource is able to manage resource avatars
EHPMResourceFlag_SdkChatUser
For SDK users only: the SDK user will be available for chat.
EHPMResourceFlag_ChatAccess
The resource has access to chat.
EHPMResourceFlag_DashboardAccess
The resource has access to dashboards.
EHPMResourceFlag_DashboardCanSharePages
The resource can share dashboard pages to other users
See Also
EHPMResourcePasswordFlag
Flags to specify for HPMResourceProperties::m_PasswordFlags
enum EHPMResourcePasswordFlag {
EHPMResourcePasswordFlag_None = 0,
EHPMResourcePasswordFlag_MustChangePasswordNextLogon = 1,
EHPMResourcePasswordFlag_PasswordNeverExpires = 2,
EHPMResourcePasswordFlag_CannotChangePassword = 4,
EHPMResourcePasswordFlag_PasswordDisabled = 8,
};
Values
EHPMResourcePasswordFlag_None
TBD
EHPMResourcePasswordFlag_MustChangePasswordNextLogon
The resource must change the password next login. If this flag is specified together with EHPMResourcePasswordFlag_CannotChangePassword the resource will not be asked to change password next login.
EHPMResourcePasswordFlag_PasswordNeverExpires
The resources password never expires.
EHPMResourcePasswordFlag_CannotChangePassword
The resource cannot change its password.
EHPMResourcePasswordFlag_PasswordDisabled
The resource cannot log in using the built-in Helix Plan authentication protocol.
See Also
EHPMResourceType
Resource type for HPMResourceProperties::m_ResourceType
enum EHPMResourceType {
EHPMResourceType_NewVersionOfSDKRequired = 0,
EHPMResourceType_Normal = 1,
EHPMResourceType_Ghost = 2,
EHPMResourceType_SDK = 3,
EHPMResourceType_QAAccount = 4,
};
Values
EHPMResourceType_NewVersionOfSDKRequired
The resource type did not exist when this SDK was created. Upgrade to a newer version of the SDK to be able to use this type.
EHPMResourceType_Normal
This resource is a normal resource.
EHPMResourceType_Ghost
This resource is a ghost resource. Ghost resources are not full members of the project and you cannot log in to this account. This resource does not consume a license.
EHPMResourceType_SDK
This is a SDK resource. This resource can only be used by an SDK connecting to the server and cannot be logged in to from the client. This is the only type of resource that an SDK can log in with.
EHPMResourceType_QAAccount
This is a QA resource. This resource can only be used to report and manage bugs. No my work view or project management is available for this user. This resource does not consume a license.
See Also
EHPMSDKSyncMethod
Flags to specify for HPMResourceProperties::m_SDKSyncMethod
enum EHPMSDKSyncMethod {
EHPMSDKSyncMethod_NewVersionOfSDKRequired = 0,
EHPMSDKSyncMethod_AllMemberProjects = 1,
EHPMSDKSyncMethod_AllProjects = 2,
};
Values
EHPMSDKSyncMethod_NewVersionOfSDKRequired
The resource type did not exist when this SDK was created. Upgrade to a newer version of the SDK to be able to use this type.
EHPMSDKSyncMethod_AllMemberProjects
SDK session only syncs only projects that this SDK resource is a member of.
EHPMSDKSyncMethod_AllProjects
SDK session only syncs all projects.
See Also
EHPMResourceGlobalSettingsFlag
Flags to specify for HPMResourceGlobalSettings::m_Flags
enum EHPMResourceGlobalSettingsFlag {
EHPMResourceGlobalSettingsFlag_None = 0,
EHPMResourceGlobalSettingsFlag_CopyMiscOnTaskInsert = 1,
EHPMResourceGlobalSettingsFlag_UnlockByDefault = 2,
EHPMResourceGlobalSettingsFlag_ShowMilestoneLinksOnTasks = 4,
EHPMResourceGlobalSettingsFlag_InstantlyEditCreatedTasks = 8,
EHPMResourceGlobalSettingsFlag_CommentIndicator = 16,
EHPMResourceGlobalSettingsFlag_EnterDateManually = 32,
EHPMResourceGlobalSettingsFlag_CopyPasteTaskData = 64,
EHPMResourceGlobalSettingsFlag_ActivityNumberLeftmostColumn = 128,
EHPMResourceGlobalSettingsFlag_ShowPreSucActivityNumbers = 256,
EHPMResourceGlobalSettingsFlag_DontTranslateEstimatedIdealDaysToWorkRemaining = 512,
EHPMResourceGlobalSettingsFlag_HideCompletedTasksInProjectView = 1024,
EHPMResourceGlobalSettingsFlag_HideTasksNotAssignedToMeInProjectView = 2048,
EHPMResourceGlobalSettingsFlag_NoFindAutocompletion = 4096,
EHPMResourceGlobalSettingsFlag_HideSubProjectCompletePercent = 8192,
EHPMResourceGlobalSettingsFlag_DoNotAutoPreviewFiles = 16384,
EHPMResourceGlobalSettingsFlag_MagnifyItemsInTheWallView = 32768,
EHPMResourceGlobalSettingsFlag_SymbolicFindOperators = 65536,
EHPMResourceGlobalSettingsFlag_RightAlignItemText = 131072,
EHPMResourceGlobalSettingsFlag_ShowPastSprintsMilestonesInDropdown = 262144,
EHPMResourceGlobalSettingsFlag_HighlightTasksOnCriticalPathFlags = 524288,
EHPMResourceGlobalSettingsFlag_Theme = 1048576,
EHPMResourceGlobalSettingsFlag_ShowLinebreaksInList = 2097152,
EHPMResourceGlobalSettingsFlag_ShowStatusUpdatesInComments = 4194304,
EHPMResourceGlobalSettingsFlag_EnableAutoSearch = 8388608,
EHPMResourceGlobalSettingsFlag_EnableWatchOnItemCreation = 16777216,
EHPMResourceGlobalSettingsFlag_EnableWatchOnCommentOnItem = 33554432,
EHPMResourceGlobalSettingsFlag_AddToWatchWhenAssigned = 67108864,
};
Values
EHPMResourceGlobalSettingsFlag_None
TBD
EHPMResourceGlobalSettingsFlag_CopyMiscOnTaskInsert
When the resource inserts a task, duration and budgeted work should be inherited from the previously selected activity.
EHPMResourceGlobalSettingsFlag_UnlockByDefault
When a new task is created by the resource it should be unlocked.
EHPMResourceGlobalSettingsFlag_ShowMilestoneLinksOnTasks
Links should be shown between milestones and items in the timeline view.
EHPMResourceGlobalSettingsFlag_InstantlyEditCreatedTasks
When a new task is created name edit mode should be activated.
EHPMResourceGlobalSettingsFlag_CommentIndicator
Show an icon beside tasks when they contain a comment.
EHPMResourceGlobalSettingsFlag_EnterDateManually
Allow the resource to enter dates manually instead of showing the date selection dialog.
EHPMResourceGlobalSettingsFlag_CopyPasteTaskData
Extra data such as comments, extra columns and delegation should be copied in copy/past operations.
EHPMResourceGlobalSettingsFlag_ActivityNumberLeftmostColumn
Show the activity number in the leftmost column in gantt.
EHPMResourceGlobalSettingsFlag_ShowPreSucActivityNumbers
Show predecessor and successor columns.
EHPMResourceGlobalSettingsFlag_DontTranslateEstimatedIdealDaysToWorkRemaining
Don't translate estimated ideal days to remaining work when moving a task from the backlog to a sprint.
EHPMResourceGlobalSettingsFlag_HideCompletedTasksInProjectView
Hide completed tasks in the project planning view.
EHPMResourceGlobalSettingsFlag_HideTasksNotAssignedToMeInProjectView
Hide tasks that are not assigned to the resource in the project planning view.
EHPMResourceGlobalSettingsFlag_NoFindAutocompletion
Don't show auto completion in 'Find' and 'Find all'.
EHPMResourceGlobalSettingsFlag_HideSubProjectCompletePercent
Hide sub-project completion percentage.
EHPMResourceGlobalSettingsFlag_DoNotAutoPreviewFiles
Attachments shouldn't be autopreviewed.
EHPMResourceGlobalSettingsFlag_MagnifyItemsInTheWallView
Magnify items in the wall view when mouse is over them.
EHPMResourceGlobalSettingsFlag_SymbolicFindOperators
Operators generated in report editor is symbolic rather than textual. & as apposed to "AND".
EHPMResourceGlobalSettingsFlag_RightAlignItemText
Right align item name/description text.
EHPMResourceGlobalSettingsFlag_ShowPastSprintsMilestonesInDropdown
Show past sprints/iterations and milestones/releases in drop down selections.
EHPMResourceGlobalSettingsFlag_HighlightTasksOnCriticalPathFlags
Highlight tasks on critical path.
EHPMResourceGlobalSettingsFlag_Theme
Theme of the application.
EHPMResourceGlobalSettingsFlag_ShowLinebreaksInList
Shows linebreaks for user stories / comments in gantt.
EHPMResourceGlobalSettingsFlag_ShowStatusUpdatesInComments
Shows status updates for user stories / comments in gantt.
EHPMResourceGlobalSettingsFlag_EnableAutoSearch
Enable auto search in 'Find' and 'Find all'.
EHPMResourceGlobalSettingsFlag_EnableWatchOnItemCreation
Automatically add to watch list when a new task is created.
EHPMResourceGlobalSettingsFlag_EnableWatchOnCommentOnItem
Automatically add to watch list when a task is commented.
EHPMResourceGlobalSettingsFlag_AddToWatchWhenAssigned
Automatically add user to watch list when the user is assigned to a task.
See Also
EHPMResourceLockFlag
Resource lock flags.
enum EHPMResourceLockFlag {
EHPMResourceLockFlag_None = 0,
EHPMResourceLockFlag_Deleted = 1,
EHPMResourceLockFlag_Locked = 2,
};
Values
EHPMResourceLockFlag_None
TBD
EHPMResourceLockFlag_Deleted
Resource has been deleted.
EHPMResourceLockFlag_Locked
Resource has been locked.
See Also
ResourceGetLockFlags, ResourceChangeLockFlags
EHPMResourceGroupFlag
Flags to specify for HPMResourceGroupProperties::m_Flags
enum EHPMResourceGroupFlag {
EHPMResourceGroupFlag_None = 0,
EHPMResourceGroupFlag_ChatVisibleInNewsFeed = 1,
};
Values
EHPMResourceGroupFlag_None
TBD
EHPMResourceGroupFlag_ChatVisibleInNewsFeed
Chat messages to the resource group will show up in news feed
See Also
HPMResourceEnum
Used for enumerating resources in a database.
struct HPMResourceEnum {
HPMUInt32 m_nResources;
const HPMUniqueID * m_pResources;
} HPMResourceEnum;
Members
m_nResources
The number of resources in the array.
m_pResources
Pointer to a list unique database identifiers of resources.
See Also
HPMResourceProperties
Used for specifying properties of a resource.
struct HPMResourceProperties {
const HPMChar * m_pName;
const HPMChar * m_pSortName;
const HPMChar * m_pTitle;
const HPMChar * m_pEmailAddress;
HPMUInt32 m_Flags;
HPMUInt32 m_ResourceType;
HPMUInt32 m_SDKSyncMethod;
HPMUInt32 m_PasswordFlags;
HPMUniqueID m_RemoteID;
HPMUniqueID m_ParentSDKID;
const HPMChar * m_pRemoteGUID;
HPMUInt32 m_nMemberOfResourceGroups;
const HPMUniqueID * m_pMemberOfResourceGroups;
} HPMResourceProperties;
Members
m_pName
The name of the resource.
m_pSortName
If set this name is used for sorting instead of the user name.
m_pTitle
The title of the resource.
m_pEmailAddress
The email address of the resource.
m_Flags
Resource flags. Can be any combination of EHPMResourceFlag.
m_ResourceType
Resource type. Can be one of EHPMResourceType.
m_SDKSyncMethod
If the resource m_ResourceType is EHPMResourceType_SDK this decides how the SDK session connecting with this resource sync projects. Can be one of EHPMSDKSyncMethod.
m_PasswordFlags
Resource password flags. Can be any combination of EHPMResourcePasswordFlag.
m_RemoteID
If this resource is a remote resource this is the unique database identifier of that resource in the remote database.
m_ParentSDKID
If this resource is an SDK user and this resource was created for a virtual session, this is the unique database identifier of the parent SDK resource.
m_pRemoteGUID
The full GUID of the remote database if the resource is a remote resource.
m_nMemberOfResourceGroups
Number of resource groups the resource is a member of. Set to 0 to disable.
m_pMemberOfResourceGroups
Pointer to a list of unique database ids identifying resource groups. This member can be NULL if m_nMemberOfResourceGroups is 0;
Comments
When getting the resource properties the password cannot be retrieved for security reasons. The password only exists as a hash in the database but is not accessible by the SDK or the clients.
See Also
EHPMResourceFlag, EHPMResourceType, EHPMResourcePasswordFlag, ResourceCreate, ResourceGetProperties ResourceSetProperties
HPMResourceGlobalSettings
Used for specifying global settings for a resource.
struct HPMResourceGlobalSettings {
HPMUInt32 m_Flags;
HPMUInt32 m_DateFormat;
} HPMResourceGlobalSettings;
Members
m_Flags
Binary settings. Can be any combination of EHPMResourceGlobalSettingsFlag.
m_DateFormat
Date format displayed in the resources client. Can be one of EHPMDateFormat.
See Also
EHPMResourceFlag, EHPMResourceType, EHPMResourcePasswordFlag, ResourceGetGlobalSettings, ResourceSetGlobalSettings
HPMResourceGroupEnum
Used for enumerating resource groups in a database.
struct HPMResourceGroupEnum {
HPMUInt32 m_nResourceGroups;
const HPMUniqueID * m_pResourceGroups;
} HPMResourceGroupEnum;
Members
m_nResourceGroups
The number of resource groups in the array.
m_pResourceGroups
Pointer to a list unique database identifiers of resource groups.
See Also
HPMResourceImpersonate
Used for returning the current resource impersonation.
struct HPMResourceImpersonate {
HPMUniqueID m_ResourceID;
HPMInt32 m_ClientOrigin;
const HPMUntranslatedString * m_pCustomClientOrigin;
} HPMResourceImpersonate;
Members
m_ResourceID
The unique identifier of the resource that is currently impersonated.
m_ClientOrigin
The client origin of the current impersonation. Can be one of EHPMDataHistoryClientOrigin.
m_pCustomClientOrigin
The returned custom client origin. Can be null if not set.
See Also
ResourceCreate
Creates a resource in the connected database.
HPMError ResourceCreate (
    void * _pSession,
    const HPMResourceProperties * _pResourceProperties,
    const HPMChar * _pPassword,
    HPMInt32 _bSetFlags,
    HPMUniqueID * _pResourceID
    );
Parameters
_pSession
[in] A connected session. See SessionOpen.
_pResourceProperties
[in] Properties of the created resource. See HPMResourceProperties.
_pPassword
[in] The password of the created resource. Can be any valid UTC-16 string.
_bSetFlags
[in] Set to true if you want to set the flags in HPMResourceProperties. If true the function will block even in non-blocking mode.
_pResourceID
[out] The unique database id of the created resource. In nonblocking mode _pResourceID will be filled with a temporary id that can be matched in the change callback. See EHPMChangeCallbackOperation_ResourceCreate.
Return Value
Returns an error code. See EHPMError.
Comments
If the server run out of licenses the creation of the resource will fail.
See Also
HPMSdkFunctions, ResourceDelete, HPMResourceProperties
ResourceDelete
Deletes a resource in the connected database.
HPMError ResourceDelete (
    void * _pSession,
    HPMUniqueID _ResourceID
    );
Parameters
_pSession
[in] A connected session. See SessionOpen.
_ResourceID
[in] The unique database id of the resource to delete
Return Value
Returns an error code. See EHPMError.
Comments
When a resource is deleted from the database the tasks it is assigned to will be unassigned.
See Also
HPMSdkFunctions, ResourceCreate
ResourceEnum
Enumerates resources in the database.
HPMError ResourceEnum (
    void * _pSession,
    const HPMResourceEnum * * _pEnum
    );
Parameters
_pSession
[in] A connected session. See SessionOpen.
_pEnum
[out] Pointer to a pointer of a HPMResourceEnum object, representing the returned data.
Return Value
Returns an error code. See EHPMError.
Comments
The returned object must be freed with ObjectFree or a memory leak will result.
See Also
HPMSdkFunctions, ObjectFree, HPMResourceEnum
ResourceImpersonate
Impersonates a resource.
HPMError ResourceImpersonate (
    void * _pSession,
    HPMUniqueID _ResourceIDToImpersonate,
    HPMInt32 _ClientOrigin,
    HPMUntranslatedString const * _pCustomClientOrigin
    );
Parameters
_pSession
[in] A connected session. See SessionOpen.
_ResourceIDToImpersonate
[in] The resource that you want to impersonate. Set to -1 to disable impersonation.
_ClientOrigin
[in] Defines a origin that will explain the origin of the operations in task history. Can be one of EHPMDataHistoryClientOrigin.
_pCustomClientOrigin
[in] Defines a custom string that will explain the origin of the operations in task history. Optional.
Return Value
Returns an error code. See EHPMError.
Comments
Use this function to impersonate users. This can be desirable because by default actions in the task history etc will look like the SDK user will have done them. Before calling any functions that is initiated by user actions you should call this function.
See Also
ResourceGetProperties
Gets properties of a resource.
HPMError ResourceGetProperties (
    void * _pSession,
    HPMUniqueID _ResourceID,
    const HPMResourceProperties * * _pResourceProperties
    );
Parameters
_pSession
[in] A connected session. See SessionOpen.
_ResourceID
[in] The resource to get the properties of.
_pResourceProperties
[out] Pointer to a pointer of a HPMResourceProperties object, representing the returned data.
Return Value
Returns an error code. See EHPMError.
Comments
The returned object must be freed with ObjectFree or a memory leak will result.
See Also
HPMSdkFunctions, ObjectFree, HPMResourceProperties
ResourceSetProperties
Sets properties of a resource.
HPMError ResourceSetProperties (
    void * _pSession,
    HPMUniqueID _ResourceID,
    const HPMResourceProperties * _pResourceProperties,
    const HPMChar * _pNewPassword
    );
Parameters
_pSession
[in] A connected session. See SessionOpen.
_ResourceID
[in] The resource to set properties of.
_pResourceProperties
[in] Pointer to a HPMResourceProperties object representing the properties you want to set on the resource.
_pNewPassword
[in] New password to set on the resource. If you don't want to reset the password, pass NULL ("" in C++, .NET and Java) for this parameter.
Return Value
Returns an error code. See EHPMError.
See Also
HPMSdkFunctions, HPMResourceProperties
ResourceGetGlobalSettings
Gets the global settings of a resource.
HPMError ResourceGetGlobalSettings (
    void * _pSession,
    HPMUniqueID _ResourceID,
    const HPMResourceGlobalSettings * * _pSettings
    );
Parameters
_pSession
[in] A connected session. See SessionOpen.
_ResourceID
[in] The resource to get global settings for.
_pSettings
[out] Pointer to a pointer of a HPMResourceGlobalSettings object, representing the returned data.
Return Value
Returns an error code. See EHPMError.
Comments
The returned object must be freed with ObjectFree or a memory leak will result. A users global settings are settings that are resource specific and range over all projects in a database.
See Also
HPMSdkFunctions, ObjectFree, HPMResourceGlobalSettings
ResourceSetGlobalSettings
Sets the global settings of a resource.
HPMError ResourceSetGlobalSettings (
    void * _pSession,
    HPMUniqueID _ResourceID,
    const HPMResourceGlobalSettings * _pSettings
    );
Parameters
_pSession
[in] A connected session. See SessionOpen.
_ResourceID
[in] The resource to set global settings for.
_pSettings
[in] Pointer to a HPMResourceGlobalSettings object representing the settings you want to set on the resource.
Return Value
Returns an error code. See EHPMError.
See Also
HPMSdkFunctions, HPMResourceGlobalSettings
ResourceGetCustomSettingsValue
Gets the value of a resource custom setting.
HPMError ResourceGetCustomSettingsValue (
    void * _pSession,
    HPMInt32 _SettingType,
    HPMUniqueID _ResourceID,
    const HPMChar * _pIdentifier,
    const HPMChar * _pSettingPath,
    const HPMCustomSettingValue * * _pData
    );
Parameters
_pSession
[in] A connected session. See SessionOpen.
_SettingType
[in] The type of the setting. Can be one of EHPMCustomSettingsType.
_ResourceID
[in] The resource to get custom settings value for.
_pIdentifier
[in] The identifier of the integration. This value is used to isolate the custom settings of different integrations.
_pSettingPath
[in] The setting path to get the setting for.
_pData
[out] Pointer to a pointer of a HPMCustomSettingValue object, representing the returned data.
Return Value
Returns an error code. See EHPMError.
Comments
The returned object must be freed with ObjectFree or a memory leak will result.
See Also
HPMSdkFunctions, ObjectFree, HPMCustomSettingValue, GlobalRegisterCustomSettings, ResourceSetCustomSettingsValue, EHPMCustomSettingsType
ResourceSetCustomSettingsValue
Sets the value of a resource custom setting.
HPMError ResourceSetCustomSettingsValue (
    void * _pSession,
    HPMInt32 _SettingType,
    HPMUniqueID _ResourceID,
    const HPMChar * _pIdentifier,
    const HPMChar * _pSettingPath,
    const HPMCustomSettingValue * _pData
    );
Parameters
_pSession
[in] A connected session. See SessionOpen.
_SettingType
[in] The type of the setting. Can be one of EHPMCustomSettingsType.
_ResourceID
[in] The resource to set custom settings value for.
_pIdentifier
[in] The identifier of the integration. This value is used to isolate the custom settings of different integrations.
_pSettingPath
[in] The setting path to get the setting for.
_pData
[in] The custom settings value to set. If set to NULL the value will be set to its default value.
Return Value
Returns an error code. See EHPMError.
See Also
HPMSdkFunctions, ObjectFree, HPMCustomSettingValue GlobalRegisterCustomSettings, ResourceGetCustomSettingsValue, EHPMCustomSettingsType
ResourceGetSDKInternalData
Gets resource SDK internal data.
HPMError ResourceGetSDKInternalData (
    void * _pSession,
    HPMUniqueID _ResourceID,
    const HPMChar * _pIdentifier,
    const HPMSDKInternalData * * _pData
    );
Parameters
_pSession
[in] A connected session. See SessionOpen.
_ResourceID
[in] The resource to get SDK internal data for.
_pIdentifier
[in] The identifier of SDK internal data. This value is used to isolate the SDK internal data of different integrations.
_pData
[out] Pointer to a pointer of a HPMSDKInternalData object, representing the returned data.
Return Value
Returns an error code. See EHPMError.
Comments
The returned object must be freed with ObjectFree or a memory leak will result.
See Also
HPMSdkFunctions, ObjectFree, HPMSDKInternalData, ResourceSetSDKInternalData
ResourceSetSDKInternalData
Sets resource SDK internal data.
HPMError ResourceSetSDKInternalData (
    void * _pSession,
    HPMUniqueID _ResourceID,
    const HPMChar * _pIdentifier,
    const HPMSDKInternalData * _pData
    );
Parameters
_pSession
[in] A connected session. See SessionOpen.
_ResourceID
[in] The resource to set SDK internal data for.
_pIdentifier
[in] The identifier of SDK internal data. This value is used to isolate the SDK internal data of different integrations.
_pData
[in] The SDK internal data to set. See HPMSDKInternalData
Return Value
Returns an error code. See EHPMError.
See Also
HPMSdkFunctions, ObjectFree, HPMSDKInternalData ResourceGetSDKInternalData
ResourceGroupCreate
Creates a resource group in the connected database.
HPMError ResourceGroupCreate (
    void * _pSession,
    const HPMResourceGroupProperties * _pResourceGroupProperties,
    HPMUniqueID * _pResourceGroupID
    );
Parameters
_pSession
[in] A connected session. See SessionOpen.
_pResourceGroupProperties
[in] Properties of the created resource group. See HPMResourceGroupProperties.
_pResourceGroupID
[out] The unique id of the created resource.
Return Value
Returns an error code. See EHPMError.
See Also
HPMSdkFunctions, ResourceGroupDelete, HPMResourceGroupProperties
ResourceGroupDelete
Deletes a resource group in the connected database.
HPMError ResourceGroupDelete (
    void * _pSession,
    HPMUniqueID _ResourceGroupID
    );
Parameters
_pSession
[in] A connected session. See SessionOpen.
_ResourceGroupID
[in] The unique id of the resource group to delete
Return Value
Returns an error code. See EHPMError.
See Also
HPMSdkFunctions, ResourceGroupCreate
ResourceGroupEnum
Enumerates resource groups in the database.
HPMError ResourceGroupEnum (
    void * _pSession,
    const HPMResourceGroupEnum * * _pEnum
    );
Parameters
_pSession
[in] A connected session. See SessionOpen.
_pEnum
[out] Pointer to a pointer of a HPMResourceGroupEnum object, representing the returned data.
Return Value
Returns an error code. See EHPMError.
Comments
The returned object must be freed with ObjectFree or a memory leak will result.
See Also
HPMSdkFunctions, ObjectFree, HPMResourceGroupEnum
ResourceGroupGetProperties
Gets properties of a resource group.
HPMError ResourceGroupGetProperties (
    void * _pSession,
    HPMUniqueID _ResourceID,
    const HPMResourceGroupProperties * * _pResourceGroupProperties
    );
Parameters
_pSession
[in] A connected session. See SessionOpen.
_ResourceID
[in] The resource group to get the properties of.
_pResourceGroupProperties
[out] Pointer to a pointer of a HPMResourceGroupProperties object, representing the returned data.
Return Value
Returns an error code. See EHPMError.
Comments
The returned object must be freed with ObjectFree or a memory leak will result.
See Also
HPMSdkFunctions, ObjectFree, HPMResourceGroupProperties
ResourceGroupSetProperties
Sets properties of a resource group.
HPMError ResourceGroupSetProperties (
    void * _pSession,
    HPMUniqueID _ResourceID,
    const HPMResourceGroupProperties * _pResourceGroupProperties
    );
Parameters
_pSession
[in] A connected session. See SessionOpen.
_ResourceID
[in] The resource group to set properties of.
_pResourceGroupProperties
[in] Pointer to a HPMResourceGroupProperties object representing the properties you want to set on the resource group.
Return Value
Returns an error code. See EHPMError.
See Also
HPMSdkFunctions, HPMResourceGroupProperties
ResourceGetLoggedIn
Gets the id of the currently logged in resource.
HPMError ResourceGetLoggedIn (
    void * _pSession,
    HPMUniqueID * _pResourceID
    );
Parameters
_pSession
[in] A connected session. See SessionOpen.
_pResourceID
[out] Pointer to a variable that will receive the unique identifier of the resource that is currently logged in.
Return Value
Returns an error code. See EHPMError.
See Also
ResourceGroupGetResources
Gets resources that are members of a resource group.
HPMError ResourceGroupGetResources (
    void * _pSession,
    HPMUniqueID _ResourceGroupID,
    const HPMResourceEnum * * _pEnum
    );
Parameters
_pSession
[in] A connected session. See SessionOpen.
_ResourceGroupID
[in] The resource group to get the members of.
_pEnum
[out] Pointer to a pointer of a HPMResourceEnum object, representing the returned data.
Return Value
Returns an error code. See EHPMError.
Comments
The returned object must be freed with ObjectFree or a memory leak will result.
See Also
HPMSdkFunctions, ObjectFree, HPMResourceEnum
ResourceGetResourceFromName
Gets a resource from a name.
HPMError ResourceGetResourceFromName (
    void * _pSession,
    const HPMChar * _pResourceName,
    HPMUniqueID * _pResourceID
    );
Parameters
_pSession
[in] A connected session. See SessionOpen.
_pResourceName
[in] The name to find a resource for.
_pResourceID
[out] Pointer to a variable that will receive the unique identifier of the resource. Set to -1 if no matching resource is found.
Return Value
Returns an error code. See EHPMError.
See Also
ResourceGetNameFromResource
Gets a name from a resource.
HPMError ResourceGetNameFromResource (
    void * _pSession,
    HPMUniqueID _ResourceID,
    const HPMString * * _pResourceName
    );
Parameters
_pSession
[in] A connected session. See SessionOpen.
_ResourceID
[in] The resource to get the name of.
_pResourceName
[out] Pointer to a pointer of a HPMString object, representing the returned resource name.
Return Value
Returns an error code. See EHPMError.
Comments
The returned object must be freed with ObjectFree or a memory leak will result.
See Also
ResourceGroupGetNameFromResourceGroup
Gets a name from a resource group.
HPMError ResourceGroupGetNameFromResourceGroup (
    void * _pSession,
    HPMUniqueID _ResourceGroupID,
    const HPMString * * _pResourceGroupName
    );
Parameters
_pSession
[in] A connected session. See SessionOpen.
_ResourceGroupID
[in] The resource group to get the name of.
_pResourceGroupName
[out] Pointer to a pointer of a HPMString object, representing the returned resource group name.
Return Value
Returns an error code. See EHPMError.
Comments
The returned object must be freed with ObjectFree or a memory leak will result.
See Also
ResourceGroupUtilResourceGroupExists
Checks if an identifier is a resource group.
HPMError ResourceGroupUtilResourceGroupExists (
    void * _pSession,
    HPMUniqueID _ResourceGroupID,
    HPMInt32 * _pReturn
    );
Parameters
_pSession
[in] A connected session. See SessionOpen.
_ResourceGroupID
[in] The identifier to check if it s a resource group.
_pReturn
[out] Returns 1 if the identifer is a resource group 0 otherwise.
Return Value
Returns an error code. See EHPMError.
See Also
ResourceGetImpersonate
Gets the id of the currently impersonated resource.
HPMError ResourceGetImpersonate (
    void * _pSession,
    HPMResourceImpersonate const * * _pResourceImpersonate
    );
Parameters
_pSession
[in] A connected session. See SessionOpen.
_pResourceImpersonate
[out] Pointer to a pointer of a HPMResourceImpersonate object, representing the returned impersonation settings.
Return Value
Returns an error code. See EHPMError.
See Also
HPMSdkFunctions, HPMResourceImpersonate
Comments
The returned object must be freed with ObjectFree or a memory leak will result.
ResourceGetLockFlags
Gets the lock flags of a resource.
HPMError ResourceGetLockFlags (
    void * _pSession,
    HPMUniqueID _ResourceID,
    HPMUInt32 * _pLockFlags
    );
Parameters
_pSession
[in] A connected session. See SessionOpen.
_ResourceID
[in] The unique id of the resource to get the lock flags for.
_pLockFlags
[out] The resource lock flags. See EHPMResourceLockFlag.
Return Value
Returns an error code. See EHPMError.
See Also
HPMSdkFunctions, EHPMResourceLockFlag
ResourceChangeLockFlags
Changes the lock flags of a resource.
HPMError ResourceChangeLockFlags (
    void * _pSession,
    HPMUniqueID _ResourceID,
    HPMUInt32 _RemoveFlags,
    HPMUInt32 _AddFlags
    );
Parameters
_pSession
[in] A connected session. See SessionOpen.
_ResourceID
[in] The unique id of the resource to get the lock flags for.
_RemoveFlags
[in] The lock flags to remove. See EHPMResourceLockFlag.
_AddFlags
[in] The lock flags to add. See EHPMResourceLockFlag.
Return Value
Returns an error code. See EHPMError.
See Also
HPMSdkFunctions, EHPMResourceLockFlag
ResourceSetPreferredLanguage
Sets the preferred language of a resource.
HPMError ResourceSetPreferredLanguage (
    void * _pSession,
    HPMUniqueID _ResourceID,
    const HPMLanguage * _pPreferredLanguage
    );
Parameters
_pSession
[in] A connected session. See SessionOpen.
_ResourceID
[in] The resource to set the preferred language for.
_pPreferredLanguage
[in] Pointer to a HPMLanguage object representing the preferred language you want to set for the resource.
Return Value
Returns an error code. See EHPMError.
See Also
ResourceGetPreferredLanguage
Gets the preferred language of a resource.
HPMError ResourceGetPreferredLanguage (
    void * _pSession,
    HPMUniqueID _ResourceID,
    const HPMLanguage * * _pPreferredLanguage
    );
Parameters
_pSession
[in] A connected session. See SessionOpen.
_ResourceID
[in] The resource to get the preferred language for.
_pPreferredLanguage
[out] Pointer to a pointer of a HPMLanguage object, representing the returned data.
Return Value
Returns an error code. See EHPMError.
Comments
The returned object must be freed with ObjectFree or a memory leak will result.
See Also
HPMSdkFunctions, ObjectFree, HPMLanguage
ResourceSetLastUsedLanguage
Sets the last used language of a resource.
HPMError ResourceSetLastUsedLanguage (
    void * _pSession,
    HPMUniqueID _ResourceID,
    const HPMLanguage * _pPreferredLanguage
    );
Parameters
_pSession
[in] A connected session. See SessionOpen.
_ResourceID
[in] The resource to set the last used language for.
_pPreferredLanguage
[in] Pointer to a HPMLanguage object representing the last used language you want to set for the resource.
Return Value
Returns an error code. See EHPMError.
See Also
ResourceGetLastUsedLanguage
Gets the last used language of a resource.
HPMError ResourceGetLastUsedLanguage (
    void * _pSession,
    HPMUniqueID _ResourceID,
    const HPMLanguage * * _pPreferredLanguage
    );
Parameters
_pSession
[in] A connected session. See SessionOpen.
_ResourceID
[in] The resource to get the last used language for.
_pPreferredLanguage
[out] Pointer to a pointer of a HPMLanguage object, representing the returned data.
Return Value
Returns an error code. See EHPMError.
Comments
The returned object must be freed with ObjectFree or a memory leak will result.
See Also
HPMSdkFunctions, ObjectFree, HPMLanguage
ResourceGetEffectiveLanguage
Gets the last used language of a resource.
HPMError ResourceGetEffectiveLanguage (
    void * _pSession,
    HPMUniqueID _ResourceID,
    const HPMLanguage * * _pPreferredLanguage
    );
Parameters
_pSession
[in] A connected session. See SessionOpen.
_ResourceID
[in] The resource to get the effective language for.
_pPreferredLanguage
[out] Pointer to a pointer of a HPMLanguage object, representing the returned data.
Return Value
Returns an error code. See EHPMError.
Comments
The returned object must be freed with ObjectFree or a memory leak will result. Returns the last used language of a resource. If not set returns preferred language.
See Also
HPMSdkFunctions, ObjectFree, HPMLanguage
ResourceTimesheetPeriodDataDelete
Deletes timesheet data up to an end date.
HPMError ResourceTimesheetPeriodDataDelete (
    void * _pSession,
    HPMUniqueID _ResourceID,
    HPMUInt64 _EndDate
    );
Parameters
_pSession
[in] A connected session. See SessionOpen.
_ResourceID
[in] The resource to delete timesheet data for.
_EndDate
[in] The end date up to which timesheet data will be deleted. Expressed as the number of micro seconds since 1970 UTC.
Return Value
Returns an error code. See EHPMError.
See Also
ResourceUtilExpandResources
Expands a resource definition list into resources.
HPMError ResourceUtilExpandResources (
    void * _pSession,
    HPMUniqueID _ProjectID,
    HPMInt32 _bIncludeGhosts,
    HPMInt32 _bIncludeQAResources,
    HPMResourceDefinitionList const * _pResourceList,
    HPMResourceDefinitionList const * * _pResult
    );
Parameters
_pSession
[in] A connected session. See SessionOpen.
_ProjectID
[in] The project ID this is in reference to. Can be set to -1 to expand resources in a global context
_bIncludeGhosts
[in] Set to 1 to include ghost resources in the expansion.
_bIncludeQAResources
[in] Set to 1 to include QA resources in the expansion. If _ProjectID points to a QA project QA resources will always be included even if this is set to 0.
_pResourceList
[in] The resource definition list to expand.
_pResult
[out] The expanded resources. Will be a list of EHPMResourceGroupingType_Resource resources.
Return Value
Returns an error code. See EHPMError.
Comments
The returned object must be freed with ObjectFree or a memory leak will result.
See Also
ResourceSetChatOnlineStatus
Sets the chat online status for the currently logged in SDK resource.
HPMError ResourceSetChatOnlineStatus (
    void * _pSession,
    HPMInt32 _ChatStatus
    );
Parameters
_pSession
[in] A connected session. See SessionOpen.
_ChatStatus
[in] The new status. Will be one of EHPMChatOnlineStatus.
Return Value
Returns an error code. See EHPMError.
See Also
ResourceGetChatOnlineStatus
Gets the chat online status for a resource.
HPMError ResourceGetChatOnlineStatus (
    void * _pSession,
    HPMUniqueID _ResourceID,
    HPMInt32 * _pChatStatus
    );
Parameters
_pSession
[in] A connected session. See SessionOpen.
_ResourceID
[in] The resource to get the chat online status for.
_pChatStatus
[out] Pointer to a variable that will receive the status. Will be one of EHPMChatOnlineStatus.
Return Value
Returns an error code. See EHPMError.
See Also
ResourceSetDoNotDisturb
Sets the do not disturb flag for a resource.
HPMError ResourceSetDoNotDisturb (
    void * _pSession,
    HPMUniqueID _ResourceID,
    HPMInt32 _bDoNotDisturb
    );
Parameters
_pSession
[in] A connected session. See SessionOpen.
_ResourceID
[in] The resource to get the do not disturb flag for.
_bDoNotDisturb
[in] The new status.
Return Value
Returns an error code. See EHPMError.
See Also
ResourceGetDoNotDisturb
Gets the do not disturb flag for a resource.
HPMError ResourceGetDoNotDisturb (
    void * _pSession,
    HPMUniqueID _ResourceID,
    HPMInt32 * _pbDoNotDisturb
    );
Parameters
_pSession
[in] A connected session. See SessionOpen.
_ResourceID
[in] The resource to get the do not disturb flag.
_pbDoNotDisturb
[out] Pointer to a variable that will receive the do not disturb flag.
Return Value
Returns an error code. See EHPMError.
See Also
ResourceSendChatMessage
Sets/submits a chat message for a resource.
HPMError ResourceSendChatMessage (
    void * _pSession,
    HPMUniqueID _ResourceID,
    HPMChatRoom const * _pChatRoom,
    HPMChar const * _pMessage
    );
Parameters
_pSession
[in] A connected session. See SessionOpen.
_ResourceID
[in] The resource to send the chat message from.
_pChatRoom
[in] The chat room identifier to send the message to. See HPMChatRoom.
_pMessage
[in] Pointer to the HPMChar chat message to submit.
Return Value
Returns an error code. See EHPMError.
Comments
The message is routed to the connected users defined in the chat room plus all currently connected SDK sessions. If the chat is a resource group chat the sending resource must be a member of the resource group. It is possible to chat with an SDK user if the EHPMResourceFlag_SdkChatUser property is set on the SDK user. If the EHPMResourceGroupFlag_ChatVisibleInNewsFeed property is set on a resource group, chat messages to that resource group will also be added to the news feed.
See Also
ResourceSetLastReadChatID
Sets the last read chat message id for a resource.
HPMError ResourceSetLastReadChatID (
    void * _pSession,
    HPMUniqueID _ResourceID,
    HPMChatRoom const * _pChatRoom,
    HPMInt64 _ID
    );
Parameters
_pSession
[in] A connected session. See SessionOpen.
_ResourceID
[in] The resource to set last read message id for.
_pChatRoom
[in] The chat room identifier to set last read message id in. See HPMChatRoom.
_ID
[in] The last read id to set.
Return Value
Returns an error code. See EHPMError.
See Also
ResourceGetLastReadChatID
Gets the last read chat message id for a resource.
HPMError ResourceGetLastReadChatID (
    void * _pSession,
    HPMUniqueID _ResourceID,
    HPMChatRoom const * _pChatRoom,
    HPMInt64 * _pID
    );
Parameters
_pSession
[in] A connected session. See SessionOpen.
_ResourceID
[in] The resource to get last read message id for.
_pChatRoom
[in] The chat room identifier to get last read message id in. See HPMChatRoom.
_pID
[out] Pointer to the returned last read id.
Return Value
Returns an error code. See EHPMError.
See Also
ResourceUploadAvatar
Uploads an avatar image for a resource.
HPMError ResourceUploadAvatar (
    void * _pSession,
    HPMUniqueID _ResourceID,
    const HPMChar * _pPath,
    HPMUInt32 _XOffset,
    HPMUInt32 _YOffset,
    HPMUInt32 _Size,
    const HPMChangeCallbackData_VersionControlUploadAvatarFilesResponse * * _pResult
    );
Parameters
_pSession
[in] A connected session. See SessionOpen.
_ResourceID
[in] The resource to upload the avatar image for.
_pPath
[in] The local path to the avatar image.
_XOffset
[in] The x offset within the image where the avatar image begins.
_YOffset
[in] The y offset within the image where the avatar image begins.
_Size
[in] The vertical and horizontal pixel length of the avatar image.
_pResult
[out] Pointer to a pointer of a HPMChangeCallbackData_VersionControlUploadAvatarFilesResponse object specifying the result of this operation. See comments section.
Return Value
Returns an error code. See EHPMError.
Comments
The avatar images are stored in the version control system under Global/[ResourceID] The original image is cropped according to the offsets and size and is stored with the name Avatar.PNG. Resized versions of the original are stored as Avatar_[size].PNG. Any previously uploaded avatar images are deleted. You must call VersionControlInit before using this function or the function will fail and return EHPMError_FunctionalityNotInitialized. If you specify a non-NULL pointer to the _pResult parameter this function will block and the result of the operation will be returned. The returned result must be freed with ObjectFree or a memory leak will result. If you specify a NULL pointer to the _pResult parameter this function will not block and when the operation is finished you will receive a EHPMChangeCallbackOperation_VersionControlAddFilesResponse callback. Only one operation can be in flight at the same time on the same client and you should wait until other operations are finished before calling this function. If another operation is in progress this function will return EHPMError_OperationAlreadyInProgress. The files are automatically committed after creation.
See Also
ObjectFree, HPMSdkFunctions, VersionControlInit, HPMChangeCallbackData_VersionControlAddFilesResponse
ResourceGetTimesheetDay
Gets a timesheet period report for a resource.
HPMError ResourceGetTimesheetDay (
    void * _pSession,
    HPMUniqueID _ResourceID,
    HPMUInt64 _Day,
    const HPMChangeCallbackData_ResourceGetTimesheetDayResponse * * _pResult
    );
Parameters
_pSession
[in] A connected session. See SessionOpen.
_ResourceID
[in] The resource to get the timesheet report for for.
_Day
[in] The day to get the timesheet report for. Expressed as the number of microseconds since 1970 UTC.
_pResult
[out] Pointer to a pointer of a HPMChangeCallbackData_ResourceGetTimesheetDayResponse object, representing the returned data. This function will block even in non-blocking mode if this parameter is not NULL.
Return Value
Returns an error code. See EHPMError.
Comments
If you specify a non-NULL pointer to the _pResult parameter this function will block and the result of the operation will be returned. The returned result must be freed with ObjectFree or a memory leak will result. If you specify a NULL pointer to the _pResult parameter this function will not block and when the operation is finished you will receive a EHPMChangeCallbackOperation_ResourceGetTimesheetReportResponse callback.
See Also
HPMSdkFunctions, ObjectFree, HPMChangeCallbackData_ResourceGetTimesheetDayResponse
ResourceGetDashboardPage
Gets the personal dashboard page for a resource.
HPMError ResourceGetDashboardPage (
    void * _pSession,
    HPMUniqueID _ResourceID,
    HPMUniqueID * _pData
    );
Parameters
_pSession
[in] A connected session. See SessionOpen.
_ResourceID
[in] The unique identifier of the resource to get the personal dashboard page for.
_pData
[out] Pointer to a variable that will receive the unique identifier of the personal dahboard page.
Return Value
Returns an error code. See EHPMError.
See Also
ResourceReplaceGuestResourceWithHomeResource
Reploce remote guest share user with local user.
HPMError ResourceReplaceGuestResourceWithHomeResource (
    void * _pSession,
    HPMUniqueID _RemoteID,
    HPMUniqueID _LocalID
    );
Parameters
_pSession
[in] A connected session. See SessionOpen.
_RemoteID
[in] The unique identifier of the remote guest share user tha will be replaced.
_LocalID
[in] The unique identifier of the local user that will replace the remote user.
Return Value
Returns an error code. See EHPMError.
See Also
ResourceMakeGuestResourceAHomeResource
Make remote guest share user a local user.
HPMError ResourceMakeGuestResourceAHomeResource (
    void * _pSession,
    HPMUniqueID _RemoteID,
    HPMChar const * _pName,
    HPMChar const * _pNewPassword
    );
Parameters
_pSession
[in] A connected session. See SessionOpen.
_RemoteID
[in] The unique identifier of the remote guest share user.
_pName
[in] Name of the created home user. Usually best to use the name of the remote user.
_pNewPassword
[in] New password to set on the created home user.
Return Value
Returns an error code. See EHPMError.
See Also
ResourceGroupNewCreate
Creates a resource group in the connected database. Immediately adds users to the group.
HPMError ResourceGroupNewCreate (
    void * _pSession,
    HPMResourceGroupInfo const * _pResourceGroupInfo,
    HPMInt32 _LocalOperationID,
    HPMChangeCallbackData_ResourceGroupAdded const * * _pReturn
    );
Parameters
_pSession
[in] A connected session. See SessionOpen.
_pResourceGroupInfo
[in] Info of the created resource group. HPMResourceGroupInfo::m_GroupID should be unique number. If group with such ID exists - command will fail. See HPMResourceGroupInfo.
_LocalOperationID
[in] Operation ID to identify command in command callback
_pReturn
[out] Pointer to a pointer of a HPMChangeCallbackData_ResourceGroupAdded object, representing the returned data. If this parameter is not NULL, the function will block.
Return Value
Returns an error code. See EHPMError.
See Also
HPMSdkFunctions, HPMResourceGroupInfo , HPMChangeCallbackData_ResourceGroupAdded
ResourceGroupNewEdit
Edits a resource group in the connected database.
HPMError ResourceGroupNewEdit (
    void * _pSession,
    HPMResourceGroupInfo const * _pResourceGroupInfo,
    HPMInt32 _LocalOperationID,
    HPMChangeCallbackData_ResourceGroupEdited const * * _pReturn
    );
Parameters
_pSession
[in] A connected session. See SessionOpen.
_pResourceGroupInfo
[in] Info of the edited resource group. HPMResourceGroupInfo::m_GroupID should be the ID of existing group. See HPMResourceGroupInfo.
_LocalOperationID
[in] Operation ID to identify command in command callback
_pReturn
[out] Pointer to a pointer of a HPMChangeCallbackData_ResourceGroupEdited object, representing the returned data. If this parameter is not NULL, the function will block.
Return Value
Returns an error code. See EHPMError.
See Also
HPMSdkFunctions, HPMResourceGroupInfo , HPMChangeCallbackData_ResourceGroupEdited
ResourceGroupNewDelete
Deletes a resource group in the connected database.
HPMError ResourceGroupNewDelete (
    void * _pSession,
    HPMInt32 _GroupID,
    HPMInt32 _LocalOperationID,
    HPMChangeCallbackData_ResourceGroupDeleted const * * _pReturn
    );
Parameters
_pSession
[in] A connected session. See SessionOpen.
_GroupID
[in] Id of the group to delete.
_LocalOperationID
[in] Operation ID to identify command in command callback
_pReturn
[out] Pointer to a pointer of a HPMChangeCallbackData_ResourceGroupDeleted object, representing the returned data. If this parameter is not NULL, the function will block.
Return Value
Returns an error code. See EHPMError.
See Also
HPMSdkFunctions, HPMChangeCallbackData_ResourceGroupDeleted
ResourceGroupGetNextID
Gets next unique number, that could be used as ID of new group. This function can be used when creating a new group, since the the ID of the new group is provided by the calling function.
HPMError ResourceGroupGetNextID (
    void * _pSession,
    HPMInt32 * _pNextID
    );
Parameters
_pSession
[in] A connected session. See SessionOpen.
_pNextID
[out] Next unique Group ID.
Return Value
Returns an error code. See EHPMError.
See Also
HPMSdkFunctions, ResourceGroupNewCreate
ResourceGroupGetSortNameFromResourceGroup
Gets the sort name from a resource group.
HPMError ResourceGroupGetSortNameFromResourceGroup (
    void * _pSession,
    HPMUniqueID _ResourceGroupID,
    HPMString const * * _pResourceGroupSortName
    );
Parameters
_pSession
[in] A connected session. See SessionOpen.
_ResourceGroupID
[in] The resource group to get the sort name of.
_pResourceGroupSortName
[out] Pointer to a pointer of a HPMString object, representing the returned resource group sort name.
Return Value
Returns an error code. See EHPMError.
Comments
The returned object must be freed with ObjectFree or a memory leak will result.
See Also
ResourceGroupGetProjectFromResourceGroup
Gets the project for a resource group.
HPMError ResourceGroupGetProjectFromResourceGroup (
    void * _pSession,
    HPMUniqueID _ResourceGroupID,
    HPMUniqueID * _pProjectID
    );
Parameters
_pSession
[in] A connected session. See SessionOpen.
_ResourceGroupID
[in] The resource group to get the project for.
_pProjectID
[out] Pointer to the returned project identifier.
Return Value
Returns an error code. See EHPMError.
See Also
ResourceGetSortNameFromResource
Gets a sort name from a resource.
HPMError ResourceGetSortNameFromResource (
    void * _pSession,
    HPMUniqueID _ResourceID,
    HPMString const * * _pSortName
    );
Parameters
_pSession
[in] A connected session. See SessionOpen.
_ResourceID
[in] The resource to get the sort name of.
_pSortName
[out] Pointer to a pointer of a HPMString object, representing the returned sort name.
Return Value
Returns an error code. See EHPMError.
Comments
The returned object must be freed with ObjectFree or a memory leak will result.
See Also
ResourceUtilResourceIsDeleted
Checks if a resource is deleted.
HPMError ResourceUtilResourceIsDeleted (
    void * _pSession,
    HPMUniqueID _ResourceID,
    HPMInt32 * _pReturn
    );
Parameters
_pSession
[in] A connected session. See SessionOpen.
_ResourceID
[in] The resource to check if it is deleted.
_pReturn
[out] Returns 1 if the resource is deleted, 0 otherwise.
Return Value
Returns an error code. See EHPMError.
See Also
ResourceUtilResourceIsLocked
Checks if a resource is locked.
HPMError ResourceUtilResourceIsLocked (
    void * _pSession,
    HPMUniqueID _ResourceID,
    HPMInt32 * _pReturn
    );
Parameters
_pSession
[in] A connected session. See SessionOpen.
_ResourceID
[in] The resource to check if it is locked.
_pReturn
[out] Returns 1 if the resource is locked, 0 otherwise.
Return Value
Returns an error code. See EHPMError.
See Also
ResourceGetEmailFromResource
Gets a resource email address.
HPMError ResourceGetEmailFromResource (
    void * _pSession,
    HPMUniqueID _ResourceID,
    HPMString const * * _pEmail
    );
Parameters
_pSession
[in] A connected session. See SessionOpen.
_ResourceID
[in] The resource to get the email.
_pEmail
[out] Pointer to a pointer of a HPMString object, representing the returned email.
Return Value
Returns an error code. See EHPMError.
Comments
The returned object must be freed with ObjectFree or a memory leak will result.
See Also
ResourceUtilResourceIsActiveAccount
Checks if a resource account is active.
HPMError ResourceUtilResourceIsActiveAccount (
    void * _pSession,
    HPMUniqueID _ResourceID,
    HPMInt32 * _pReturn
    );
Parameters
_pSession
[in] A connected session. See SessionOpen.
_ResourceID
[in] The resource to check if it is active.
_pReturn
[out] Returns 1 if the resource is a active, 0 otherwise.
Return Value
Returns an error code. See EHPMError.
See Also
ResourceUtilResourceHasAdminAccess
Checks if a resource has admin access.
HPMError ResourceUtilResourceHasAdminAccess (
    void * _pSession,
    HPMUniqueID _ResourceID,
    HPMInt32 * _pReturn
    );
Parameters
_pSession
[in] A connected session. See SessionOpen.
_ResourceID
[in] The resource to check if it has admin access.
_pReturn
[out] Returns 1 if the resource has admin access, 0 otherwise.
Return Value
Returns an error code. See EHPMError.
See Also
ResourceUtilResourceHasResourceAllocationAccess
Checks if a resource has resource allocation access.
HPMError ResourceUtilResourceHasResourceAllocationAccess (
    void * _pSession,
    HPMUniqueID _ResourceID,
    HPMInt32 * _pReturn
    );
Parameters
_pSession
[in] A connected session. See SessionOpen.
_ResourceID
[in] The resource to check if it has resource allocation access.
_pReturn
[out] Returns 1 if the resource has resource allocation access, 0 otherwise.
Return Value
Returns an error code. See EHPMError.
See Also
ResourceUtilResourceHasDocumentManagementAccess
Checks if a resource has document management access.
HPMError ResourceUtilResourceHasDocumentManagementAccess (
    void * _pSession,
    HPMUniqueID _ResourceID,
    HPMInt32 * _pReturn
    );
Parameters
_pSession
[in] A connected session. See SessionOpen.
_ResourceID
[in] The resource to check if it has document management access.
_pReturn
[out] Returns 1 if the resource has document management access, 0 otherwise.
Return Value
Returns an error code. See EHPMError.
See Also
ResourceUtilResourceIsAuthenticationProvider
Checks if an SDK resource is an authentication provider.
HPMError ResourceUtilResourceIsAuthenticationProvider (
    void * _pSession,
    HPMUniqueID _ResourceID,
    HPMInt32 * _pReturn
    );
Parameters
_pSession
[in] A connected session. See SessionOpen.
_ResourceID
[in] The resource to check if it is an authentication provider.
_pReturn
[out] Returns 1 if the resource is an authentication provider, 0 otherwise.
Return Value
Returns an error code. See EHPMError.
See Also
ResourceUtilResourceIsCredentialCheckProvider
Checks if an SDK resource is a credential check provider.
HPMError ResourceUtilResourceIsCredentialCheckProvider (
    void * _pSession,
    HPMUniqueID _ResourceID,
    HPMInt32 * _pReturn
    );
Parameters
_pSession
[in] A connected session. See SessionOpen.
_ResourceID
[in] The resource to check if it is a credential check provider.
_pReturn
[out] Returns 1 if the resource is a credential check provider, 0 otherwise.
Return Value
Returns an error code. See EHPMError.
See Also
ResourceUtilResourceHasAvatarManagementAccess
Checks if a resource has avatar management access.
HPMError ResourceUtilResourceHasAvatarManagementAccess (
    void * _pSession,
    HPMUniqueID _ResourceID,
    HPMInt32 * _pReturn
    );
Parameters
_pSession
[in] A connected session. See SessionOpen.
_ResourceID
[in] The resource to check if it has avatar management access.
_pReturn
[out] Returns 1 if the resource has avatar management access, 0 otherwise.
Return Value
Returns an error code. See EHPMError.
See Also
ResourceUtilResourceIsSdkChatUser
Checks if an SDK resource is chat user.
HPMError ResourceUtilResourceIsSdkChatUser (
    void * _pSession,
    HPMUniqueID _ResourceID,
    HPMInt32 * _pReturn
    );
Parameters
_pSession
[in] A connected session. See SessionOpen.
_ResourceID
[in] The resource to check if it is chat user.
_pReturn
[out] Returns 1 if the resource is chat user, 0 otherwise.
Return Value
Returns an error code. See EHPMError.
See Also
ResourceUtilResourceHasChatAccess
Checks if a resource has chat access.
HPMError ResourceUtilResourceHasChatAccess (
    void * _pSession,
    HPMUniqueID _ResourceID,
    HPMInt32 * _pReturn
    );
Parameters
_pSession
[in] A connected session. See SessionOpen.
_ResourceID
[in] The resource to check if it has chat access.
_pReturn
[out] Returns 1 if the resource has chat access, 0 otherwise.
Return Value
Returns an error code. See EHPMError.
See Also
ResourceUtilResourceHasDashboardAccess
Checks if a resource has dashboard access.
HPMError ResourceUtilResourceHasDashboardAccess (
    void * _pSession,
    HPMUniqueID _ResourceID,
    HPMInt32 * _pReturn
    );
Parameters
_pSession
[in] A connected session. See SessionOpen.
_ResourceID
[in] The resource to check if it has dashboard access.
_pReturn
[out] Returns 1 if the resource has dashboard access, 0 otherwise.
Return Value
Returns an error code. See EHPMError.
See Also
ResourceUtilResourceCanShareDashboardPages
Checks if a resource can share dashboard pages.
HPMError ResourceUtilResourceCanShareDashboardPages (
    void * _pSession,
    HPMUniqueID _ResourceID,
    HPMInt32 * _pReturn
    );
Parameters
_pSession
[in] A connected session. See SessionOpen.
_ResourceID
[in] The resource to check if it can share dashboard pages.
_pReturn
[out] Returns 1 if the resource can share dashboard pages, 0 otherwise.
Return Value
Returns an error code. See EHPMError.
See Also
ResourceUtilSdkResourceGetSyncMethod
Gets the sync method of an SDK resource.
HPMError ResourceUtilSdkResourceGetSyncMethod (
    void * _pSession,
    HPMUniqueID _ResourceID,
    HPMUInt32 * _pMethod
    );
Parameters
_pSession
[in] A connected session. See SessionOpen.
_ResourceID
[in] The unique identifier of the SDK resource to get the sync method of.
_pMethod
[out] Pointer to a variable that receive the sync method. Will be one of EHPMSDKSyncMethod.
Return Value
Returns an error code. See EHPMError.
See Also
HPMSdkFunctions, EHPMSDKSyncMethod
EHPMProjectSettingsFlag
Flags to specify for HPMProjectSettings::m_Flags
enum EHPMProjectSettingsFlag {
EHPMProjectSettingsFlag_None = 0,
EHPMProjectSettingsFlag_SprintMembersCanBreakdownBacklogItemsIntoTasks = 2,
EHPMProjectSettingsFlag_SprintMembersCanBreakdownBacklogItemsIntoTasksOnlyIfAssigned = 4,
EHPMProjectSettingsFlag_WorkflowCustomized = 8,
EHPMProjectSettingsFlag_CreatedBacklogItemsAreUserStoriesByDefault = 16,
EHPMProjectSettingsFlag_EverybodyCanCommentOnAllItems = 32,
EHPMProjectSettingsFlag_AutoRefreshQAView = 64,
EHPMProjectSettingsFlag_DisplayItemsInQAViewWithoutQuery = 128,
EHPMProjectSettingsFlag_DisplayIdealEstimateAsHours = 256,
EHPMProjectSettingsFlag_ResourcesCanImportData = 512,
EHPMProjectSettingsFlag_CreatedSprintBacklogItemsAreUserStoriesByDefault = 1024,
EHPMProjectSettingsFlag_ResourcesCanAssignToGhostUsers = 2048,
};
Values
EHPMProjectSettingsFlag_None
TBD
EHPMProjectSettingsFlag_SprintMembersCanBreakdownBacklogItemsIntoTasks
Members of this project can break down backlog items into tasks in their my work view and in the project view.
EHPMProjectSettingsFlag_SprintMembersCanBreakdownBacklogItemsIntoTasksOnlyIfAssigned
Members of this project can break down backlog items into tasks in their my work view and in the project view only if they are assigned to the task.
EHPMProjectSettingsFlag_WorkflowCustomized
The workflow has been customized. Set this flag if the workflow has been customized. This will prevent the workflow from being overwritten with the default workflow.
EHPMProjectSettingsFlag_CreatedBacklogItemsAreUserStoriesByDefault
Newly created backlog items are flagged as user stories by default for project when this flag is set.
EHPMProjectSettingsFlag_EverybodyCanCommentOnAllItems
All members of project can comment on all items in the project.
EHPMProjectSettingsFlag_AutoRefreshQAView
The QA view should be automatically refreshed every minute.
EHPMProjectSettingsFlag_DisplayItemsInQAViewWithoutQuery
If no query options are set for the QA View, display all bugs.
EHPMProjectSettingsFlag_DisplayIdealEstimateAsHours
If set all ideal estimates will be displayed as hours, otherwise days.
EHPMProjectSettingsFlag_ResourcesCanImportData
If set resources can import data into all areas they are allowed to edit, including sections they have been delegated.
EHPMProjectSettingsFlag_CreatedSprintBacklogItemsAreUserStoriesByDefault
Newly created sprint backlog items are flagged as user stories by default for project when this flag is set.
EHPMProjectSettingsFlag_ResourcesCanAssignToGhostUsers
If set normal project resources can assign to ghost users.
See Also
EHPMProjectCustomColumnsColumnFlag
Flags used for HPMProjectCustomColumnsColumn::m_Flags
enum EHPMProjectCustomColumnsColumnFlag {
EHPMProjectCustomColumnsColumnFlag_None = 0,
EHPMProjectCustomColumnsColumnFlag_UpdateDate_OnNew = 1,
EHPMProjectCustomColumnsColumnFlag_DontIntheritData = 2,
EHPMProjectCustomColumnsColumnFlag_UpdateDate_OnNotDone = 4,
EHPMProjectCustomColumnsColumnFlag_UpdateDate_OnInProgress = 8,
EHPMProjectCustomColumnsColumnFlag_UpdateDate_OnCompleted = 16,
EHPMProjectCustomColumnsColumnFlag_UpdateDate_OnBlocked = 32,
EHPMProjectCustomColumnsColumnFlag_UpdateDate_OnToBeDeleted = 64,
EHPMProjectCustomColumnsColumnFlag_UpdateDate_OnCommited = 128,
EHPMProjectCustomColumnsColumnFlag_UpdateDate_SetFirstTime = 256,
};
Values
EHPMProjectCustomColumnsColumnFlag_None
TBD
EHPMProjectCustomColumnsColumnFlag_UpdateDate_OnNew
When creating new tasks and this flag is set on a date or date time custom column, the value for the custom column will be now
EHPMProjectCustomColumnsColumnFlag_DontIntheritData
TBD
EHPMProjectCustomColumnsColumnFlag_UpdateDate_OnNotDone
When changing status of the task to NotDone and this flag is set on a date or date time custom column, the value for the custom column will be now
EHPMProjectCustomColumnsColumnFlag_UpdateDate_OnInProgress
When changing status of the task to InProgress and this flag is set on a date or date time custom column, the value for the custom column will be now
EHPMProjectCustomColumnsColumnFlag_UpdateDate_OnCompleted
When changing status of the task to Complete and this flag is set on a date or date time custom column, the value for the custom column will be now
EHPMProjectCustomColumnsColumnFlag_UpdateDate_OnBlocked
When changing status of the task to Blocked and this flag is set on a date or date time custom column, the value for the custom column will be now
EHPMProjectCustomColumnsColumnFlag_UpdateDate_OnToBeDeleted
When changing status of the task to ToBeDeleted and this flag is set on a date or date time custom column, the value for the custom column will be now
EHPMProjectCustomColumnsColumnFlag_UpdateDate_OnCommited
When commit task from QA/Backlog to Planning and this flag is set on a date or date time custom column, the value for the custom column will be now
EHPMProjectCustomColumnsColumnFlag_UpdateDate_SetFirstTime
If this flag is set, automatic change will be applied to the date column only if the date column is clear and will not if the date column has any value.
See Also
EHPMProjectCustomColumnsColumnAccessRights
Access rights used for HPMProjectCustomColumnsColumn::m_AccessRights
enum EHPMProjectCustomColumnsColumnAccessRights {
EHPMProjectCustomColumnsColumnAccessRights_NewVersionOfSDKRequired = 0,
EHPMProjectCustomColumnsColumnAccessRights_AllProjectMembers = 1,
EHPMProjectCustomColumnsColumnAccessRights_ReadOnly = 2,
};
Values
EHPMProjectCustomColumnsColumnAccessRights_NewVersionOfSDKRequired
The access right type did not exist when this SDK was created. Upgrade to a newer version of the SDK to be able to use this format.
EHPMProjectCustomColumnsColumnAccessRights_AllProjectMembers
All project members have access to the custom column.
EHPMProjectCustomColumnsColumnAccessRights_ReadOnly
No resources have access to change this value. Only the SDK can change it.
See Also
EHPMProjectCustomColumnsColumnType
Column types used for HPMProjectCustomColumnsColumn::m_Type
enum EHPMProjectCustomColumnsColumnType {
EHPMProjectCustomColumnsColumnType_NewVersionOfSDKRequired = 0,
EHPMProjectCustomColumnsColumnType_Text = 1,
EHPMProjectCustomColumnsColumnType_Hyperlink = 2,
EHPMProjectCustomColumnsColumnType_DropList = 3,
EHPMProjectCustomColumnsColumnType_IntegerNumber = 4,
EHPMProjectCustomColumnsColumnType_FloatNumber = 5,
EHPMProjectCustomColumnsColumnType_DateTime = 6,
EHPMProjectCustomColumnsColumnType_MultiLineText = 7,
EHPMProjectCustomColumnsColumnType_Resources = 8,
EHPMProjectCustomColumnsColumnType_AccumulatedTime = 9,
EHPMProjectCustomColumnsColumnType_MultiSelectionDropList = 10,
EHPMProjectCustomColumnsColumnType_DateTimeWithTime = 11,
EHPMProjectCustomColumnsColumnType_Function = 12,
};
Values
EHPMProjectCustomColumnsColumnType_NewVersionOfSDKRequired
The custom column type did not exist when this SDK was created. Upgrade to a newer version of the SDK to be able to use this format.
EHPMProjectCustomColumnsColumnType_Text
Text column type.
EHPMProjectCustomColumnsColumnType_Hyperlink
Hyper link column type.
EHPMProjectCustomColumnsColumnType_DropList
Single selection drop list column type.
EHPMProjectCustomColumnsColumnType_IntegerNumber
Integer number column type.
EHPMProjectCustomColumnsColumnType_FloatNumber
Float number column type.
EHPMProjectCustomColumnsColumnType_DateTime
Date time column type. Custom data of this type will be returned in the Helix Plan internal format. Use UtilDecodeCustomColumnDateTimeValue and UtilEncodeCustomColumnDateTimeValue to get/set the number of micro seconds since 1970 UTC.
EHPMProjectCustomColumnsColumnType_MultiLineText
Multi line text column type.
EHPMProjectCustomColumnsColumnType_Resources
Resources column type. Custom data of this type will be returned as a comma separated list of resource identifiers. Use UtilDecodeCustomColumnResourcesValue and UtilEncodeCustomColumnResourcesValue.
EHPMProjectCustomColumnsColumnType_AccumulatedTime
Accumulated time column type. The data is set as a string representation of an hours based floating point value with three decimals. One hour is set as "1.000"
EHPMProjectCustomColumnsColumnType_MultiSelectionDropList
Multi selection drop list column type.
EHPMProjectCustomColumnsColumnType_DateTimeWithTime
Date time column type that displays time as well as date in the GUI. Custom data of this type will be returned in the Helix Plan internal format. Use UtilDecodeCustomColumnDateTimeValue and UtilEncodeCustomColumnDateTimeValue to get/set the number of micro seconds since 1970 UTC.
EHPMProjectCustomColumnsColumnType_Function
Function column type.
See Also
EHPMProjectFunctionColumnOperator
Operator type for HPMFunctionColumnToken::m_Type
enum EHPMProjectFunctionColumnOperator {
EHPMProjectFunctionColumnOperator_NewVersionOfSDKRequired = 0,
EHPMProjectFunctionColumnOperator_Add = 1,
EHPMProjectFunctionColumnOperator_Subtract = 2,
EHPMProjectFunctionColumnOperator_Multiply = 3,
EHPMProjectFunctionColumnOperator_Divide = 4,
EHPMProjectFunctionColumnOperator_Modulus = 5,
EHPMProjectFunctionColumnOperator_Equal = 6,
EHPMProjectFunctionColumnOperator_NotEqual = 7,
EHPMProjectFunctionColumnOperator_LessThan = 8,
EHPMProjectFunctionColumnOperator_GreaterThan = 9,
EHPMProjectFunctionColumnOperator_LessThanEqual = 10,
EHPMProjectFunctionColumnOperator_GreaterThanEqual = 11,
EHPMProjectFunctionColumnOperator_LogicalNot = 12,
EHPMProjectFunctionColumnOperator_LogicalAnd = 13,
EHPMProjectFunctionColumnOperator_LogicalOr = 14,
EHPMProjectFunctionColumnOperator_TernaryConditional = 15,
EHPMProjectFunctionColumnOperator_TernaryConditionalElse = 16,
EHPMProjectFunctionColumnOperator_UnaryAdd = 17,
EHPMProjectFunctionColumnOperator_UnarySubtract = 18,
};
Values
EHPMProjectFunctionColumnOperator_NewVersionOfSDKRequired
The function column operator did not exist when this SDK was created. Upgrade to a newer version of the SDK to be able to use this enum.
EHPMProjectFunctionColumnOperator_Add
TBD
EHPMProjectFunctionColumnOperator_Subtract
TBD
EHPMProjectFunctionColumnOperator_Multiply
TBD
EHPMProjectFunctionColumnOperator_Divide
TBD
EHPMProjectFunctionColumnOperator_Modulus
TBD
EHPMProjectFunctionColumnOperator_Equal
TBD
EHPMProjectFunctionColumnOperator_NotEqual
TBD
EHPMProjectFunctionColumnOperator_LessThan
TBD
EHPMProjectFunctionColumnOperator_GreaterThan
TBD
EHPMProjectFunctionColumnOperator_LessThanEqual
TBD
EHPMProjectFunctionColumnOperator_GreaterThanEqual
TBD
EHPMProjectFunctionColumnOperator_LogicalNot
TBD
EHPMProjectFunctionColumnOperator_LogicalAnd
TBD
EHPMProjectFunctionColumnOperator_LogicalOr
TBD
EHPMProjectFunctionColumnOperator_TernaryConditional
TBD
EHPMProjectFunctionColumnOperator_TernaryConditionalElse
TBD
EHPMProjectFunctionColumnOperator_UnaryAdd
TBD
EHPMProjectFunctionColumnOperator_UnarySubtract
TBD
See Also
EHPMProjectFunctionColumnFunction
Operator type for HPMFunctionColumnToken::m_Type
enum EHPMProjectFunctionColumnFunction {
EEHPMProjectFunctionColumnFunction_NewVersionOfSDKRequired = 0,
EHPMProjectFunctionColumnFunction_Sum = 1,
EHPMProjectFunctionColumnFunction_Min = 2,
EHPMProjectFunctionColumnFunction_Max = 3,
EHPMProjectFunctionColumnFunction_Abs = 4,
EHPMProjectFunctionColumnFunction_Ceil = 5,
EHPMProjectFunctionColumnFunction_Frac = 6,
EHPMProjectFunctionColumnFunction_Floor = 7,
EHPMProjectFunctionColumnFunction_Sqr = 8,
EHPMProjectFunctionColumnFunction_Sqrt = 9,
EHPMProjectFunctionColumnFunction_Pow = 10,
EHPMProjectFunctionColumnFunction_Log = 11,
EHPMProjectFunctionColumnFunction_Exp = 12,
EHPMProjectFunctionColumnFunction_ExpN = 13,
EHPMProjectFunctionColumnFunction_LogN = 14,
};
Values
EEHPMProjectFunctionColumnFunction_NewVersionOfSDKRequired
The function column function did not exist when this SDK was created. Upgrade to a newer version of the SDK to be able to use this enum.
EHPMProjectFunctionColumnFunction_Sum
TBD
EHPMProjectFunctionColumnFunction_Min
TBD
EHPMProjectFunctionColumnFunction_Max
TBD
EHPMProjectFunctionColumnFunction_Abs
TBD
EHPMProjectFunctionColumnFunction_Ceil
TBD
EHPMProjectFunctionColumnFunction_Frac
TBD
EHPMProjectFunctionColumnFunction_Floor
TBD
EHPMProjectFunctionColumnFunction_Sqr
TBD
EHPMProjectFunctionColumnFunction_Sqrt
TBD
EHPMProjectFunctionColumnFunction_Pow
TBD
EHPMProjectFunctionColumnFunction_Log
TBD
EHPMProjectFunctionColumnFunction_Exp
TBD
EHPMProjectFunctionColumnFunction_ExpN
TBD
EHPMProjectFunctionColumnFunction_LogN
TBD
See Also
EHPMProjectFunctionColumnParenthesis
Parathensis type for HPMFunctionColumnToken
enum EHPMProjectFunctionColumnParenthesis {
EHPMProjectFunctionColumnParenthesis_NewVersionOfSDKRequired = 0,
EHPMProjectFunctionColumnParenthesis_Begin = 1,
EHPMProjectFunctionColumnParenthesis_End = 2,
};
Values
EHPMProjectFunctionColumnParenthesis_NewVersionOfSDKRequired
The function column parenthesis type did not exist when this SDK was created. Upgrade to a newer version of the SDK to be able to use this enum.
EHPMProjectFunctionColumnParenthesis_Begin
TBD
EHPMProjectFunctionColumnParenthesis_End
TBD
See Also
EHPMProjectFunctionColumnToken
Token type for HPMFunctionColumnToken
enum EHPMProjectFunctionColumnToken {
EHPMProjectFunctionColumnToken_NewVersionOfSDKRequired = 0,
EHPMProjectFunctionColumnToken_Operator = 1,
EHPMProjectFunctionColumnToken_Function = 2,
EHPMProjectFunctionColumnToken_Parenthesis = 3,
EHPMProjectFunctionColumnToken_ColumnID = 4,
EHPMProjectFunctionColumnToken_Numeric = 5,
EHPMProjectFunctionColumnToken_Invalid = 6,
};
Values
EHPMProjectFunctionColumnToken_NewVersionOfSDKRequired
The function column token did not exist when this SDK was created. Upgrade to a newer version of the SDK to be able to use this enum.
EHPMProjectFunctionColumnToken_Operator
TBD
EHPMProjectFunctionColumnToken_Function
TBD
EHPMProjectFunctionColumnToken_Parenthesis
TBD
EHPMProjectFunctionColumnToken_ColumnID
TBD
EHPMProjectFunctionColumnToken_Numeric
TBD
EHPMProjectFunctionColumnToken_Invalid
TBD
See Also
EHPMProjectDefaultColumn
Used to specify default columns in HPMProjectDefaultColumns and HPMProjectWorkflowRequiredField.
enum EHPMProjectDefaultColumn {
EHPMProjectDefaultColumn_NewVersionOfSDKRequired = 0,
EHPMProjectDefaultColumn_Risk = 1,
EHPMProjectDefaultColumn_PriorityTag = 2,
EHPMProjectDefaultColumn_EstimatedIdealDays = 3,
EHPMProjectDefaultColumn_BacklogCategory = 4,
EHPMProjectDefaultColumn_ComplexityPoints = 5,
EHPMProjectDefaultColumn_ItemStatus = 6,
EHPMProjectDefaultColumn_MilestoneTag = 7,
EHPMProjectDefaultColumn_Confidence = 8,
EHPMProjectDefaultColumn_Hyperlink = 9,
EHPMProjectDefaultColumn_UserTag = 10,
EHPMProjectDefaultColumn_OriginallyCreatedBy = 11,
EHPMProjectDefaultColumn_ID = 12,
EHPMProjectDefaultColumn_BugStatus = 13,
EHPMProjectDefaultColumn_LastCommented = 14,
EHPMProjectDefaultColumn_LastUpdated = 15,
EHPMProjectDefaultColumn_LastUpdatedBy = 16,
EHPMProjectDefaultColumn_Severity = 17,
EHPMProjectDefaultColumn_LinkedTo = 18,
EHPMProjectDefaultColumn_DatabaseID = 19,
EHPMProjectDefaultColumn_WorkPriority = 20,
EHPMProjectDefaultColumn_ItemName = 21,
EHPMProjectDefaultColumn_Start = 22,
EHPMProjectDefaultColumn_Finish = 23,
EHPMProjectDefaultColumn_Duration = 24,
EHPMProjectDefaultColumn_AssignedTo = 25,
EHPMProjectDefaultColumn_BudgetedWork = 26,
EHPMProjectDefaultColumn_EarnedValue = 27,
EHPMProjectDefaultColumn_Predecessor = 28,
EHPMProjectDefaultColumn_Successor = 29,
EHPMProjectDefaultColumn_WorkRemaining = 30,
EHPMProjectDefaultColumn_CommittedToSprint = 31,
EHPMProjectDefaultColumn_DetailedDescription = 32,
EHPMProjectDefaultColumn_StepsToReproduce = 33,
EHPMProjectDefaultColumn_Comments = 34,
EHPMProjectDefaultColumn_SubProjectPath = 35,
EHPMProjectDefaultColumn_Watch = 36,
EHPMProjectDefaultColumn_PipelineAndWorkflow = 37,
EHPMProjectDefaultColumn_ItemType = 38,
EHPMProjectDefaultColumn_IsOverdue = 39,
EHPMProjectDefaultColumn_IsInProgress = 40,
EHPMProjectDefaultColumn_IsIncomplete = 41,
EHPMProjectDefaultColumn_IsCompleted = 42,
EHPMProjectDefaultColumn_IsNotStartedYet = 43,
EHPMProjectDefaultColumn_IsNotAssigned = 44,
EHPMProjectDefaultColumn_IsMilestoneOverdue = 45,
EHPMProjectDefaultColumn_IsOutOfOfficeTask = 46,
EHPMProjectDefaultColumn_UserStory = 47,
EHPMProjectDefaultColumn_IsAssignedToMe = 48,
EHPMProjectDefaultColumn_IsUserStory = 49,
EHPMProjectDefaultColumn_HasChildren = 50,
EHPMProjectDefaultColumn_HasAssignment = 51,
EHPMProjectDefaultColumn_Project = 52,
EHPMProjectDefaultColumn_LeafSubItems = 53,
EHPMProjectDefaultColumn_SubItems = 54,
EHPMProjectDefaultColumn_ParentSubProjects = 55,
EHPMProjectDefaultColumn_ImmediateSubItems = 56,
EHPMProjectDefaultColumn_ImmediateParentSubProject = 57,
EHPMProjectDefaultColumn_SprintPriority = 58,
EHPMProjectDefaultColumn_BacklogPriority = 59,
EHPMProjectDefaultColumn_BugPriority = 60,
EHPMProjectDefaultColumn_CanStartNow = 61,
EHPMProjectDefaultColumn_IsOngoingWork = 62,
EHPMProjectDefaultColumn_IsArchived = 63,
EHPMProjectDefaultColumn_IsDeleted = 64,
EHPMProjectDefaultColumn_IsOnCriticalPath = 65,
EHPMProjectDefaultColumn_LastLoggedInReadComments = 66,
EHPMProjectDefaultColumn_Status = 67,
EHPMProjectDefaultColumn_OriginallyCreatedOnTime = 68,
EHPMProjectDefaultColumn_WorkflowEnterOnTime = 69,
EHPMProjectDefaultColumn_WorkflowEnterByUser = 70,
EHPMProjectDefaultColumn_Custom = 71,
EHPMProjectDefaultColumn_IsEpic = 72,
EHPMProjectDefaultColumn_BoardLane = 73,
EHPMProjectDefaultColumn_BoardColumn = 74,
EHPMProjectDefaultColumn_WBS = 75,
EHPMProjectDefaultColumn_TreeLevel = 76,
EHPMProjectDefaultColumn_InCurrentSprint = 77,
EHPMProjectDefaultColumn_Color = 78,
};
Values
EHPMProjectDefaultColumn_NewVersionOfSDKRequired
The default column did not exist when this SDK was created. Upgrade to a newer version of the SDK to be able to use this format.
EHPMProjectDefaultColumn_Risk
Risk column.
EHPMProjectDefaultColumn_PriorityTag
Priority tag column.
EHPMProjectDefaultColumn_EstimatedIdealDays
Estimated ideal days column.
EHPMProjectDefaultColumn_BacklogCategory
Backlog category column.
EHPMProjectDefaultColumn_ComplexityPoints
Complexity points column.
EHPMProjectDefaultColumn_ItemStatus
Item status column.
EHPMProjectDefaultColumn_MilestoneTag
Milestone tag column.
EHPMProjectDefaultColumn_Confidence
Confidence column.
EHPMProjectDefaultColumn_Hyperlink
Hyper link column.
EHPMProjectDefaultColumn_UserTag
User tag column.
EHPMProjectDefaultColumn_OriginallyCreatedBy
Originally created/reported by column.
EHPMProjectDefaultColumn_ID
Task or bug ID column that together with the project ID can uniquely identify a task.
EHPMProjectDefaultColumn_BugStatus
Bug status column.
EHPMProjectDefaultColumn_LastCommented
Last commented column.
EHPMProjectDefaultColumn_LastUpdated
Last updated column.
EHPMProjectDefaultColumn_LastUpdatedBy
Last updated user column.
EHPMProjectDefaultColumn_Severity
Severity column.
EHPMProjectDefaultColumn_LinkedTo
Linked to column.
EHPMProjectDefaultColumn_DatabaseID
Database id column.
EHPMProjectDefaultColumn_WorkPriority
Work priority column.
EHPMProjectDefaultColumn_ItemName
Item name column.
EHPMProjectDefaultColumn_Start
Start column.
EHPMProjectDefaultColumn_Finish
Finish column.
EHPMProjectDefaultColumn_Duration
Duration column.
EHPMProjectDefaultColumn_AssignedTo
Assigned to column.
EHPMProjectDefaultColumn_BudgetedWork
Budgeted work column.
EHPMProjectDefaultColumn_EarnedValue
Earned value column.
EHPMProjectDefaultColumn_Predecessor
Predecessor column.
EHPMProjectDefaultColumn_Successor
Successor column.
EHPMProjectDefaultColumn_WorkRemaining
Work remaining column.
EHPMProjectDefaultColumn_CommittedToSprint
Committed to sprint column.
EHPMProjectDefaultColumn_DetailedDescription
Detailed description column.
EHPMProjectDefaultColumn_StepsToReproduce
Steps to reproduce column.
EHPMProjectDefaultColumn_Comments
Comments column.
EHPMProjectDefaultColumn_SubProjectPath
Sub project path column.
EHPMProjectDefaultColumn_Watch
Watch column.
EHPMProjectDefaultColumn_PipelineAndWorkflow
Pipeline and workflow column.
EHPMProjectDefaultColumn_ItemType
Item type column.
EHPMProjectDefaultColumn_IsOverdue
Is overdue column.
EHPMProjectDefaultColumn_IsInProgress
Is in progress column.
EHPMProjectDefaultColumn_IsIncomplete
Is incomplete column.
EHPMProjectDefaultColumn_IsCompleted
Is Completed column.
EHPMProjectDefaultColumn_IsNotStartedYet
Is not started yet column.
EHPMProjectDefaultColumn_IsNotAssigned
Is not assigned column.
EHPMProjectDefaultColumn_IsMilestoneOverdue
Is milestones overdue column.
EHPMProjectDefaultColumn_IsOutOfOfficeTask
Is out of office task column.
EHPMProjectDefaultColumn_UserStory
User story column.
EHPMProjectDefaultColumn_IsAssignedToMe
Is assigned to me column.
EHPMProjectDefaultColumn_IsUserStory
Is user story column.
EHPMProjectDefaultColumn_HasChildren
Has children column.
EHPMProjectDefaultColumn_HasAssignment
Has assignment column.
EHPMProjectDefaultColumn_Project
Project column.
EHPMProjectDefaultColumn_LeafSubItems
Leaf sub items column.
EHPMProjectDefaultColumn_SubItems
Sub items column.
EHPMProjectDefaultColumn_ParentSubProjects
Parent sub projects column.
EHPMProjectDefaultColumn_ImmediateSubItems
Immediate sub items column.
EHPMProjectDefaultColumn_ImmediateParentSubProject
Immediate parent sub projects column.
EHPMProjectDefaultColumn_SprintPriority
The sprint priority column.
EHPMProjectDefaultColumn_BacklogPriority
The backlog priority column.
EHPMProjectDefaultColumn_BugPriority
The bug priority column.
EHPMProjectDefaultColumn_CanStartNow
Is task that can start now column.
EHPMProjectDefaultColumn_IsOngoingWork
Is ongoing work column.
EHPMProjectDefaultColumn_IsArchived
Is archived column.
EHPMProjectDefaultColumn_IsDeleted
Is deleted column.
EHPMProjectDefaultColumn_IsOnCriticalPath
Is on critical path column.
EHPMProjectDefaultColumn_LastLoggedInReadComments
Last read comments column.
EHPMProjectDefaultColumn_Status
Combined item status and workflow status column.
EHPMProjectDefaultColumn_OriginallyCreatedOnTime
Originally created on time column.
EHPMProjectDefaultColumn_WorkflowEnterOnTime
Workflow status set on time column.
EHPMProjectDefaultColumn_WorkflowEnterByUser
Workflow set by user column.
EHPMProjectDefaultColumn_Custom
Custom column
EHPMProjectDefaultColumn_IsEpic
Is epic column.
EHPMProjectDefaultColumn_BoardLane
Board lane
EHPMProjectDefaultColumn_BoardColumn
Board column
EHPMProjectDefaultColumn_WBS
WBS column
EHPMProjectDefaultColumn_TreeLevel
Tree level column
EHPMProjectDefaultColumn_InCurrentSprint
Tasks that are in current sprint.
EHPMProjectDefaultColumn_Color
Color column
See Also
HPMProjectDefaultColumns, HPMProjectWorkflowRequiredField
EHPMProjectField
Project field identifier used in HPMDataHistoryEntry::m_FieldID
enum EHPMProjectField {
EHPMProjectField_NewVersionOfSDKRequired = 0,
EHPMProjectField_CustomColumns = 1,
EHPMProjectField_WorkflowSettings = 2,
EHPMProjectField_CalendarHolidays = 3,
EHPMProjectField_CalendarWorkingDays = 4,
EHPMProjectField_CalendarCustomWorkingDays = 5,
EHPMProjectField_CalendarWorkingHours = 6,
EHPMProjectField_CalendarCustomWorkingHours = 7,
EHPMProjectField_Name = 8,
EHPMProjectField_ArchivedStatus = 9,
EHPMProjectField_ProjectMethod = 10,
EHPMProjectField_CompletionStyle = 11,
EHPMProjectField_AgileTemplate = 12,
EHPMProjectField_OldCustomColumn = 13,
EHPMProjectField_WorkflowsInMainProjectAndBacklog = 14,
EHPMProjectField_OldResource = 15,
EHPMProjectField_DefaultEditorMode = 16,
EHPMProjectField_DefaultActivatedColumns = 17,
EHPMProjectField_CustomColumnAncestry = 18,
EHPMProjectField_UsersCanReportNewBugs = 19,
EHPMProjectField_DefaultQAWorkflow = 20,
EHPMProjectField_ConvertedQAWorkflow = 21,
EHPMProjectField_NameSortValue = 22,
EHPMProjectField_ViewPresets = 23,
EHPMProjectField_DefaultColumnMetaData = 24,
EHPMProjectField_CustomColumnMetaData = 25,
EHPMProjectField_FunctionColumnExpression = 26,
};
Values
EHPMProjectField_NewVersionOfSDKRequired
The project field did not exist when this SDK was created. Upgrade to a newer version of the SDK to be able to use this format.
EHPMProjectField_CustomColumns
The custom columns of project.
EHPMProjectField_WorkflowSettings
The workflow settings of project.
EHPMProjectField_CalendarHolidays
The holidays set in project.
EHPMProjectField_CalendarWorkingDays
The working days set in project.
EHPMProjectField_CalendarCustomWorkingDays
The custom working days set in project.
EHPMProjectField_CalendarWorkingHours
The working hours set in project.
EHPMProjectField_CalendarCustomWorkingHours
The custom working hours set in project.
EHPMProjectField_Name
The name of project.
EHPMProjectField_ArchivedStatus
The archived status of project.
EHPMProjectField_ProjectMethod
The project method of project.
EHPMProjectField_CompletionStyle
The completion style of project.
EHPMProjectField_AgileTemplate
The agile template of project.
EHPMProjectField_OldCustomColumn
Old custom column of project.
EHPMProjectField_WorkflowsInMainProjectAndBacklog
The workflows enabled flag of project.
EHPMProjectField_OldResource
Old resource member of project.
EHPMProjectField_DefaultEditorMode
The default editor mode of project.
EHPMProjectField_DefaultActivatedColumns
The default activated columns of project.
EHPMProjectField_CustomColumnAncestry
The ancestry for a custom column
EHPMProjectField_UsersCanReportNewBugs
The users that can report bugs.
EHPMProjectField_DefaultQAWorkflow
The default QA workflow.
EHPMProjectField_ConvertedQAWorkflow
The old converted QA workflow.
EHPMProjectField_NameSortValue
The sorting name of project.
EHPMProjectField_ViewPresets
User view presets.
EHPMProjectField_DefaultColumnMetaData
The meta data for a default column. HPMDataHistoryEntry::m_FieldData is EHPMProjectDefaultColumn
EHPMProjectField_CustomColumnMetaData
The meta data for a custom column. HPMDataHistoryEntry::m_FieldData is custom column hash
EHPMProjectField_FunctionColumnExpression
The expression for a function column.
See Also
EHPMProjectDefaultField
Default fields used to specify fields that are not columns in HPMProjectWorkflowRequiredField.
enum EHPMProjectDefaultField {
EHPMProjectDefaultField_NewVersionOfSDKRequired = 0,
EHPMProjectDefaultField_Comment = 1,
EHPMProjectDefaultField_DetailedDescription = 2,
EHPMProjectDefaultField_StepsToReproduce = 3,
};
Values
EHPMProjectDefaultField_NewVersionOfSDKRequired
The default column did not exist when this SDK was created. Upgrade to a newer version of the SDK to be able to use this format.
EHPMProjectDefaultField_Comment
Comment field.
EHPMProjectDefaultField_DetailedDescription
Detailed description field.
EHPMProjectDefaultField_StepsToReproduce
Steps to reproduce field.
See Also
HPMProjectWorkflowRequiredField
EHPMProjectResourceFlag
Flags to specify for HPMProjectResourceProperties::m_Flags
enum EHPMProjectResourceFlag {
EHPMProjectResourceFlag_None = 0,
EHPMProjectResourceFlag_IsMainProjectManager = 1,
EHPMProjectResourceFlag_LimitedVisibility = 2,
EHPMProjectResourceFlag_CanAccessProjectHistory = 4,
};
Values
EHPMProjectResourceFlag_None
TBD
EHPMProjectResourceFlag_IsMainProjectManager
The project resource is a main project manager for this project. Can not be combined with EHPMProjectResourceFlag_LimitedVisibility.
EHPMProjectResourceFlag_LimitedVisibility
The project resource has limited visibility in this project. Can not be combined with EHPMProjectResourceFlag_IsMainProjectManager.
EHPMProjectResourceFlag_CanAccessProjectHistory
The project resource can access the project history for this project.
See Also
EHPMProjectMethod
Project methods used for HPMProjectProperties::m_ProjectMethod
enum EHPMProjectMethod {
EHPMProjectMethod_NewVersionOfSDKRequired = 0,
EHPMProjectMethod_FixedDuration = 1,
EHPMProjectMethod_FixedWork = 2,
};
Values
EHPMProjectMethod_NewVersionOfSDKRequired
The project method did not exist when this SDK was created. Upgrade to a newer version of the SDK to be able to use this format.
EHPMProjectMethod_FixedDuration
Fixed duration planning method.
EHPMProjectMethod_FixedWork
Fixed work planning method.
See Also
EHPMProjectTaskCompletionStyle
Completion styles used for HPMProjectProperties::m_CompletionStyle and ProjectGetCompletionStyle
enum EHPMProjectTaskCompletionStyle {
EHPMProjectTaskCompletionStyle_NewVersionOfSDKRequired = 0,
EHPMProjectTaskCompletionStyle_Auto = 1,
EHPMProjectTaskCompletionStyle_Binary = 2,
EHPMProjectTaskCompletionStyle_Percent = 3,
};
Values
EHPMProjectTaskCompletionStyle_NewVersionOfSDKRequired
The completion style did not exist when this SDK was created. Upgrade to a newer version of the SDK to be able to use this format.
EHPMProjectTaskCompletionStyle_Auto
The completion style is determined by the project method
EHPMProjectTaskCompletionStyle_Binary
Binary completion style lets resources set tasks to be either done or not done.
EHPMProjectTaskCompletionStyle_Percent
Percent completion style lets resources set the number of percent of a task is completed.
See Also
HPMProjectProperties, ProjectGetCompletionStyle
EHPMProjectDefaultEditorMode
Default editor mode used for HPMProjectProperties::m_DefaultEditorMode
enum EHPMProjectDefaultEditorMode {
EHPMProjectDefaultEditorMode_NewVersionOfSDKRequired = 0,
EHPMProjectDefaultEditorMode_TaskScheduling = 1,
EHPMProjectDefaultEditorMode_Agile = 2,
};
Values
EHPMProjectDefaultEditorMode_NewVersionOfSDKRequired
The editor mode did not exist when this SDK was created. Upgrade to a newer version of the SDK to be able to use this format.
EHPMProjectDefaultEditorMode_TaskScheduling
Task scheduling is the default editor method.
EHPMProjectDefaultEditorMode_Agile
Agile scheduling is the default editor method.
See Also
EHPMProjectAgileTemplate
Agile template used for HPMProjectProperties::m_AgileTemplate
enum EHPMProjectAgileTemplate {
EHPMProjectAgileTemplate_NewVersionOfSDKRequired = 0,
EHPMProjectAgileTemplate_SCRUM = 1,
EHPMProjectAgileTemplate_XP = 2,
EHPMProjectAgileTemplate_Custom = 3,
EHPMProjectAgileTemplate_Lean = 4,
EHPMProjectAgileTemplate_Custom2 = 5,
EHPMProjectAgileTemplate_Custom3 = 6,
EHPMProjectAgileTemplate_Custom4 = 7,
EHPMProjectAgileTemplate_Custom5 = 8,
};
Values
EHPMProjectAgileTemplate_NewVersionOfSDKRequired
The agile template did not exist when this SDK was created. Upgrade to a newer version of the SDK to be able to use this format.
EHPMProjectAgileTemplate_SCRUM
SCRUM agile template.
EHPMProjectAgileTemplate_XP
Extreme programming agile template.
EHPMProjectAgileTemplate_Custom
Custom agile template.
EHPMProjectAgileTemplate_Lean
Lean agile template.
EHPMProjectAgileTemplate_Custom2
Custom agile template #2.
EHPMProjectAgileTemplate_Custom3
Custom agile template #3.
EHPMProjectAgileTemplate_Custom4
Custom agile template #4.
EHPMProjectAgileTemplate_Custom5
Custom agile template #5.
See Also
EHPMProjectWorkflowObjectType
Workflow object type used for HPMProjectWorkflowObject::m_ObjectType
enum EHPMProjectWorkflowObjectType {
EHPMProjectWorkflowObjectType_NewVersionOfSDKRequired = 0,
EHPMProjectWorkflowObjectType_WorkflowStatus = 1,
EHPMProjectWorkflowObjectType_Transition = 2,
EHPMProjectWorkflowObjectType_EntryStatus = 3,
EHPMProjectWorkflowObjectType_WorkflowReference = 4,
};
Values
EHPMProjectWorkflowObjectType_NewVersionOfSDKRequired
The object type did not exist when this SDK was created. Upgrade to a newer version of the SDK to be able to use this object type.
EHPMProjectWorkflowObjectType_WorkflowStatus
Workflow status object type.
EHPMProjectWorkflowObjectType_Transition
Transition object type.
EHPMProjectWorkflowObjectType_EntryStatus
Entry status object type.
EHPMProjectWorkflowObjectType_WorkflowReference
Workflow reference object type.
See Also
EHPMProjectWorkflowObjectFlag
Workflow object flag used for HPMProjectWorkflowObject::m_Flags
enum EHPMProjectWorkflowObjectFlag {
EHPMProjectWorkflowObjectFlag_None = 0,
EHPMProjectWorkflowObjectFlag_WorkflowStatus_RemoveResourcesWhenReachingThisStatus = 4,
EHPMProjectWorkflowObjectFlag_WorkflowStatus_AssignToOriginalReporterWhenReachingThisStatus = 16,
EHPMProjectWorkflowObjectFlag_WorkflowStatus_DontAllowNoResourcesAssigned = 32,
EHPMProjectWorkflowObjectFlag_WorkflowStatus_UnpublishedStatus = 64,
EHPMProjectWorkflowObjectFlag_Transition_ResourcesCanEditAllFieldsThatMustBeSetForThisTransition = 128,
EHPMProjectWorkflowObjectFlag_WorkflowStatus_SetWorkRemainingToZeroWhenReachingThisWorkflowStatus = 256,
EHPMProjectWorkflowObjectFlag_WorkflowStatus_ActionsAreEnabledOnPreviousStatus = 512,
EHPMProjectWorkflowObjectFlag_WorkflowStatus_ResourcesCanSelectWorkflowOnPipelineTask = 1024,
EHPMProjectWorkflowObjectFlag_WorkflowStatus_LetResourcesBreakdownPipelineTask = 2048,
EHPMProjectWorkflowObjectFlag_WorkflowStatus_WorkflowOfChildrenIsSequential = 4096,
EHPMProjectWorkflowObjectFlag_WorkflowStatus_AssignToResourcesAssignedInWorkflowStatus = 8192,
EHPMProjectWorkflowObjectFlag_WorkflowStatus_HideInMyWork = 16384,
};
Values
EHPMProjectWorkflowObjectFlag_None
TBD
EHPMProjectWorkflowObjectFlag_WorkflowStatus_RemoveResourcesWhenReachingThisStatus
Only valid when workflow object is a workflow status. When this flag is set resources are unassigned when the specific status is reached.
EHPMProjectWorkflowObjectFlag_WorkflowStatus_AssignToOriginalReporterWhenReachingThisStatus
Only valid when workflow object is a workflow status. When this flag is set the bug/task is assigned to the original reporter when reaching the specific status.
EHPMProjectWorkflowObjectFlag_WorkflowStatus_DontAllowNoResourcesAssigned
Only valid when workflow object is a workflow status. When this flag is set it is not allowed to have no resources assigned in this specific status.
EHPMProjectWorkflowObjectFlag_WorkflowStatus_UnpublishedStatus
Only valid when workflow object is a workflow status. When this flag is set the bug is unpublished in this specific status and will only show up on the bug list of the original reporter.
EHPMProjectWorkflowObjectFlag_Transition_ResourcesCanEditAllFieldsThatMustBeSetForThisTransition
Only valid when workflow object is a transition. When this flag is set resources that are able to go through a transition are also able to edit the columns that are required to be set by the transition.
EHPMProjectWorkflowObjectFlag_WorkflowStatus_SetWorkRemainingToZeroWhenReachingThisWorkflowStatus
Only valid when workflow object is a workflow status. When this flag is set the work remaining for an item is set to 0 when this status is reached.
EHPMProjectWorkflowObjectFlag_WorkflowStatus_ActionsAreEnabledOnPreviousStatus
Only valid when workflow object is a workflow status in QA. When this flag is set the selected actions are enabled on the previous status.
EHPMProjectWorkflowObjectFlag_WorkflowStatus_ResourcesCanSelectWorkflowOnPipelineTask
Only valid when workflow object is a workflow status. When this flag is set resources are able to select a workflow for a task generated from the pipeline.
EHPMProjectWorkflowObjectFlag_WorkflowStatus_LetResourcesBreakdownPipelineTask
Only valid when workflow object is a workflow status. When this flag is set resources are able to breakdown pipeline tasks into sub tasks.
EHPMProjectWorkflowObjectFlag_WorkflowStatus_WorkflowOfChildrenIsSequential
Only valid when workflow object is a workflow status. When this flag is set there are sequential workflows under this status.
EHPMProjectWorkflowObjectFlag_WorkflowStatus_AssignToResourcesAssignedInWorkflowStatus
Only valid when workflow object is a workflow status. When this flag is set the bug/task is assigned to resources that where assigned in a specific status.
EHPMProjectWorkflowObjectFlag_WorkflowStatus_HideInMyWork
Only valid when workflow object is a workflow status. When this flag is set the status is hidden in My work.
See Also
EHPMProjectWorkflowContainerFlag
Workflow container flag used for HPMProjectWorkflowSettings::m_Flags
enum EHPMProjectWorkflowContainerFlag {
EHPMProjectWorkflowContainerFlag_None = 0,
EHPMProjectWorkflowContainerFlag_PipelineTasksMustBeCompletedInSequentialOrder = 1,
EHPMProjectWorkflowContainerFlag_IsDeleted = 2,
EHPMProjectWorkflowContainerFlag_ShowInQA = 4,
EHPMProjectWorkflowContainerFlag_ShowInPlanning = 8,
EHPMProjectWorkflowContainerFlag_HideItemStatus = 16,
};
Values
EHPMProjectWorkflowContainerFlag_None
TBD
EHPMProjectWorkflowContainerFlag_PipelineTasksMustBeCompletedInSequentialOrder
When this flag is set the pipeline tasks must be completed in a sequential order.
EHPMProjectWorkflowContainerFlag_IsDeleted
This workflow has been deleted.
EHPMProjectWorkflowContainerFlag_ShowInQA
This workflow is shown in the QA section.
EHPMProjectWorkflowContainerFlag_ShowInPlanning
This workflow is shown in the planning section.
EHPMProjectWorkflowContainerFlag_HideItemStatus
When this flag is set the item status will be hidden from the user in the client.
See Also
EHPMProjectWorkflowConnectionSite
QA workflow connection site used for HPMProjectWorkflowConnection::m_ConnectionFrom and HPMProjectWorkflowConnection::m_ConnectionTo
enum EHPMProjectWorkflowConnectionSite {
EHPMProjectWorkflowConnectionSite_NewVersionOfSDKRequired = 0,
EHPMProjectWorkflowConnectionSite_Top = 1,
EHPMProjectWorkflowConnectionSite_Bottom = 2,
};
Values
EHPMProjectWorkflowConnectionSite_NewVersionOfSDKRequired
The connection site did not exist when this SDK was created. Upgrade to a newer version of the SDK to be able to use this connection site.
EHPMProjectWorkflowConnectionSite_Top
The connection is to/from the top connection site of the object box.
EHPMProjectWorkflowConnectionSite_Bottom
The connection is to/from the bottom connection site of the object box.
See Also
EHPMProjectWorkflowRequiredFieldType
QA workflow required field type used for HPMProjectWorkflowRequiredField::m_Type.
enum EHPMProjectWorkflowRequiredFieldType {
EHPMProjectWorkflowRequiredFieldType_NewVersionOfSDKRequired = 0,
EHPMProjectWorkflowRequiredFieldType_DefaultColumn = 1,
EHPMProjectWorkflowRequiredFieldType_DefaultField = 2,
EHPMProjectWorkflowRequiredFieldType_CustomColumn = 3,
EHPMProjectWorkflowRequiredFieldType_EnableAction = 4,
};
Values
EHPMProjectWorkflowRequiredFieldType_NewVersionOfSDKRequired
The field type did not exist when this SDK was created. Upgrade to a newer version of the SDK to be able to use this field type.
EHPMProjectWorkflowRequiredFieldType_DefaultColumn
The specified field is one of the EHPMProjectDefaultColumn enum.
EHPMProjectWorkflowRequiredFieldType_DefaultField
The specified field is one of the EHPMProjectDefaultField enum.
EHPMProjectWorkflowRequiredFieldType_CustomColumn
The specified field is a custom column.
EHPMProjectWorkflowRequiredFieldType_EnableAction
The specified field enables an action on a previous workflow object if set on a transition. The specified field is one of EHPMProjectDetailedAccessRuleFunctionType.
See Also
HPMProjectWorkflowRequiredField
EHPMProjectSprintPredictionMethod
Sprint prediction method used for HPMProjectSettings::m_SprintPredictionMethod.
enum EHPMProjectSprintPredictionMethod {
EHPMProjectSprintPredictionMethod_NewVersionOfSDKRequired = 0,
EHPMProjectSprintPredictionMethod_5Days_WeightedAverage = 1,
EHPMProjectSprintPredictionMethod_3Days_WeightedAverage = 2,
EHPMProjectSprintPredictionMethod_7Days_WeightedAverage = 3,
EHPMProjectSprintPredictionMethod_10Days_WeightedAverage = 4,
EHPMProjectSprintPredictionMethod_14Days_WeightedAverage = 5,
EHPMProjectSprintPredictionMethod_NoPrediction = 6,
};
Values
EHPMProjectSprintPredictionMethod_NewVersionOfSDKRequired
The prediction method did not exist when this SDK was created. Upgrade to a newer version of the SDK to be able to use this prediction method.
EHPMProjectSprintPredictionMethod_5Days_WeightedAverage
Five days weighted average.
EHPMProjectSprintPredictionMethod_3Days_WeightedAverage
Three days weighted average.
EHPMProjectSprintPredictionMethod_7Days_WeightedAverage
Seven days weighted average.
EHPMProjectSprintPredictionMethod_10Days_WeightedAverage
Ten days weighted average.
EHPMProjectSprintPredictionMethod_14Days_WeightedAverage
Fourteen days weighted average.
EHPMProjectSprintPredictionMethod_NoPrediction
No prediction.
See Also
EHPMProjectWallSettingsFlags
Wall settings flags used for HPMProjectWallSettings::m_Flags
enum EHPMProjectWallSettingsFlags {
EHPMProjectWallSettingsFlags_None = 0,
EHPMProjectWallSettingsFlags_ShowTaskDescription = 1,
EHPMProjectWallSettingsFlags_ShowTaskUserStory = 2,
EHPMProjectWallSettingsFlags_ShowSubProjectPath = 4,
EHPMProjectWallSettingsFlags_ShowTaskCommentText = 8,
EHPMProjectWallSettingsFlags_ShowGroupEstimatedIdealDays = 16,
EHPMProjectWallSettingsFlags_ShowGroupComplexityPoints = 32,
EHPMProjectWallSettingsFlags_ShowGroupWorkRemaining = 64,
};
Values
EHPMProjectWallSettingsFlags_None
TBD
EHPMProjectWallSettingsFlags_ShowTaskDescription
Show the description of the task on the wall.
EHPMProjectWallSettingsFlags_ShowTaskUserStory
Show the user story of the task on the wall.
EHPMProjectWallSettingsFlags_ShowSubProjectPath
Show the sub project path description of the task on the wall.
EHPMProjectWallSettingsFlags_ShowTaskCommentText
Show the comment text of the task on the wall.
EHPMProjectWallSettingsFlags_ShowGroupEstimatedIdealDays
Show the summed estimated ideal days of the group on the wall.
EHPMProjectWallSettingsFlags_ShowGroupComplexityPoints
Show the summed complexity points of the group on the wall
EHPMProjectWallSettingsFlags_ShowGroupWorkRemaining
Show the summed work remaining of the group on the wall.
See Also
EHPMProjectDetailedAccessRuleType
Rule type used for HPMProjectDetailedAccessRule::m_RuleType
enum EHPMProjectDetailedAccessRuleType {
EHPMProjectDetailedAccessRuleType_NewVersionOfSDKRequired = 0,
EHPMProjectDetailedAccessRuleType_GiveAccess = 1,
EHPMProjectDetailedAccessRuleType_RestrictAccess = 2,
EHPMProjectDetailedAccessRuleType_Hide = 3,
};
Values
EHPMProjectDetailedAccessRuleType_NewVersionOfSDKRequired
The rule type did not exist when this SDK was created. Upgrade to a newer version of the SDK to be able to use this rule type.
EHPMProjectDetailedAccessRuleType_GiveAccess
The rule gives access to resources.
EHPMProjectDetailedAccessRuleType_RestrictAccess
The rule restricts access for resources.
EHPMProjectDetailedAccessRuleType_Hide
The rule hides tasks for resources.
See Also
EHPMProjectDetailedAccessRuleFunctionType
Access function type used for HPMProjectDetailedAccessRuleFunction::m_FunctionType
enum EHPMProjectDetailedAccessRuleFunctionType {
EHPMProjectDetailedAccessRuleFunctionType_NewVersionOfSDKRequired = 0,
EHPMProjectDetailedAccessRuleFunctionType_DefalutColumn = 1,
EHPMProjectDetailedAccessRuleFunctionType_CustomColumn = 2,
EHPMProjectDetailedAccessRuleFunctionType_TaskField = 3,
EHPMProjectDetailedAccessRuleFunctionType_ChangeAttachments = 4,
EHPMProjectDetailedAccessRuleFunctionType_DeleteTask = 5,
EHPMProjectDetailedAccessRuleFunctionType_CustomizeQAWorkflow = 6,
EHPMProjectDetailedAccessRuleFunctionType_ExportProjectData = 7,
EHPMProjectDetailedAccessRuleFunctionType_ImportProjectData = 8,
EHPMProjectDetailedAccessRuleFunctionType_ChangeProjectColumnConfig = 9,
EHPMProjectDetailedAccessRuleFunctionType_ChangeProjectEmailConfig = 10,
EHPMProjectDetailedAccessRuleFunctionType_UseScreenshotTool = 11,
EHPMProjectDetailedAccessRuleFunctionType_ShareReports = 12,
EHPMProjectDetailedAccessRuleFunctionType_OverrideWorkflow = 13,
EHPMProjectDetailedAccessRuleFunctionType_EditOtherUsersReports = 14,
};
Values
EHPMProjectDetailedAccessRuleFunctionType_NewVersionOfSDKRequired
The function type did not exist when this SDK was created. Upgrade to a newer version of the SDK to be able to use this function type.
EHPMProjectDetailedAccessRuleFunctionType_DefalutColumn
Default column function type. See comments section of HPMProjectDetailedAccessRuleFunction.
EHPMProjectDetailedAccessRuleFunctionType_CustomColumn
Custom column function type. See comments section of HPMProjectDetailedAccessRuleFunction.
EHPMProjectDetailedAccessRuleFunctionType_TaskField
Task field function type. See comments section of HPMProjectDetailedAccessRuleFunction.
EHPMProjectDetailedAccessRuleFunctionType_ChangeAttachments
The function of adding/deleting/editing attachments is granted/restricted to/from resource.
EHPMProjectDetailedAccessRuleFunctionType_DeleteTask
The function of deleting tasks is granted/restricted to/from resource.
EHPMProjectDetailedAccessRuleFunctionType_CustomizeQAWorkflow
The function of customizing the QA workflow is granted/restricted to/from resource.
EHPMProjectDetailedAccessRuleFunctionType_ExportProjectData
The function of exporting project data is granted/restricted to/from resource.
EHPMProjectDetailedAccessRuleFunctionType_ImportProjectData
The function of importing project data is granted/restricted to/from resource.
EHPMProjectDetailedAccessRuleFunctionType_ChangeProjectColumnConfig
The function of changing the project column configuration is granted/restricted to/from resource.
EHPMProjectDetailedAccessRuleFunctionType_ChangeProjectEmailConfig
The function of changing the project email configuration is granted/restricted to/from resource.
EHPMProjectDetailedAccessRuleFunctionType_UseScreenshotTool
The function of using the screenshot tool is granted/restricted to/from resource.
EHPMProjectDetailedAccessRuleFunctionType_ShareReports
The function of sharing reports is granted/restricted to/from resource.
EHPMProjectDetailedAccessRuleFunctionType_OverrideWorkflow
The function of overriding a workflow is granted/restricted to/from resource.
EHPMProjectDetailedAccessRuleFunctionType_EditOtherUsersReports
The function of editing other user's reports granted/restricted to/from resource.
See Also
HPMProjectDetailedAccessRuleFunction
EHPMProjectColumnResourcePermission
Permission type used for HPMResourcePermissionDefinition::m_Permission
enum EHPMProjectColumnResourcePermission {
EHPMProjectColumnResourcePermission_NewVersionOfSDKRequired = 0,
EHPMProjectColumnResourcePermission_Default = 1,
EHPMProjectColumnResourcePermission_ReadOnly = 2,
EHPMProjectColumnResourcePermission_ReadWrite = 3,
EHPMProjectColumnResourcePermission_Hide = 4,
};
Values
EHPMProjectColumnResourcePermission_NewVersionOfSDKRequired
The permission did not exist when this SDK was created. Upgrade to a newer version of the SDK to be able to use this type.
EHPMProjectColumnResourcePermission_Default
The rule applies default edit where delegated permission.
EHPMProjectColumnResourcePermission_ReadOnly
The rule overrides default edit where delegated permission, and makes the column read only.
EHPMProjectColumnResourcePermission_ReadWrite
The rule overrides default edit where delegated permission, and makes the column editable.
EHPMProjectColumnResourcePermission_Hide
The rule hides the column.
See Also
HPMProjectColumnResourcePermissionRule
EHPMWorkflowType
Workflow type used for HPMProjectWorkflowSettings::m_WorkflowType
enum EHPMWorkflowType {
EHPMWorkflowType_NewVersionOfSDKRequired = 0,
EHPMWorkflowType_Workflow = 1,
EHPMWorkflowType_Pipeline = 2,
};
Values
EHPMWorkflowType_NewVersionOfSDKRequired
The workflow type did not exist when this SDK was created. Upgrade to a newer version of the SDK to be able to use this workflow type.
EHPMWorkflowType_Workflow
The workflow is a normal linear workflow where only one step of the workflow can be active at once.
EHPMWorkflowType_Pipeline
The workflow is of the pipeline type where several steps in the workflow can be active at once.
See Also
EHPMProjectWorkflowEnumWorkflowType
Workflow enum type used for HPMProjectWorkflowEnumWorkflowProperties::m_WorkflowEnumWorkflowType
enum EHPMProjectWorkflowEnumWorkflowType {
EHPMProjectWorkflowEnumWorkflowType_OldVersions = 0,
EHPMProjectWorkflowEnumWorkflowType_Dependencies = 1,
EHPMProjectWorkflowEnumWorkflowType_Dependents = 2,
EHPMProjectWorkflowEnumWorkflowType_DependentsOfNewestVersion = 3,
EHPMProjectWorkflowEnumWorkflowType_DependentsOfAllVersions = 4,
EHPMProjectWorkflowEnumWorkflowType_DependentsOfNewestVersion_OnlyReturnNewest = 5,
EHPMProjectWorkflowEnumWorkflowType_DependentsOfAllVersions_OnlyReturnNewest = 6,
};
Values
EHPMProjectWorkflowEnumWorkflowType_OldVersions
The workflow enum contains all old versions of a given workflow.
EHPMProjectWorkflowEnumWorkflowType_Dependencies
The workflow enum contains all workflows the given workflow are dependent on.
EHPMProjectWorkflowEnumWorkflowType_Dependents
The workflow enum contains all workflows that are directly dependent on the given workflow.
EHPMProjectWorkflowEnumWorkflowType_DependentsOfNewestVersion
The workflow enum contains all workflows that are dependent, directly or indirectly, on the start workflow. All versions of the dependent workflows will be returned. Only the given start workflow will be used to find dependents.
EHPMProjectWorkflowEnumWorkflowType_DependentsOfAllVersions
The workflow enum contains all workflows that are dependent, directly or indirectly, on the start workflow. All versions of the dependent workflows will be returned. All versions of the start workflow will be used to find dependents.
EHPMProjectWorkflowEnumWorkflowType_DependentsOfNewestVersion_OnlyReturnNewest
The workflow enum contains all workflows that are dependent, directly or indirectly, on the start workflow. Only the newest versions of the dependent workflows will be returned. Only the given start workflow will be used to find dependents.
EHPMProjectWorkflowEnumWorkflowType_DependentsOfAllVersions_OnlyReturnNewest
The workflow enum contains all workflows that are dependent, directly or indirectly, on the start workflow. Only the newest versions of the dependent workflows will be returned. All versions of the start workflow will be used to find dependents.
See Also
HPMProjectWorkflowEnumWorkflowProperties, ProjectWorkflowEnumWorkflow.
EHPMProjectWorkflowEnumObjectType
Workflow enum type used for HPMProjectWorkflowEnumObjectProperties::m_WorkflowEnumObjectType
enum EHPMProjectWorkflowEnumObjectType {
EHPMProjectWorkflowEnumObjectType_Dependencies = 0,
EHPMProjectWorkflowEnumObjectType_Dependents = 1,
};
Values
EHPMProjectWorkflowEnumObjectType_Dependencies
The workflow object enum contains all workflow objects the given workflow and workflow object are dependent on.
EHPMProjectWorkflowEnumObjectType_Dependents
The workflow object enum contains all workflow objects that are directly dependent on the given workflow and workflow object.
See Also
HPMProjectWorkflowEnumObjectProperties, ProjectWorkflowEnumObject.
EHPMWorkflowReturnType
Workflow return type used for UtilGetWorkflowIDFromName
enum EHPMWorkflowReturnType {
EHPMWorkflowReturnType_NewVersionOfSDKRequired = 0,
EHPMWorkflowReturnType_Workflow = 1,
EHPMWorkflowReturnType_Pipeline = 2,
EHPMWorkflowReturnType_Any = 3,
};
Values
EHPMWorkflowReturnType_NewVersionOfSDKRequired
The workflow type did not exist when this SDK was created. Upgrade to a newer version of the SDK to be able to use this workflow type.
EHPMWorkflowReturnType_Workflow
Return only workflows of the workflow type.
EHPMWorkflowReturnType_Pipeline
Return only workflows of the pipeline type.
EHPMWorkflowReturnType_Any
Return any workflow type.
See Also
EHPMProjectPresetShowOptionFlag
Options that can be shown used in HPMProjectViewPreset::m_ShowOptions
enum EHPMProjectPresetShowOptionFlag {
EHPMProjectPresetShowOptionFlag_None = 0,
EHPMProjectPresetShowOptionFlag_Tasks = 1,
EHPMProjectPresetShowOptionFlag_Bugs = 2,
EHPMProjectPresetShowOptionFlag_Completed = 4,
EHPMProjectPresetShowOptionFlag_PipelineTasksThatCannotStart = 8,
EHPMProjectPresetShowOptionFlag_CompletedItemsWithWorkflow = 16,
EHPMProjectPresetShowOptionFlag_TimelineView = 32,
EHPMProjectPresetShowOptionFlag_OngoingAndFutureSprints = 64,
EHPMProjectPresetShowOptionFlag_CommittedToSprint = 128,
EHPMProjectPresetShowOptionFlag_AssignedToMeOnly = 256,
EHPMProjectPresetShowOptionFlag_EditableByMeOnly = 512,
EHPMProjectPresetShowOptionFlag_DetailedDescriptionOrUserStoriesInList = 1024,
EHPMProjectPresetShowOptionFlag_CommentsInList = 2048,
EHPMProjectPresetShowOptionFlag_Archived = 4096,
EHPMProjectPresetShowOptionFlag_FourWeeksScheduling = 8192,
EHPMProjectPresetShowOptionFlag_ShowItemDetailsWindow = 16384,
EHPMProjectPresetShowOptionFlag_ShowAbsolutePriority = 32768,
EHPMProjectPresetShowOptionFlag_ShowPriorityInToDoList = 65536,
EHPMProjectPresetShowOptionFlag_ShowAccumulatedTimeInToDoList = 131072,
EHPMProjectPresetShowOptionFlag_CoverImageInList = 262144,
EHPMProjectPresetShowOptionFlag_HideItemColourInList = 524288,
};
Values
EHPMProjectPresetShowOptionFlag_None
TBD
EHPMProjectPresetShowOptionFlag_Tasks
Show tasks in My Work. At least one of EHPMProjectPresetShowOptionFlag_Tasks or EHPMProjectPresetShowOptionFlag_Bugs must be set.
EHPMProjectPresetShowOptionFlag_Bugs
Show bugs in My Work. At least one of EHPMProjectPresetShowOptionFlag_Tasks or EHPMProjectPresetShowOptionFlag_Bugs must be set.
EHPMProjectPresetShowOptionFlag_Completed
Show completed items.
EHPMProjectPresetShowOptionFlag_PipelineTasksThatCannotStart
Show pipeline tasks that cannot start in My Work.
EHPMProjectPresetShowOptionFlag_CompletedItemsWithWorkflow
Show completed items that have a workflow in My Work.
EHPMProjectPresetShowOptionFlag_TimelineView
Show timeline view in My Work.
EHPMProjectPresetShowOptionFlag_OngoingAndFutureSprints
Show ongoing and future sprints that I'm a member of.
EHPMProjectPresetShowOptionFlag_CommittedToSprint
Show committed to sprint items.
EHPMProjectPresetShowOptionFlag_AssignedToMeOnly
Show assigned to me only.
EHPMProjectPresetShowOptionFlag_EditableByMeOnly
Show editable by me only.
EHPMProjectPresetShowOptionFlag_DetailedDescriptionOrUserStoriesInList
Show detailed or user stories in lists.
EHPMProjectPresetShowOptionFlag_CommentsInList
Show comments in lists.
EHPMProjectPresetShowOptionFlag_Archived
Show archived items.
EHPMProjectPresetShowOptionFlag_FourWeeksScheduling
Show only four weeks of scheduled tasks.
EHPMProjectPresetShowOptionFlag_ShowItemDetailsWindow
Show item details window.
EHPMProjectPresetShowOptionFlag_ShowAbsolutePriority
Show absolute priority in the schedule or backlog list view.
EHPMProjectPresetShowOptionFlag_ShowPriorityInToDoList
Show priority in to do list.
EHPMProjectPresetShowOptionFlag_ShowAccumulatedTimeInToDoList
Show accumulated time in to do list.
EHPMProjectPresetShowOptionFlag_CoverImageInList
Show cover image in lists.
EHPMProjectPresetShowOptionFlag_HideItemColourInList
Hide item colour in lists.
See Also
EHPMProjectUserMessageType
User message type used for ProjectDisplayUserMessage
enum EHPMProjectUserMessageType {
EHPMProjectUserMessageType_NewVersionOfSDKRequired = 0,
EHPMProjectUserMessageType_Error = 1,
EHPMProjectUserMessageType_Warning = 2,
EHPMProjectUserMessageType_Info = 3,
};
Values
EHPMProjectUserMessageType_NewVersionOfSDKRequired
The workflow type did not exist when this SDK was created. Upgrade to a newer version of the SDK to be able to use this workflow type.
EHPMProjectUserMessageType_Error
The workflow is a normal linear workflow where only one step of the workflow can be active at once.
EHPMProjectUserMessageType_Warning
The workflow is of the pipeline type where several steps in the workflow can be active at once.
EHPMProjectUserMessageType_Info
TBD
See Also
EHPMProjectGetDefaultActivatedNonHidableColumnsFlag
Flags for ProjectGetDefaultActivatedNonHidableColumns
enum EHPMProjectGetDefaultActivatedNonHidableColumnsFlag {
EHPMProjectGetDefaultActivatedNonHidableColumnsFlag_None = 0,
EHPMProjectGetDefaultActivatedNonHidableColumnsFlag_ScheduledMode = 1,
EHPMProjectGetDefaultActivatedNonHidableColumnsFlag_AgileMode = 2,
EHPMProjectGetDefaultActivatedNonHidableColumnsFlag_ProjectMode = 4,
};
Values
EHPMProjectGetDefaultActivatedNonHidableColumnsFlag_None
TBD
EHPMProjectGetDefaultActivatedNonHidableColumnsFlag_ScheduledMode
Include columns specific to scheduled mode
EHPMProjectGetDefaultActivatedNonHidableColumnsFlag_AgileMode
Include columns specific to agile mode
EHPMProjectGetDefaultActivatedNonHidableColumnsFlag_ProjectMode
Include columns from agile or scheduled mode depending what is configured as default for the project
See Also
ProjectGetDefaultActivatedNonHidableColumns
EHPMProjectColumnMetaDataFlag
Flags for HPMProjectColumnMetaData
enum EHPMProjectColumnMetaDataFlag {
EHPMProjectColumnMetaDataFlag_None = 0,
EHPMProjectColumnMetaDataFlag_InheritIfNotEmpty = 1,
EHPMProjectColumnMetaDataFlag_InheritAlways = 2,
EHPMProjectColumnMetaDataFlag_InheritFromParent = 4,
EHPMProjectColumnMetaDataFlag_ResourcePermissionsAllowed = 8,
};
Values
EHPMProjectColumnMetaDataFlag_None
TBD
EHPMProjectColumnMetaDataFlag_InheritIfNotEmpty
Tasks created in the client will inherit if the tasks inherited from has a value
EHPMProjectColumnMetaDataFlag_InheritAlways
Tasks created in the client will always inherit from the task inherited from
EHPMProjectColumnMetaDataFlag_InheritFromParent
Tasks created in the client will inherit from the parent. If not set, the tasks will inherit from the previous task.
EHPMProjectColumnMetaDataFlag_ResourcePermissionsAllowed
The column is allowed to have resource permission rules defined for it. See HPMProjectColumnResourcePermissionRules
See Also
EHPMProjectCloneDataFlag
Flags for HPMProjectCloneProperties::m_CloningFlag
enum EHPMProjectCloneDataFlag {
EHPMProjectCloneDataFlag_None = 0,
EHPMProjectCloneDataFlag_CloneUsers = 1,
EHPMProjectCloneDataFlag_CloneColumns = 2,
EHPMProjectCloneDataFlag_CloneReports = 4,
};
Values
EHPMProjectCloneDataFlag_None
TBD
EHPMProjectCloneDataFlag_CloneUsers
Users will be cloned with project
EHPMProjectCloneDataFlag_CloneColumns
Columns will be cloned with project
EHPMProjectCloneDataFlag_CloneReports
Reports will be cloned with project
See Also
EHPMProjectCustomNameType
Agile name type used for ProjectGetCustomName._CustomNameType
enum EHPMProjectCustomNameType {
EHPMProjectCustomNameType_NewVersionOfSDKRequired = 0,
EHPMProjectCustomNameType_Task = 1,
EHPMProjectCustomNameType_Sprint = 2,
EHPMProjectCustomNameType_Release = 3,
EHPMProjectCustomNameType_Backlog = 4,
EHPMProjectCustomNameType_BacklogItem = 5,
EHPMProjectCustomNameType_BacklogItemInSprint = 6,
EHPMProjectCustomNameType_BurndownChart = 7,
EHPMProjectCustomNameType_ProjectPlanning = 8,
EHPMProjectCustomNameType_Epic = 9,
EHPMProjectCustomNameType_Bug = 10,
EHPMProjectCustomNameType_QA = 11,
EHPMProjectCustomNameType_CustomTemplateName = 12,
};
Values
EHPMProjectCustomNameType_NewVersionOfSDKRequired
The agile naming type did not exist when this SDK was created. Upgrade to a newer version of the SDK to be able to use this naming type
EHPMProjectCustomNameType_Task
The name of a scheduled task
EHPMProjectCustomNameType_Sprint
The name of a sprint
EHPMProjectCustomNameType_Release
The name of a release
EHPMProjectCustomNameType_Backlog
The name of the backlog section
EHPMProjectCustomNameType_BacklogItem
The name of a backlog item
EHPMProjectCustomNameType_BacklogItemInSprint
The name of the backlog item in sprint section
EHPMProjectCustomNameType_BurndownChart
The name of a burndown chart
EHPMProjectCustomNameType_ProjectPlanning
The name of the planning section
EHPMProjectCustomNameType_Epic
The name of an epic
EHPMProjectCustomNameType_Bug
The name of a bug
EHPMProjectCustomNameType_QA
The name of the QA section
EHPMProjectCustomNameType_CustomTemplateName
The name of a custom template
See Also
HPMProjectEnum
Used for enumerating projects in a database.
struct HPMProjectEnum {
HPMUInt32 m_nProjects;
const HPMUniqueID * m_pProjects;
} HPMProjectEnum;
Members
m_nProjects
The number of projects in the database.
m_pProjects
Pointer to a list of unique ids pointing to the projects.
See Also
HPMProjectProperties
Used for specifying properties about a project.
struct HPMProjectProperties {
const HPMChar * m_pName;
const HPMChar * m_pNiceName;
const HPMChar * m_pSortName;
HPMUInt32 m_bArchivedStatus;
HPMUInt32 m_ProjectMethod;
HPMUInt32 m_CompletionStyle;
HPMUInt32 m_DefaultEditorMode;
HPMUInt32 m_AgileTemplate;
} HPMProjectProperties;
Members
m_pName
The name of the project.
m_pNiceName
The nice name of the project. A name that is safe to use in the file system. Converted from m_pName internally and is read-only (changes will be ignored by server).
m_pSortName
If set this name is used for sorting instead of the project name.
m_bArchivedStatus
Archived status. Set to 1 to indicate that the project is archived. An archived project is kept in the database but is not synchronized to resources connecting to the database saving network bandwidth and memory on the client.
m_ProjectMethod
The project method used in the project. Can be one of EHPMProjectMethod.
m_CompletionStyle
The completion style used in the project. Can be one of EHPMProjectTaskCompletionStyle.
m_DefaultEditorMode
The default editor mode for the project. Can be one of EHPMProjectDefaultEditorMode.
m_AgileTemplate
The agile template used for the project. Can be one of EHPMProjectAgileTemplate.
See Also
EHPMProjectMethod, EHPMProjectTaskCompletionStyle, EHPMProjectDefaultEditorMode, EHPMProjectAgileTemplate, ProjectCreate, ProjectGetProperties, ProjectSetProperties
HPMProjectSettings
Used for specifying settings for a project.
struct HPMProjectSettings {
HPMUInt32 m_Flags;
HPMUInt32 m_SprintPredictionMethod;
HPMUInt32 m_SprintDefaultLength;
HPMFP64 m_EstimatedHours;
HPMColumn m_ColumnForPriorityInToDoList;
HPMUInt32 m_CustomColumnHashForTimeSpentColumnInToDolist;
HPMUInt32 m_bNewSprintsHaveNoMembers;
HPMUInt32 m_CustomColumnHashForTimeSpentColumnInToDolistQA;
HPMUInt32 m_CustomColumnHashToUpdateWorkRemaining;
} HPMProjectSettings;
Members
m_Flags
The flags set for the project. Can be any combination of EHPMProjectSettingsFlag.
m_SprintPredictionMethod
The sprint prediction method for the project. See EHPMProjectSprintPredictionMethod.
m_SprintDefaultLength
The default number of days a sprint is when it is created.
m_EstimatedHours
The number of estimated hours per day when EHPMProjectSettingsFlag_DisplayIdealEstimateAsHours is set.
m_ColumnForPriorityInToDoList
Column to use for priority in To do list. See HPMColumn.
m_CustomColumnHashForTimeSpentColumnInToDolist
Hash of custom time spent column to use as Time spent column in to do list.
m_bNewSprintsHaveNoMembers
Determines whether new sprints inherit sprint allocations.
m_CustomColumnHashForTimeSpentColumnInToDolistQA
Hash of custom time spent column to use as Time spent column in to do list for bugs.
m_CustomColumnHashToUpdateWorkRemaining
Hash of custom time spent column that will update work remaining.
See Also
ProjectGetSettings, ProjectSetSettings, EHPMProjectSprintPredictionMethod, EHPMProjectSettingsFlag
HPMProjectHistoryAutoSaveSettings
Used for specifying project history auto save settings for a project.
struct HPMProjectHistoryAutoSaveSettings {
HPMUInt32 m_Type;
HPMUInt32 m_DayOfWeek;
HPMUInt32 m_HourOfDay;
} HPMProjectHistoryAutoSaveSettings;
Members
m_Type
. Can be one of EHPMPeriodicityType.
m_DayOfWeek
0 -> 6 = Mon -> Sunday
m_HourOfDay
0 -> 47 (number of half hours from midnight)
See Also
EHPMPeriodicityType, ProjectGetHistoryAutoSaveSettings, ProjectSetHistoryAutoSaveSettings
HPMProjectCustomColumns
Used for specifying the custom columns in a project.
struct HPMProjectCustomColumns {
HPMUInt32 m_nShowingColumns;
const HPMProjectCustomColumnsColumn * m_pShowingColumns;
HPMUInt32 m_nHiddenColumns;
const HPMProjectCustomColumnsColumn * m_pHiddenColumns;
} HPMProjectCustomColumns;
Members
m_nShowingColumns
The number of columns shown in the gantt view.
m_pShowingColumns
Pointer to a list of columns that is shown in the gantt view. See HPMProjectCustomColumnsColumn.
m_nHiddenColumns
The number of columns not shown in the gantt view.
m_pHiddenColumns
Pointer to a list of columns that is not shown in the gantt view. See HPMProjectCustomColumnsColumn.
Comments
The projects has a number of columns that is shown and a number that is hidden. Hidden columns still have their task data retained. You should take care not to have the same column appear twice in either shown or hidden columns.
See Also
HPMProjectCustomColumnsColumn, ProjectCustomColumnsGet
HPMProjectFunctionColumnLocalContext
Used to store a local custom columns context.
struct HPMProjectFunctionColumnLocalContext {
HPMInt32 m_Dummy;
} HPMProjectFunctionColumnLocalContext;
Members
m_Dummy
Dummy variable. Not used
HPMProjectCustomColumnAncestryEntry
Used for specifying a custom column in HPMProjectCustomColumns and UtilGetColumnHash.
struct HPMProjectCustomColumnAncestryEntry {
HPMUInt32 m_Hash;
HPMUInt64 m_UsedUntil;
} HPMProjectCustomColumnAncestryEntry;
Members
m_Hash
The hash of the column. If this custom column no longer exists you can get it with ProjectGetOldCustomColumn
m_UsedUntil
The time at which this custom was renamed to another hash
See Also
HPMProjectCustomColumnAncestry
HPMProjectCustomColumnAncestry
Used for getting a custom columns ancestry in ProjectGetCustomColumnAncestry,
struct HPMProjectCustomColumnAncestry {
HPMUInt32 m_nAncestors;
const HPMProjectCustomColumnAncestryEntry * m_pAncestors;
} HPMProjectCustomColumnAncestry;
Members
m_nAncestors
The number of ancestors for the custom column.
m_pAncestors
Pointer to a list of ancestors for the custom column. See HPMProjectCustomColumnAncestryEntry.
See Also
ProjectGetCustomColumnAncestry
HPMProjectDefaultColumns
Used for specifying the default columns that available in the gantt view.
struct HPMProjectDefaultColumns {
HPMUInt32 m_nColumns;
const HPMUInt32 * m_pColumns;
} HPMProjectDefaultColumns;
Members
m_nColumns
The number of columns.
m_pColumns
Pointer to a list of columns. Every entry can be one of EHPMProjectDefaultColumn. You should make sure to not have two entries with the same default column identifier.
See Also
EHPMProjectDefaultColumn, ProjectGetDefaultActivatedColumns, ProjectSetDefaultActivatedColumns, ProjectGetDefaultActivatedNonHidableColumns, ProjectGetDefaultAvailableColumns
HPMProjectEmailSettings
Used to define the email settings for a project.
struct HPMProjectEmailSettings {
HPMInt32 m_ResourceScheduleUpdated_Enable;
HPMInt32 m_ResourceScheduleUpdated_nMinutesAfterUpdate;
HPMInt32 m_ResourceScheduleUpdated_bIncludeComment;
HPMInt32 m_BeforeAMilestone_Enable;
HPMInt32 m_BeforeAMilestone_nDaysBefore0;
HPMInt32 m_BeforeAMilestone_nDaysBefore1;
HPMInt32 m_BeforeAMilestone_WhenToSend;
HPMInt32 m_ProjectReport_Enable;
HPMInt32 m_ProjectReport_PeriodicityType;
HPMInt32 m_ProjectReport_WhenToSendWeekDay;
HPMInt32 m_ProjectReport_WhenToSendHourOfDay;
const HPMChar * m_ProjectReport_SendToEmailsExtra[3];
HPMInt32 m_WhenATaskIsCompleted_Enable;
const HPMChar * m_WhenATaskIsCompleted_SendToEmailsExtra[3];
HPMInt32 m_WhenACommentIsPosted_Enable;
const HPMChar * m_WhenACommentIsPosted_SendToEmailsExtra[3];
HPMInt32 m_WhenAPredcessorIsCompleted_Enable;
const HPMChar * m_WhenAPredcessorIsCompleted_SendToEmailsExtra[3];
HPMUInt32 m_ParentTaskDisplayDepthForEmails;
} HPMProjectEmailSettings;
Members
m_ResourceScheduleUpdated_Enable
If enabled a email will be sent to a resource when his/her schedule is updated. Can be one of EHPMOptionalBoolean.
m_ResourceScheduleUpdated_nMinutesAfterUpdate
The number of minutes after a change to the schedule to send the update. Several updates are sent in the same email if many tasks have changed.
m_ResourceScheduleUpdated_bIncludeComment
If set to true the last comment on updated items will be included.
m_BeforeAMilestone_Enable
If enabled emails are sent to resources in a project when a milestone is about to be due. Can be one of EHPMOptionalBoolean.
m_BeforeAMilestone_nDaysBefore0
The number of days before an upcoming milestone to send the first notification. Set to 0 to disable.
m_BeforeAMilestone_nDaysBefore1
The number of days before an upcoming milestone to send the second notification. Set to 0 to disable.
m_BeforeAMilestone_WhenToSend
The number of half hours past midnight to send notifications about upcoming milestones. 0 -> 47 (number of half hours from midnight).
m_ProjectReport_Enable
If enabled all main project managers will receive a project report. Can be one of EHPMOptionalBoolean.
m_ProjectReport_PeriodicityType
The periodicity of when to send project reports. Can be one of EHPMPeriodicityType.
m_ProjectReport_WhenToSendWeekDay
The weekday to send the project report. 0 -> 6 = Mon -> Sunday. Only valid if m_ProjectReport_PeriodicityType is set to EHPMPeriodicityType_Weekly.
m_ProjectReport_WhenToSendHourOfDay
The number of half hours past midnight to send project reports. 0 -> 47 (number of half hours from midnight).
m_ProjectReport_SendToEmailsExtra
A list of strings specifying extra email addresses to send project reports to. Set to NULL to disable.
m_WhenATaskIsCompleted_Enable
If enabled all main project managers will receive a notification when a task in the project is completed. Can be one of EHPMOptionalBoolean.
m_WhenATaskIsCompleted_SendToEmailsExtra
A list of strings specifying extra email addresses to send task notifications to. Set to NULL to disable.
m_WhenACommentIsPosted_Enable
If enabled the creator, additional and CC'd resources is sent a notification when a comment is posted. Can be one of EHPMOptionalBoolean.
m_WhenACommentIsPosted_SendToEmailsExtra
A list of strings specifying extra email addresses to send comment notifications to. Set to NULL to disable.
m_WhenAPredcessorIsCompleted_Enable
If enabled resources assigned to a task will receive notifications when a predecessor task is completed. Can be one of EHPMOptionalBoolean.
m_WhenAPredcessorIsCompleted_SendToEmailsExtra
A list of strings specifying extra email addresses to send predecessor notifications to. Set to NULL to disable.
m_ParentTaskDisplayDepthForEmails
The depth of parent tasks to display when tasks are displayed inside mail message. Set to 0 or more.
See Also
EHPMPeriodicityType, ProjectGetEmailSettings, ProjectSetEmailSettings
HPMProjectWorkflowRequiredField
Used to define a required field in the workflow.
struct HPMProjectWorkflowRequiredField {
HPMInt32 m_Type;
HPMInt32 m_ID;
} HPMProjectWorkflowRequiredField;
Members
m_Type
The type of field specified. See EHPMProjectWorkflowRequiredFieldType.
m_ID
If m_Type is EHPMProjectWorkflowRequiredFieldType_DefaultColumn this member is one of EHPMProjectDefaultColumn. If m_Type is EHPMProjectWorkflowRequiredFieldType_DefaultField this member is one of EHPMProjectDefaultField. If m_Type is EHPMProjectWorkflowRequiredFieldType_DefaultColumn this member is the column hash of the custom column.
See Also
HPMProjectWorkflowObject, EHPMProjectWorkflowRequiredFieldType EHPMProjectDefaultColumn, EHPMProjectDefaultField
HPMProjectWorkflowConnection
Used to define a connection between workflow objects.
struct HPMProjectWorkflowConnection {
HPMUInt32 m_ConnectedToUID;
HPMInt32 m_ConnectFrom;
HPMInt32 m_ConnectTo;
} HPMProjectWorkflowConnection;
Members
m_ConnectedToUID
The unique identifier of the status this connection is connected to.
m_ConnectFrom
The site on the start object that the connection is made from. See EHPMProjectWorkflowConnectionSite.
m_ConnectTo
The site on the end object that the connection is made to. See EHPMProjectWorkflowConnectionSite.
See Also
HPMProjectWorkflowObject, EHPMProjectWorkflowConnectionSite
HPMWorkflowStatusChange
Used to define a workflow status change that is set on a defined item status change.
struct HPMWorkflowStatusChange {
HPMInt32 m_ItemStatus;
HPMUInt32 m_GotoStatus;
} HPMWorkflowStatusChange;
Members
m_ItemStatus
The status that triggers the workflow status change. See EHPMTaskStatus.
m_GotoStatus
The unique identifier of a workflow object pointing to a workflow status that will be set on the task when HPMWorkflowStatusChange::m_ItemStatus is set. Set to -1 to indicate that the state should not change when the task is completed.
See Also
EHPMTaskStatus, HPMProjectWorkflowObject
HPMProjectWorkflowObject
Used to define a workflow status object.
struct HPMProjectWorkflowObject {
HPMUInt32 m_ObjectID;
HPMInt32 m_ObjectType;
HPMInt32 m_PositionX;
HPMInt32 m_PositionY;
HPMUInt32 m_nResources;
const HPMResourceDefinition * m_pResources;
HPMUInt32 m_nConnectedToObjects;
const HPMProjectWorkflowConnection * m_pConnectedToObjects;
HPMUInt32 m_Flags;
HPMUInt32 m_nRequiredFields;
const HPMProjectWorkflowRequiredField * m_pRequiredFields;
const HPMUntranslatedString * m_WorkflowStatus_pName;
HPMUInt32 m_WorkflowStatus_GoToWorkflowStatusWhenAssigned;
HPMUInt32 m_WorkflowStatus_nGotoWorkflowStatusWhenItemStatusSet;
HPMWorkflowStatusChange * m_WorkflowStatus_pGotoWorkflowStatusWhenItemStatusSet;
HPMUInt32 m_WorkflowStatus_AssignToResourcesAssignedInThisStatus;
HPMInt32 m_WorkflowStatus_Icon;
HPMUInt32 m_WorkflowStatus_nEmailNotifications;
const HPMResourceDefinition * m_WorkflowStatus_pEmailNotifications;
HPMUInt32 m_WorkflowStatus_nDefaultTaskValues;
const HPMTaskFieldData * m_WorkflowStatus_pDefaultTaskValues;
HPMUInt32 m_WorkflowStatus_SelectedWorklfowID;
HPMInt32 m_TaktTimeDays;
HPMInt32 m_TaktTimeHours;
HPMInt32 m_MaxWIPItems;
} HPMProjectWorkflowObject;
Members
m_ObjectID
The unique identifier of this object. Make sure that no duplicate identifiers exists when setting the workflow. Must be positive.
m_ObjectType
The type of object. Can be one of EHPMProjectWorkflowObjectType.
m_PositionX
The X position this object is displayed on when editing the workflow.
m_PositionY
The Y position this object is displayed on when editing the workflow.
m_nResources
The number of resources defined for this object.
m_pResources
Pointer to a list of resources. See HPMResourceDefinition. When m_ObjectType is EHPMProjectWorkflowObjectType_WorkflowStatus this list defines the resources a bug should be auto assigned to when this status is reached. When m_ObjectType is EHPMProjectWorkflowObjectType_Transition this list defines the resources that are allowed to pass through the transition. When m_ObjectType is EHPMProjectWorkflowObjectType_EntryStatus this list defines the resources that are allowed select the pipeline/workflow or to report new bugs in the QA section of the project.
m_nConnectedToObjects
The number of objects this object is connected to.
m_pConnectedToObjects
Pointer to a list of objects that this object should be connected to. See HPMProjectWorkflowConnection.
m_Flags
The flags for the workflow object. Can be any of EHPMProjectWorkflowObjectFlag.
m_nRequiredFields
The number of fields that are required to be filled in to exit this status or transition through this transition. Only valid when m_ObjectType is EHPMProjectWorkflowObjectType_WorkflowStatus or EHPMProjectWorkflowObjectType_Transition.
m_pRequiredFields
Pointer to a list of fields that are required to be filled in to exit this status or transition through this transition. See HPMProjectWorkflowRequiredField. Only valid when m_ObjectType is EHPMProjectWorkflowObjectType_WorkflowStatus or EHPMProjectWorkflowObjectType_Transition.
m_WorkflowStatus_pName
The name of the workflow status. Only valid when m_ObjectType is EHPMProjectWorkflowObjectType_WorkflowStatus.
m_WorkflowStatus_GoToWorkflowStatusWhenAssigned
The unique identifier of a workflow object pointing to a workflow status that will be set on the task when it is assigned to a resource. Set to -1 to indicate that the state should not change when the task is assigned. Only valid when m_ObjectType is EHPMProjectWorkflowObjectType_WorkflowStatus.
m_WorkflowStatus_nGotoWorkflowStatusWhenItemStatusSet
The number of automatic workflow status changes defined for this object. Only valid when m_ObjectType is EHPMProjectWorkflowObjectType_WorkflowStatus.
m_WorkflowStatus_pGotoWorkflowStatusWhenItemStatusSet
Pointer to a list of automatic workflow status changes. See HPMWorkflowStatusChange.
m_WorkflowStatus_AssignToResourcesAssignedInThisStatus
The unique identifier of a workflow object pointing to a workflow status. The resources that are assigned to to that status will be assigned to this status. Set to -1 to indicate that the no resources will be assigned. Only valid when m_ObjectType is EHPMProjectWorkflowObjectType_WorkflowStatus.
m_WorkflowStatus_Icon
The icon to show for the status. Can be one of EHPMListIcon. The icon Only valid when m_ObjectType is EHPMProjectWorkflowObjectType_WorkflowStatus.
m_WorkflowStatus_nEmailNotifications
The number of resources that should receive email notifications when this status is reached. Only valid when m_ObjectType is EHPMProjectWorkflowObjectType_WorkflowStatus.
m_WorkflowStatus_pEmailNotifications
Pointer to a list of resources that should receive email notifications when this status is reached. See HPMResourceDefinition. Only valid when m_ObjectType is EHPMProjectWorkflowObjectType_WorkflowStatus.
m_WorkflowStatus_nDefaultTaskValues
The number of default values to specify for this object.
m_WorkflowStatus_pDefaultTaskValues
Pointer to a list of default values to specify for this object. See HPMTaskFieldData. Currently only EHPMTaskField_WorkRemaining and EHPMTaskField_Status are valid here. EHPMTaskField_TotalDuration is used to specify the duration in hours for a scheduled task in a pipeline workflow.
m_WorkflowStatus_SelectedWorklfowID
Used to specify a sub workflow, either for specifying a sub pipeline, a sub workflow or the workflow that sub items can be broken down into.
m_TaktTimeDays
The number of takt time days for a Kanban.
m_TaktTimeHours
The number of takt time hours for a Kanban.
m_MaxWIPItems
The max number of work in progress items in a Kanban.
See Also
HPMProjectWorkflowSettings, EHPMProjectWorkflowObjectType HPMResourceDefinition, HPMProjectWorkflowConnection, EHPMListIcon, HPMProjectWorkflowRequiredField, EHPMProjectWorkflowObjectFlag
HPMProjectWorkflowProperties
Used to define the basic properties of a workflow.
struct HPMProjectWorkflowProperties {
const HPMChar * m_pName;
HPMInt32 m_WorkflowType;
HPMInt32 m_Icon;
} HPMProjectWorkflowProperties;
Members
m_pName
The name of the workflow.
m_WorkflowType
The type of workflow. Can by any one of EHPMWorkflowType.
m_Icon
The icon to display for this workflow. Can be one of EHPMListIcon.
See Also
HPMProjectWorkflowSettings, EHPMWorkflowType, HPMResourceDefinition, EHPMListIcon
HPMProjectWorkflowSettings
Used to define the settings for a workflow.
struct HPMProjectWorkflowSettings {
HPMUInt32 m_Identifier;
HPMUInt32 m_NewestWorkflowVersionID;
HPMUInt32 m_Flags;
HPMProjectWorkflowProperties m_Properties;
HPMUniqueID m_CreatedByResource;
HPMResourceDefinitionList m_ResourceList;
HPMUInt32 m_nWorkflowObjects;
const HPMProjectWorkflowObject * m_pWorkflowObjects;
} HPMProjectWorkflowSettings;
Members
m_Identifier
The unique identifier of this workflow.
m_NewestWorkflowVersionID
Set to 0xffffffff if this is the latest version of the workflow otherwise set to the unique identifer of the latest version of the workflow.
m_Flags
Workflow settings flags. Can be any combination of EHPMProjectWorkflowContainerFlag.
m_Properties
The base properties for the workflow.
m_CreatedByResource
The unique identifier of the resource that created this workflow.
m_ResourceList
A list of resources that can change the workflow status.
m_nWorkflowObjects
The number of objects in the workflow.
m_pWorkflowObjects
Pointer to a list of objects defining the workflow. See HPMProjectWorkflowObject.
See Also
ProjectWorkflowGetSettings, ProjectWorkflowSetSettings, HPMProjectWorkflowObject, HPMProjectWorkflowProperties
HPMProjectWorkflows
Used to define a number of workflows.
struct HPMProjectWorkflows {
HPMUInt32 m_nWorkflows;
const HPMProjectWorkflowSettings * m_pWorkflows;
} HPMProjectWorkflows;
Members
m_nWorkflows
The number of workflows.
m_pWorkflows
Pointer to a list of workflows. See HPMProjectWorkflowSettings.
See Also
HPMProjectWallSettings
Used to define the wall settings for a project.
struct HPMProjectWallSettings {
HPMUInt32 m_Flags;
HPMUInt32 m_nShowTaskColumns;
HPMColumn * m_pShowTaskColumns;
} HPMProjectWallSettings;
Members
m_Flags
Wall settings flags. Can be any combination of EHPMProjectWallSettingsFlags.
m_nShowTaskColumns
The number of columns to show for tasks on the wall.
m_pShowTaskColumns
Pointer to a list of columns that should be shown for tasks on the wall. See HPMColumn.
See Also
ProjectGetWallSettings, ProjectSetWallSettings, EHPMProjectWallSettingsFlags
HPMProjectDetailedAccessRuleFunction
Used to define access functions in HPMProjectDetailedAccessRule.
struct HPMProjectDetailedAccessRuleFunction {
HPMInt32 m_FunctionType;
HPMUInt32 m_FunctionID;
HPMInt32 m_FunctionSubID;
} HPMProjectDetailedAccessRuleFunction;
Members
m_FunctionType
The function type. Can be one of EHPMProjectDetailedAccessRuleFunctionType.
m_FunctionID
Only used when m_FunctionType is EHPMProjectDetailedAccessRuleFunctionType_DefalutColumn, EHPMProjectDetailedAccessRuleFunctionType_CustomColumn or EHPMProjectDetailedAccessRuleFunctionType_TaskField. Also see comments section.
m_FunctionSubID
This is only used when HPMProjectDetailedAccessRule::m_RuleType is set to EHPMProjectDetailedAccessRuleType_Hide, otherwise it should be set to 0. See the comments section in HPMProjectDetailedAccessRule.
Comments
Descriptions about how to set the m_FunctionID variable for different m_FunctionType values:
| Enum | Description |
|---|---|
| EHPMProjectDetailedAccessRuleFunctionType_DefalutColumn | m_FunctionID should be set to one of EHPMProjectDefaultColumn enum. |
| EHPMProjectDetailedAccessRuleFunctionType_CustomColumn | m_FunctionID should be set to the hash of a custom column. |
| EHPMProjectDetailedAccessRuleFunctionType_TaskField | m_FunctionID should be set to one of EHPMTaskField enum. Currently only EHPMTaskField_Description, EHPMTaskField_DetailedDescription and EHPMTaskField_StepsToReproduce is used. |
| All other | m_FunctionID should be set to 0. |
See Also
HPMProjectDetailedAccessRule, EHPMProjectDetailedAccessRuleFunctionType, EHPMProjectDefaultColumn, EHPMProjectDefaultColumn, EHPMTaskField
HPMProjectDetailedAccessRule
Used to define a access rule in HPMProjectDetailedAccessRules.
struct HPMProjectDetailedAccessRule {
HPMInt32 m_RuleType;
HPMUniqueID m_CreatedByResource;
HPMUInt32 m_nResources;
const HPMResourceDefinition * m_pResources;
HPMUInt32 m_nFunctions;
const HPMProjectDetailedAccessRuleFunction * m_pFunctions;
} HPMProjectDetailedAccessRule;
Members
m_RuleType
Can be one of EHPMProjectDetailedAccessRuleType.
m_CreatedByResource
Unique identifier for the resource that created this rule.
m_nResources
The number of resources this rule affects.
m_pResources
Pointer to a list of resources this rule affects. See HPMResourceDefinition.
m_nFunctions
The number of functions this rule affects. Also see comments section.
m_pFunctions
Pointer to a list of functions this rule affects. See HPMProjectDetailedAccessRuleFunction.
Comments
When m_RuleType is EHPMProjectDetailedAccessRuleType_Hide you should only specify one function. The members of the HPMProjectDetailedAccessRuleFunction struct should be defined as follows:
| Variable | Description |
|---|---|
| m_FunctionType | Should be set to EHPMProjectDetailedAccessRuleFunctionType_CustomColumn. |
| m_FunctionID | Should be set to the hash of a custom column that is of the drop list type. |
| m_FunctionSubID | Should be set to a drop list item identifier. See HPMProjectCustomColumnsColumnDropListItem::m_Id. |
See Also
HPMProjectDetailedAccessRules, EHPMProjectDetailedAccessRuleType, HPMResourceDefinition, HPMProjectDetailedAccessRuleFunction
HPMProjectDetailedAccessRules
Used to define the detailed access rules for a project.
struct HPMProjectDetailedAccessRules {
HPMUInt32 m_nRules;
HPMProjectDetailedAccessRule * m_pRules;
} HPMProjectDetailedAccessRules;
Members
m_nRules
The number of access rules for this project.
m_pRules
Pointer to a list of rules for this project. See HPMProjectDetailedAccessRule.
See Also
HPMProjectDetailedAccessRule, ProjectGetDetailedAccessRules, ProjectSetDetailedAccessRules
HPMResourcePermissionDefinition
Used to define a permission rule in HPMProjectColumnResourcePermissionRules.
struct HPMResourcePermissionDefinition {
HPMInt32 m_Permission;
HPMResourceDefinition m_ResourceDefinition;
} HPMResourcePermissionDefinition;
Members
m_Permission
The permission. Can be one of EHPMProjectColumnResourcePermission.
m_ResourceDefinition
Resource getting the permission
Comments
You can set the Base Permission for a column by using a HPMResourceDefinition of type EHPMResourceGroupingType_AllProjectMembers with an ID of 0
See Also
HPMProjectColumnResourcePermissionRules, HPMProjectColumnResourcePermissionRule, EHPMProjectColumnResourcePermission, HPMResourceDefinition
HPMProjectColumnResourcePermissionRule
Used to define a permission rule in HPMProjectColumnResourcePermissionRules.
struct HPMProjectColumnResourcePermissionRule {
HPMUInt32 m_ColumnHash;
HPMUInt32 m_nResourcePermissions;
const HPMResourcePermissionDefinition * m_pResourcePermissions;
HPMInt32 m_FieldID;
} HPMProjectColumnResourcePermissionRule;
Members
m_ColumnHash
Hash of the Custom Column this rule applies to when m_FieldID is EHPMTaskField_CustomColumnData
m_nResourcePermissions
The number of resources with permissions set.
m_pResourcePermissions
Pointer to a list of resources permissions. See HPMResourcePermissionDefinition.
m_FieldID
The field the rule is for. Currently only EHPMTaskField_CustomColumnData, EHPMTaskField_SprintPriority, and EHPMTaskField_BacklogPriority are supported.
Comments
See Also
HPMProjectColumnResourcePermissionRules, HPMResourcePermissionDefinition
HPMProjectColumnResourcePermissionRules
Used to define the resource permission rules for a project.
struct HPMProjectColumnResourcePermissionRules {
HPMUInt32 m_nRules;
HPMProjectColumnResourcePermissionRule * m_pRules;
} HPMProjectColumnResourcePermissionRules;
Members
m_nRules
The number of permission rules for this project.
m_pRules
Pointer to a list of rules for this project. See HPMProjectColumnResourcePermissionRule.
See Also
HPMProjectColumnResourcePermissionRule, ProjectGetColumnResourcePermissionRules, ProjectSetColumnResourcePermissionRules
HPMProjectWallGroup
Used to define a project wall group.
struct HPMProjectWallGroup {
HPMInt32 m_GroupingType;
HPMUInt32 m_GroupingID;
HPMUniqueID m_GroupingSprintUID;
HPMUniqueID m_ValueAssignID;
const HPMChar * m_pGroupName;
HPMFP32 m_RectLeft;
HPMFP32 m_RectTop;
HPMFP32 m_RectRight;
HPMFP32 m_RectBottom;
} HPMProjectWallGroup;
Members
m_GroupingType
Grouping identification type. Can be one of EHPMWallGroupingType.
m_GroupingID
If m_GroupingType is EHPMWallGroupingType_DefaultColumn this value can be one of EHPMProjectDefaultColumn. If m_GroupingType is EHPMWallGroupingType_CustomColumn this value is the hash of the custom column. If m_GroupingType is EHPMWallGroupingType_CustomGroups this value should be set to 0.
m_GroupingSprintUID
The unique identifier of the selected sprint in the main project wall view.
m_ValueAssignID
Used to specify the value to be assigned when an item is moved to this group.
m_pGroupName
The name of the custom group. Only used when m_GroupingType is EHPMWallGroupingType_CustomGroups.
m_RectLeft
The left bonding of the group rectangle.
m_RectTop
The top bonding of the group rectangle.
m_RectRight
The right bonding of the group rectangle.
m_RectBottom
The bottom bonding of the group rectangle.
See Also
HPMProjectWallGroups, EHPMWallGroupingType, EHPMProjectDefaultColumn
HPMProjectWallGroups
Used to define the wall groups for a project.
struct HPMProjectWallGroups {
HPMUInt32 m_nGroups;
HPMProjectWallGroup * m_pGroups;
} HPMProjectWallGroups;
Members
m_nGroups
The number of wall groups for this project.
m_pGroups
Pointer to a list of wall groups for this project. See HPMProjectWallGroup.
See Also
HPMProjectWallGroup, ProjectGetWallGroups, ProjectSetWallGroups
HPMProjectStatisticsSettings
Used to define statistics settings for a project.
struct HPMProjectStatisticsSettings {
HPMUInt32 m_SamplingFrequency;
HPMUInt32 m_SecondOfDaySample;
HPMUInt32 m_SamplingFrequencyResource;
HPMUInt32 m_SecondOfDaySampleResource;
HPMUInt32 m_SamplingFrequencyResourceGroup;
HPMUInt32 m_SecondOfDaySampleResourceGroup;
} HPMProjectStatisticsSettings;
Members
m_SamplingFrequency
The number of seconds between samplings of project statistics.
m_SecondOfDaySample
The number of seconds past midnight that sampling of project statistics should start.
m_SamplingFrequencyResource
The number of seconds between samplings of project statistics for a resources.
m_SecondOfDaySampleResource
The number of seconds past midnight that sampling of project statistics for resources should start.
m_SamplingFrequencyResourceGroup
The number of seconds between samplings of project statistics for a resource groups.
m_SecondOfDaySampleResourceGroup
The number of seconds past midnight that sampling of project statistics for resource groups should start.
See Also
ProjectGetStatisticsSettings, ProjectSetStatisticsSettings
HPMProjectResourceEnum
Used for enumerating the resource members of a project.
struct HPMProjectResourceEnum {
HPMUInt32 m_nResources;
const HPMUniqueID * m_pResources;
} HPMProjectResourceEnum;
Members
m_nResources
The number of resource members in the project.
m_pResources
Pointer to a list of unique identifiers pointing to resources that are members of the project.
See Also
HPMProjectResourceProperties
Used for specifying properties of a member of a project
struct HPMProjectResourceProperties {
HPMUInt32 m_Flags;
} HPMProjectResourceProperties;
Members
m_Flags
Flags for the member of a project. Can be any valid combination of EHPMProjectResourceFlag.
See Also
EHPMProjectResourceFlag, ProjectResourceAdd, ProjectResourceGetProperties, ProjectResourceSetProperties
HPMProjectCustomStatisticsSampler
Used to define the a custom statistics sampler in a project. See HPMProjectCustomStatisticsSettings.
struct HPMProjectCustomStatisticsSampler {
HPMInt32 m_SamplerID;
const HPMChar * m_pName;
HPMUniqueID m_CreatedBy;
HPMInt32 m_nFields;
HPMCustomStatisticsField * m_pFields;
} HPMProjectCustomStatisticsSampler;
Members
m_SamplerID
The unique identifier for this sampler. The ID is unique per project.
m_pName
The name of the custom sampler.
m_CreatedBy
The unique identifier of the resource that created this custom statistics sampler.
m_nFields
The number of fields that this custom statistics sampler should combine. Maximum of 3 fields currently supported.
m_pFields
Pointer to a list of fields this custom statistics sampler should combine. See HPMCustomStatisticsField.
See Also
HPMProjectCustomStatisticsSettings, HPMCustomStatisticsField
HPMProjectCustomStatisticsSettings
Used to define the custom statistics settings for a project.
struct HPMProjectCustomStatisticsSettings {
HPMInt32 m_NextSamplerID;
HPMUInt32 m_nStatisticsSamplers;
HPMProjectCustomStatisticsSampler * m_pStatisticsSamplers;
} HPMProjectCustomStatisticsSettings;
Members
m_NextSamplerID
The next free sampler ID available. This value should be used and increased when adding a new entry to the m_pStatisticsSamplers list.
m_nStatisticsSamplers
The number of defined custom statistics samplers.
m_pStatisticsSamplers
Pointer to a list of custom statistics samplers for this project. See HPMProjectCustomStatisticsSampler.
See Also
HPMProjectCustomStatisticsSampler, ProjectSetCustomStatisticsSettings, ProjectGetCustomStatisticsSettings
HPMProjectWorkflowEnum
Used for enumerating project workflows.
struct HPMProjectWorkflowEnum {
HPMUInt32 m_nWorkflows;
const HPMUInt32 * m_pWorkflows;
} HPMProjectWorkflowEnum;
Members
m_nWorkflows
The number of workflows.
m_pWorkflows
Pointer to a list of workflow identifiers.
See Also
HPMProjectWorkflowObjectEnum
Used for enumerating project workflow objects on a workflow.
struct HPMProjectWorkflowObjectEnum {
HPMUInt32 m_nWorkflowObjects;
const HPMUInt32 * m_pWorkflowObjects;
} HPMProjectWorkflowObjectEnum;
Members
m_nWorkflowObjects
The number of workflow objetcs.
m_pWorkflowObjects
Pointer to a list of workflow identifiers in the project.
See Also
HPMProjectWorkflowStructureTask
Used for defining a workflow task generated from a workflow pipeline.
struct HPMProjectWorkflowStructureTask {
HPMWorkflowObjectIdentifier m_WorkflowIdentifier;
const HPMUntranslatedString * m_pTaskDescription;
HPMUInt32 m_TaskTreeLevel;
HPMResourceDefinitionList m_TaskAllocatedResources;
HPMUInt32 m_nTaskDefaultValues;
const HPMTaskFieldData * m_pTaskDefaultValues;
} HPMProjectWorkflowStructureTask;
Members
m_WorkflowIdentifier
The workflow ID and workflow object ID that was used to generate this task. See HPMWorkflowObjectIdentifier.
m_pTaskDescription
The description to set on the generated task.
m_TaskTreeLevel
The tree indentation level this task should have. This indentation level is relative.
m_TaskAllocatedResources
The resources that should be allocated to this task. See HPMResourceDefinitionList.
m_nTaskDefaultValues
The number of default values to specify for this object.
m_pTaskDefaultValues
Pointer to a list of default values to specify for this object. See HPMTaskFieldData. Currently only values for EHPMTaskField_WorkRemaining, EHPMTaskField_EstimatedIdealDays and EHPMTaskField_ComplexityPoints are valid here.
See Also
HPMProjectWorkflowStructure
Used for defining a workflow structure generated from a workflow pipeline.
struct HPMProjectWorkflowStructure {
HPMUInt32 m_nTasks;
const HPMProjectWorkflowStructureTask * m_pTasks;
} HPMProjectWorkflowStructure;
Members
m_nTasks
The number tasks defined in the workflow structure.
m_pTasks
Pointer to a list of workflow structure tasks defining the workflow structure. See HPMProjectWorkflowStructureTask.
See Also
HPMProjectWorkflowStructureTask, ProjectUtilGetWorkflowStructure
HPMProjectWorkflowStatusStats
Used for defining statistics for a workflow status
struct HPMProjectWorkflowStatusStats {
HPMInt64 m_StateChanges;
HPMInt64 m_TotalTimeSpan;
HPMInt64 m_ContributingTasks;
} HPMProjectWorkflowStatusStats;
Members
m_StateChanges
The number of times tasks have passed this status.
m_TotalTimeSpan
The total time in seconds that tasks have stayed in this status.
m_ContributingTasks
The number of tasks that have passed this status.
See Also
HPMProjectWorkflowEnumWorkflowProperties
Used to define the properties of an enumeration of workflows on a given workflow in a project.
struct HPMProjectWorkflowEnumWorkflowProperties {
HPMInt32 m_WorkflowEnumWorkflowType;
} HPMProjectWorkflowEnumWorkflowProperties;
Members
m_WorkflowEnumWorkflowType
The type of workflow enumeration. Can be one of EHPMProjectWorkflowEnumWorkflowType.
See Also
ProjectWorkflowEnumWorkflow, EHPMProjectWorkflowEnumWorkflowType
HPMProjectWorkflowEnumObjectProperties
Used to define the properties of an enumeration of workflow objects on given workflow and workflow object in a project.
struct HPMProjectWorkflowEnumObjectProperties {
HPMInt32 m_WorkflowEnumObjectType;
} HPMProjectWorkflowEnumObjectProperties;
Members
m_WorkflowEnumObjectType
The type of workflow object enumeration. Can be one of EHPMProjectWorkflowEnumObjectType.
See Also
ProjectWorkflowEnumObject, EHPMProjectWorkflowEnumObjectType
HPMProjectViewPreset
Used to define a view preset in HPMProjectViewPresets.
struct HPMProjectViewPreset {
HPMUniqueID m_ID;
HPMUniqueID m_LocalID;
HPMUniqueID m_CreatedBy;
HPMUInt32 m_nShareWithUsers;
const HPMResourceDefinition * m_pShareWithUsers;
HPMUInt32 m_nShareWithEditRights;
const HPMResourceDefinition * m_pShareWithEditRights;
const HPMChar * m_pName;
HPMUInt32 m_nColumns;
const HPMColumn * m_pColumns;
HPMUInt32 m_nColumnsOrder;
const HPMColumn * m_pColumnsOrder;
HPMUInt32 m_nItemSettingsColumns;
const HPMColumn * m_pItemSettingsColumns;
HPMUInt32 m_nItemSettingsColumnsOrder;
const HPMColumn * m_pItemSettingsColumnsOrder;
HPMUInt32 m_nQAItemSettingsColumns;
const HPMColumn * m_pQAItemSettingsColumns;
HPMUInt32 m_nQAItemSettingsColumnsOrder;
const HPMColumn * m_pQAItemSettingsColumnsOrder;
HPMUInt32 m_ShowOptions;
HPMUInt32 m_ParentTaskDisplayDepth;
} HPMProjectViewPreset;
Members
m_ID
The unique identifier of the user view preset.
m_LocalID
Locally unique identifier.
m_CreatedBy
The unique identifier of the user that created the user view preset.
m_nShareWithUsers
The number of resources this preset is shared with.
m_pShareWithUsers
Pointer to a list of resources this preset is shared with. See HPMResourceDefinition.
m_nShareWithEditRights
The number of resources that has edit rights for this preset.
m_pShareWithEditRights
Pointer to a list of resources that has edit rights for this preset. See HPMResourceDefinition.
m_pName
The name of the user view preset.
m_nColumns
The number of columns that will be visible.
m_pColumns
Pointer to a list of columns that will be visible. See HPMColumn.
m_nColumnsOrder
The number of columns used for column order.
m_pColumnsOrder
Pointer to a list of columns that will used for column order. See HPMColumn.
m_nItemSettingsColumns
The number of columns that will be visible in item settings/details.
m_pItemSettingsColumns
Pointer to a list of columns that will be visible in item settings/details. See HPMColumn.
m_nItemSettingsColumnsOrder
The number of columns that will be used for item settings/details column order.
m_pItemSettingsColumnsOrder
Pointer to a list of columns that will be used for in item settings/details column order. See HPMColumn.
m_nQAItemSettingsColumns
The number of columns that will be visible in item settings/details when selecting a bug in the planning section.
m_pQAItemSettingsColumns
Pointer to a list of columns that will be visible in item settings/details when selecting a bug in the planning section. See HPMColumn.
m_nQAItemSettingsColumnsOrder
The number of columns that will be used for item settings/details column order when selecting a bug in the planning section.
m_pQAItemSettingsColumnsOrder
Pointer to a list of columns that will be used for in item settings/details column order when selecting a bug in the planning section. See HPMColumn.
m_ShowOptions
Options that will be set by the preset. Can be any of combination of EHPMProjectPresetShowOptionFlag that are valid for the current type of project.
m_ParentTaskDisplayDepth
The depth of parent tasks to display when tasks are displayed outside of the context of the task tree. Set to 0 or more.
See Also
HPMProjectViewPresets, HPMColumn, EHPMProjectPresetShowOptionFlag
HPMProjectViewPresets
Used to define the view presets for a project.
struct HPMProjectViewPresets {
HPMUInt32 m_nPresets;
HPMProjectViewPreset const * m_pPresets;
} HPMProjectViewPresets;
Members
m_nPresets
The number of view presets for this project.
m_pPresets
Pointer to a list of view presets for this project. See HPMProjectViewPreset.
See Also
HPMProjectViewPreset, ProjectGetViewPresets
HPMProjectCloneProperties
Used for specifying properties needed for cloning a project.
struct HPMProjectCloneProperties {
HPMUniqueID m_SourceProjectID;
const HPMChar * m_pName;
const HPMChar * m_pSortName;
HPMUInt32 m_CloningFlag;
HPMUniqueID m_ClonedReportsOwnerID;
} HPMProjectCloneProperties;
Members
m_SourceProjectID
Source project id for cloning.
m_pName
The name of the project.
m_pSortName
If set this name is used for sorting instead of the project name.
m_CloningFlag
Flags for the cloning option.
m_ClonedReportsOwnerID
New owner of cloned reports in case resources were not cloned
See Also
EHPMProjectMethod, EHPMProjectTaskCompletionStyle, EHPMProjectDefaultEditorMode, EHPMProjectAgileTemplate, ProjectCreate, ProjectGetProperties, ProjectSetProperties
HPMProjectFunctionColumnExpressionParseResult
Used to define the result of parsing string to custom column expression
struct HPMProjectFunctionColumnExpressionParseResult {
HPMUInt32 m_bResult;
HPMFunctionColumnTokens m_Tokens;
HPMUntranslatedString const * m_pError;
HPMStringPosition const * m_pErrorPosition;
} HPMProjectFunctionColumnExpressionParseResult;
Members
m_bResult
. Indicates whether the parsing was successful
m_Tokens
Result tokens, relevant only if m_Result is true
m_pError
Parse error, relevant only if m_Result is false
m_pErrorPosition
String position of error in original expression string, relevant only if m_Result is false
See Also
HPMUntranslatedString, HPMFunctionColumnTokens
HPMProjectFunctionColumnExpressionsValidationError
Used to define the result of custom column expression validation
struct HPMProjectFunctionColumnExpressionsValidationError {
HPMUInt32 m_ColumnHash;
HPMUntranslatedString const * m_pError;
HPMStringPosition const * m_pErrorPosition;
} HPMProjectFunctionColumnExpressionsValidationError;
Members
m_ColumnHash
TBD
m_pError
Validation error. Empty if no error is encountered.
m_pErrorPosition
String position of error in original expression string
See Also
HPMUntranslatedString, HPMProjectFunctionColumnExpressionsValidationErrors
HPMProjectFunctionColumnExpressionsValidationErrors
Used to define the results of custom columns changed expression validation
struct HPMProjectFunctionColumnExpressionsValidationErrors {
HPMUInt32 m_nErrors;
HPMProjectFunctionColumnExpressionsValidationError const * m_pErrors;
} HPMProjectFunctionColumnExpressionsValidationErrors;
Members
m_nErrors
TBD
m_pErrors
TBD
See Also
HPMProjectFunctionColumnExpressionsValidationError, ProjectUtilApplyLocalContextFunctionColumnChanges, ProjectUtilValidateLocalContextFunctionColumnExpressionChanges
HPMProjectCustomColumnChangeHash
Used for specifying a hash change in HPMProjectCustomColumnChangeHashes
struct HPMProjectCustomColumnChangeHash {
HPMUInt32 m_HashFrom;
HPMUInt32 m_HashTo;
} HPMProjectCustomColumnChangeHash;
Members
m_HashFrom
The custom column hash to change from
m_HashTo
The custom column hash to change to
See Also
HPMProjectCustomColumnChangeHashes
HPMProjectCustomColumnChangeHashes
Used for specifying a hash changes in ProjectUtilCompareCustomColumns.
struct HPMProjectCustomColumnChangeHashes {
HPMUInt32 m_nHashChanges;
const HPMProjectCustomColumnChangeHash * m_pHashChanges;
} HPMProjectCustomColumnChangeHashes;
Members
m_nHashChanges
The number of hash changes.
m_pHashChanges
Pointer to a list of hash changes. See HPMProjectCustomColumnChangeHash.
See Also
HPMProjectMilestones
Used in ProjectGetMilestones to return the milestones in a project.
struct HPMProjectMilestones {
HPMUInt32 m_nMilestones;
const HPMUniqueID * m_pMilestones;
} HPMProjectMilestones;
Members
m_nMilestones
The number of milestones in the project.
m_pMilestones
Pointer to a list of unique identifiers pointing to the task references of the milestones in the project.
See Also
HPMProjectSprints
Used in ProjectGetSprints to return the sprints in a project.
struct HPMProjectSprints {
HPMUInt32 m_nSprints;
const HPMUniqueID * m_pSprints;
} HPMProjectSprints;
Members
m_nSprints
The number of sprints in the project.
m_pSprints
Pointer to a list of unique identifiers pointing to the task references of the sprints in the project.
See Also
ProjectCreate
Creates a project in the database.
HPMError ProjectCreate (
    void * _pSession,
    const HPMProjectProperties * _pProperties,
    HPMUniqueID * _pProjectID
    );
Parameters
_pSession
[in] A connected session. See SessionOpen.
_pProperties
[in] The properties of the created project.
_pProjectID
[in] The unique identifier of the created project. If in nonblocking mode _pProjectID will be filled with an temporary id that you later can match against in the change callback. See HPMChangeCallbackData_ProjectCreate.
Return Value
Returns an error code. See EHPMError.
Comments
You should make sure that a project with the same name does not already exist.
See Also
HPMSdkFunctions, HPMProjectProperties
ProjectClone
Clone an existing project in the database.
HPMError ProjectClone (
    void * _pSession,
    const HPMProjectCloneProperties * _pProperties,
    HPMUniqueID * _pProjectID
    );
Parameters
_pSession
[in] A connected session. See SessionOpen.
_pProperties
[in] The properties of the created project.
_pProjectID
[in] The unique identifier of the created project. If in nonblocking mode _pProjectID will be filled with an temporary id that you later can match against in the change callback. See HPMChangeCallbackData_ProjectCreate.
Return Value
Returns an error code. See EHPMError.
Comments
You should make sure that a project with the same name does not already exist.
See Also
HPMSdkFunctions, HPMProjectCloneProperties
ProjectDelete
Deletes a project in the database.
HPMError ProjectDelete (
    void * _pSession,
    HPMUniqueID _ProjectID
    );
Parameters
_pSession
[in] A connected session. See SessionOpen.
_ProjectID
[in] The unique identifier of the project to delete.
Return Value
Returns an error code. See EHPMError.
Comments
When a project is deleted all data about the project is deleted in the database, the project history for the project is deleted and the documents folder for the project is moved to the "Deleted Projects" folder.
See Also
ProjectEnum
Enumerates projects in a database.
HPMError ProjectEnum (
    void * _pSession,
    const HPMProjectEnum * * _pEnum
    );
Parameters
_pSession
[in] A connected session. See SessionOpen.
_pEnum
[out] Pointer to a pointer of a HPMProjectEnum object, representing the returned data.
Return Value
Returns an error code. See EHPMError.
Comments
The returned object must be freed with ObjectFree or a memory leak will result.
See Also
HPMSdkFunctions, ObjectFree, HPMProjectEnum
ProjectEnumNonArchived
Enumerates non archived projects in a database.
HPMError ProjectEnumNonArchived (
    void * _pSession,
    const HPMProjectEnum * * _pEnum
    );
Parameters
_pSession
[in] A connected session. See SessionOpen.
_pEnum
[out] Pointer to a pointer of a HPMProjectEnum object, representing the returned data.
Return Value
Returns an error code. See EHPMError.
Comments
The returned object must be freed with ObjectFree or a memory leak will result.
See Also
HPMSdkFunctions, ObjectFree, HPMProjectEnum
ProjectGetProperties
Gets the properties of a project in the database.
HPMError ProjectGetProperties (
    void * _pSession,
    HPMUniqueID _ProjectID,
    const HPMProjectProperties * * _pProperties
    );
Parameters
_pSession
[in] A connected session. See SessionOpen.
_ProjectID
[in] The unique identifier of the project to get the properties of.
_pProperties
[out] Pointer to a pointer of a HPMProjectProperties object, representing the returned data.
Return Value
Returns an error code. See EHPMError.
Comments
The returned object must be freed with ObjectFree or a memory leak will result.
See Also
HPMSdkFunctions, ObjectFree, HPMProjectProperties
ProjectSetProperties
Sets the properties of a project in the database.
HPMError ProjectSetProperties (
    void * _pSession,
    HPMUniqueID _ProjectID,
    const HPMProjectProperties * _pProperties
    );
Parameters
_pSession
[in] A connected session. See SessionOpen.
_ProjectID
[in] The unique identifier of the project to set the properties of.
_pProperties
[in] The properties to set on the project. See HPMProjectProperties.
Return Value
Returns an error code. See EHPMError.
See Also
HPMSdkFunctions, HPMProjectProperties
ProjectGetHistoryAutoSaveSettings
Gets project history auto save settings for a project.
HPMError ProjectGetHistoryAutoSaveSettings (
    void * _pSession,
    HPMUniqueID _ProjectID,
    const HPMProjectHistoryAutoSaveSettings * * _pSettings
    );
Parameters
_pSession
[in] A connected session. See SessionOpen.
_ProjectID
[in] The unique identifier of the project to get project history auto save settings for.
_pSettings
[out] Pointer to a pointer of a HPMProjectHistoryAutoSaveSettings object, representing the returned data.
Return Value
Returns an error code. See EHPMError.
Comments
The returned object must be freed with ObjectFree or a memory leak will result.
See Also
HPMSdkFunctions, ObjectFree, HPMProjectHistoryAutoSaveSettings
ProjectSetHistoryAutoSaveSettings
Sets project history auto save settings for a project.
HPMError ProjectSetHistoryAutoSaveSettings (
    void * _pSession,
    HPMUniqueID _ProjectID,
    const HPMProjectHistoryAutoSaveSettings * _pSettings
    );
Parameters
_pSession
[in] A connected session. See SessionOpen.
_ProjectID
[in] The unique identifier of the project to set project history auto save settings on.
_pSettings
[in] The auto save settings to set on the project. See HPMProjectHistoryAutoSaveSettings.
Return Value
Returns an error code. See EHPMError.
See Also
HPMSdkFunctions, HPMProjectHistoryAutoSaveSettings
ProjectWorkflowGetObject
Gets a workflow object for a workflow in a project.
HPMError ProjectWorkflowGetObject (
    void * _pSession,
    HPMUniqueID _ProjectID,
    HPMUInt32 _WorkflowID,
    HPMUInt32 _ObjectID,
    const HPMProjectWorkflowObject * * _pObject
    );
Parameters
_pSession
[in] A connected session. See SessionOpen.
_ProjectID
[in] The unique identifier of the project to get the object for.
_WorkflowID
[in] The identifier of the workflow to get the object for.
_ObjectID
[in] The identifier of the workflow object to get.
_pObject
[out] Pointer to a pointer of a HPMProjectWorkflowObject object, representing the returned data.
Return Value
Returns an error code. See EHPMError.
Comments
The returned object must be freed with ObjectFree or a memory leak will result.
See Also
HPMSdkFunctions, ObjectFree, HPMProjectWorkflowObject
ProjectWorkflowGetSettings
Gets workflow settings for a workflow in a project.
HPMError ProjectWorkflowGetSettings (
    void * _pSession,
    HPMUniqueID _ProjectID,
    HPMUInt32 _WorkflowID,
    const HPMProjectWorkflowSettings * * _pSettings
    );
Parameters
_pSession
[in] A connected session. See SessionOpen.
_ProjectID
[in] The unique identifier of the project to get workflow settings for.
_WorkflowID
[in] The identifier of the workflow to get workflow settings for.
_pSettings
[out] Pointer to a pointer of a HPMProjectWorkflowSettings object, representing the returned data.
Return Value
Returns an error code. See EHPMError.
Comments
The returned object must be freed with ObjectFree or a memory leak will result.
See Also
HPMSdkFunctions, ObjectFree, HPMProjectWorkflowSettings
ProjectWorkflowSetSettings
Sets workflow settings for a workflow in a project.
HPMError ProjectWorkflowSetSettings (
    void * _pSession,
    HPMUniqueID _ProjectID,
    HPMUInt32 _WorkflowID,
    const HPMProjectWorkflowSettings * _pSettings
    );
Parameters
_pSession
[in] A connected session. See SessionOpen.
_ProjectID
[in] The unique identifier of the project to set workflow settings on.
_WorkflowID
[in] The identifier of the workflow to set workflow settings for.
_pSettings
[in] The workflow settings to set on the project. See HPMProjectWorkflowSettings.
Return Value
Returns an error code. See EHPMError.
See Also
HPMSdkFunctions, HPMProjectWorkflowSettings
ProjectWorkflowSetLatestVersion
Sets the latest version of a workflow in a project.
HPMError ProjectWorkflowSetLatestVersion (
    void * _pSession,
    HPMUniqueID _ProjectID,
    HPMUInt32 _WorkflowID,
    const HPMProjectWorkflowSettings * * _pSettings
    );
Parameters
_pSession
[in] A connected session. See SessionOpen.
_ProjectID
[in] The unique identifier of the project to set the latest workflow version on.
_WorkflowID
[in] The identifier of the workflow to set the latest version for.
_pSettings
[out] Pointer to a pointer of a HPMProjectWorkflowSettings object, representing the returned data. This function will block even in non-blocking mode if this parameter is not NULL.
Return Value
Returns an error code. See EHPMError.
Comments
If you specify a non-NULL pointer to the _pSettings parameter this function will block and the result of the operation will be returned. The returned result must be freed with ObjectFree or a memory leak will result. If you specify a NULL pointer to the _pSettings parameter this function will not block and when the operation is finished you will receive a EHPMChangeCallbackOperation_ProjectWorkflowNewVersion callback.
See Also
HPMSdkFunctions, HPMProjectWorkflowSettings
ProjectWorkflowGetNewestVersion
Gets the newest id version of a workflow in a project.
HPMError ProjectWorkflowGetNewestVersion (
    void * _pSession,
    HPMUniqueID _ProjectID,
    HPMUInt32 _WorkflowID,
    HPMUInt32 * _pNewWorkflowID
    );
Parameters
_pSession
[in] A connected session. See SessionOpen.
_ProjectID
[in] The unique identifier of the project to get the latest workflow version on.
_WorkflowID
[in] The identifier of the workflow to get the latest version for.
_pNewWorkflowID
[out] Pointer to a variable that will receive the identifier of the newest workflow version.
Return Value
Returns an error code. See EHPMError.
See Also
HPMSdkFunctions, HPMProjectWorkflowSettings
ProjectWorkflowEnum
Enumerates workflows in a project.
HPMError ProjectWorkflowEnum (
    void * _pSession,
    HPMUniqueID _ProjectID,
    HPMUInt32 _bOnlyNewestVersions,
    const HPMProjectWorkflowEnum * * _pEnum
    );
Parameters
_pSession
[in] A connected session. See SessionOpen.
_ProjectID
[in] The unique identifier of the project to enumerate workflows for.
_bOnlyNewestVersions
[in] If set to 1 only the newest versions of the workflows are returned.
_pEnum
[out] Pointer to a pointer of a HPMProjectWorkflowEnum object, representing the returned data.
Return Value
Returns an error code. See EHPMError.
Comments
The returned object must be freed with ObjectFree or a memory leak will result.
See Also
HPMSdkFunctions, ObjectFree, HPMProjectWorkflowEnum
ProjectWorkflowEnumWorkflow
Enumerates workflows of a workflow in a project. The result depends on the settings in HPMProjectWorkflowEnumWorkflowProperties.
HPMError ProjectWorkflowEnumWorkflow (
    void * _pSession,
    HPMUniqueID _ProjectID,
    HPMUInt32 _WorkflowID,
    const HPMProjectWorkflowEnumWorkflowProperties * _pWorkflowEnumProperties,
    const HPMProjectWorkflowEnum * * _pEnum
    );
Parameters
_pSession
[in] A connected session. See SessionOpen.
_ProjectID
[in] The unique identifier of the project to enumerate workflows for.
_WorkflowID
[in] The identifier of the workflow to get the workflows for.
_pWorkflowEnumProperties
[in] The properties that sets the conditions of the enumeration.
_pEnum
[out] Pointer to a pointer of a HPMProjectWorkflowEnum object, representing the returned data.
Return Value
Returns an error code. See EHPMError.
Comments
The returned object must be freed with ObjectFree or a memory leak will result.
See Also
HPMSdkFunctions, ObjectFree, HPMProjectWorkflowEnum, HPMProjectWorkflowEnumWorkflowProperties
ProjectWorkflowEnumObject
Enumerates workflow objects of a workflow with a given workflow object id in a project.
HPMError ProjectWorkflowEnumObject (
    void * _pSession,
    HPMUniqueID _ProjectID,
    HPMUInt32 _WorkflowID,
    HPMInt32 _ObjectID,
    const HPMProjectWorkflowEnumObjectProperties * _pWorkflowObjectEnumProperties,
    const HPMProjectWorkflowObjectEnum * * _pEnum
    );
Parameters
_pSession
[in] A connected session. See SessionOpen.
_ProjectID
[in] The unique identifier of the project to enumerate workflows for.
_WorkflowID
[in] The identifier of the workflow to get the old workflows for.
_ObjectID
[in] The identifier of the workflow object id.
_pWorkflowObjectEnumProperties
[in] The properties that sets the conditions of the enumeration.
_pEnum
[out] Pointer to a pointer of a HPMProjectWorkflowObjectEnum object, representing the returned data.
Return Value
Returns an error code. See EHPMError.
Comments
The returned object must be freed with ObjectFree or a memory leak will result.
See Also
HPMSdkFunctions, ObjectFree, HPMProjectWorkflowObjectEnum
ProjectWorkflowCreate
Creates a new workflow in a project.
HPMError ProjectWorkflowCreate (
    void * _pSession,
    HPMUniqueID _ProjectID,
    const HPMProjectWorkflowProperties * _pProperties,
    HPMUInt32 * _pWorkflowID
    );
Parameters
_pSession
[in] A connected session. See SessionOpen.
_ProjectID
[in] The unique identifier of the project to create a new workflow in.
_pProperties
[in] The workflow properties for the workflow to create. See HPMProjectWorkflowProperties.
_pWorkflowID
[out] Pointer to a variable that will receive the identifier of the created workflow. If this parameter is not NULL, the function will block, even in non-blocking operating mode.
Return Value
Returns an error code. See EHPMError.
Comments
The workflow will only be deleted if there are no tasks that reference any version of it. Otherwise it will remain with EHPMProjectWorkflowContainerFlag::EHPMProjectWorkflowContainerFlag_IsDeleted set in HPMProjectWorkflowSettings::_mFlags.
See Also
HPMSdkFunctions, HPMProjectWorkflowProperties, ProjectWorkflowDelete
ProjectWorkflowDelete
Deletes a workflow in a project.
HPMError ProjectWorkflowDelete (
    void * _pSession,
    HPMUniqueID _ProjectID,
    HPMUInt32 _WorkflowID
    );
Parameters
_pSession
[in] A connected session. See SessionOpen.
_ProjectID
[in] The unique identifier of the project to delete workflow in.
_WorkflowID
[in] The identifier of the workflow to delete.
Return Value
Returns an error code. See EHPMError.
See Also
HPMSdkFunctions, ProjectWorkflowCreate
ProjectUtilGetWorkflowProgression
Generates list of possible progression states
HPMError ProjectUtilGetWorkflowProgression (
    void * _pSession,
    HPMUniqueID _ProjectID,
    HPMUInt32 _WorkflowID,
    HPMUniqueID _ResourceID,
    HPMUInt32 _StatusID,
    const HPMWorkflowProgressionStructure * * _pWorkflowProgressionStructure
    );
Parameters
_pSession
[in] A connected session. See SessionOpen.
_ProjectID
[in] The unique identifier of the project to get the workflow progression from.
_WorkflowID
[in] The workflow id to get progression from.
_ResourceID
[in] The unique identifier of the resource to get progression for.
_StatusID
[in] The identifier of the workflow status to progress from.
_pWorkflowProgressionStructure
[out] Pointer to a pointer of a HPMWorkflowProgressionStructure object, representing the returned data.
Return Value
Returns an error code. See EHPMError.
Comments
The returned object must be freed with ObjectFree or a memory leak will result. Note that all the required fields in HPMWorkflowProgressionStructure::m_pProgressionStates are included since no task is available, i.e. no check is made if they are filled in or not. The function will only traverse one level of transitions, i.e. no stacked transitions.
See Also
HPMSdkFunctions, ObjectFree, HPMProjectWorkflows, |
ProjectGetStatisticsSettings
Gets statistics settings for a project.
HPMError ProjectGetStatisticsSettings (
    void * _pSession,
    HPMUniqueID _ProjectID,
    const HPMProjectStatisticsSettings * * _pSettings
    );
Parameters
_pSession
[in] A connected session. See SessionOpen.
_ProjectID
[in] The unique identifier of the project to get statistics settings for.
_pSettings
[out] Pointer to a pointer of a HPMProjectStatisticsSettings object, representing the returned data.
Return Value
Returns an error code. See EHPMError.
Comments
The returned object must be freed with ObjectFree or a memory leak will result.
See Also
HPMSdkFunctions, ObjectFree, HPMProjectStatisticsSettings
ProjectSetStatisticsSettings
Sets statistics settings for a project.
HPMError ProjectSetStatisticsSettings (
    void * _pSession,
    HPMUniqueID _ProjectID,
    const HPMProjectStatisticsSettings * _pSettings
    );
Parameters
_pSession
[in] A connected session. See SessionOpen.
_ProjectID
[in] The unique identifier of the project to set statistics settings on.
_pSettings
[in] The statistics settings to set on the project. See HPMProjectStatisticsSettings.
Return Value
Returns an error code. See EHPMError.
See Also
HPMSdkFunctions, HPMProjectStatisticsSettings
ProjectCustomColumnsGet
Gets custom columns of a project.
HPMError ProjectCustomColumnsGet (
    void * _pSession,
    HPMUniqueID _ProjectID,
    const HPMProjectCustomColumns * * _pColumns
    );
Parameters
_pSession
[in] A connected session. See SessionOpen.
_ProjectID
[in] The unique identifier of the project to get custom columns for.
_pColumns
[out] Pointer to a pointer of a HPMProjectCustomColumns object, representing the returned data.
Return Value
Returns an error code. See EHPMError.
Comments
The returned object must be freed with ObjectFree or a memory leak will result.
See Also
HPMSdkFunctions, ObjectFree, HPMProjectCustomColumns
ProjectCustomColumnsSet
Sets custom columns of a project.
HPMError ProjectCustomColumnsSet (
    void * _pSession,
    HPMProjectCustomColumnChanges const * _pColumnChanges
    );
Parameters
_pSession
[in] A connected session. See SessionOpen.
_pColumnChanges
[in] The changed custom columns to set on the project. See HPMProjectCustomColumnChanges.
Return Value
Returns an error code. See EHPMError.
See Also
HPMSdkFunctions, HPMProjectCustomColumns, HPMProjectCustomColumnChanges
ProjectGetDefaultActivatedColumns
Gets the activated default columns in a project.
HPMError ProjectGetDefaultActivatedColumns (
    void * _pSession,
    HPMUniqueID _ProjectID,
    const HPMProjectDefaultColumns * * _pColumns
    );
Parameters
_pSession
[in] A connected session. See SessionOpen.
_ProjectID
[in] The unique identifier of the project to get active default columns for.
_pColumns
[out] Pointer to a pointer of a HPMProjectDefaultColumns object, representing the returned data.
Return Value
Returns an error code. See EHPMError.
Comments
The returned object must be freed with ObjectFree or a memory leak will result.
See Also
HPMSdkFunctions, ObjectFree, HPMProjectDefaultColumns
ProjectSetDefaultActivatedColumns
Sets the activated default columns in a project.
HPMError ProjectSetDefaultActivatedColumns (
    void * _pSession,
    HPMUniqueID _ProjectID,
    const HPMProjectDefaultColumns * _pColumns
    );
Parameters
_pSession
[in] A connected session. See SessionOpen.
_ProjectID
[in] The unique identifier of the project to set active default columns for.
_pColumns
[in] The active columns to enable in the project. See HPMProjectDefaultColumns.
Return Value
Returns an error code. See EHPMError.
See Also
HPMSdkFunctions, HPMProjectDefaultColumns
ProjectGetSettings
Gets settings for a project.
HPMError ProjectGetSettings (
    void * _pSession,
    HPMUniqueID _ProjectID,
    const HPMProjectSettings * * _pSettings
    );
Parameters
_pSession
[in] A connected session. See SessionOpen.
_ProjectID
[in] The unique identifier of the project to get settings for.
_pSettings
[out] Pointer to a pointer of a HPMProjectSettings object, representing the returned data.
Return Value
Returns an error code. See EHPMError.
Comments
The returned object must be freed with ObjectFree or a memory leak will result.
See Also
HPMSdkFunctions, ObjectFree, HPMProjectSettings
ProjectSetSettings
Sets settings for a project.
HPMError ProjectSetSettings (
    void * _pSession,
    HPMUniqueID _ProjectID,
    const HPMProjectSettings * _pSettings
    );
Parameters
_pSession
[in] A connected session. See SessionOpen.
_ProjectID
[in] The unique identifier of the project to set settings on.
_pSettings
[in] The settings to set on the project. See HPMProjectSettings.
Return Value
Returns an error code. See EHPMError.
See Also
HPMSdkFunctions, HPMProjectSettings
ProjectGetEmailSettings
Gets email settings for a project.
HPMError ProjectGetEmailSettings (
    void * _pSession,
    HPMUniqueID _ProjectID,
    const HPMProjectEmailSettings * * _pSettings
    );
Parameters
_pSession
[in] A connected session. See SessionOpen.
_ProjectID
[in] The unique identifier of the project to get email setting for.
_pSettings
[out] Pointer to a pointer of a HPMProjectEmailSettings object, representing the returned data.
Return Value
Returns an error code. See EHPMError.
Comments
The returned object must be freed with ObjectFree or a memory leak will result.
See Also
HPMSdkFunctions, ObjectFree, HPMProjectEmailSettings
ProjectSetEmailSettings
Sets email setting on a project.
HPMError ProjectSetEmailSettings (
    void * _pSession,
    HPMUniqueID _ProjectID,
    const HPMProjectEmailSettings * _pSettings
    );
Parameters
_pSession
[in] A connected session. See SessionOpen.
_ProjectID
[in] The unique identifier of the project to set email settings on.
_pSettings
[in] The email settings to set on the project. See HPMProjectEmailSettings.
Return Value
Returns an error code. See EHPMError.
See Also
HPMSdkFunctions, HPMProjectEmailSettings
ProjectGetWallSettings
Gets wall settings for a project when the wall is in non Kanban mode.
HPMError ProjectGetWallSettings (
    void * _pSession,
    HPMUniqueID _ProjectID,
    const HPMProjectWallSettings * * _pSettings
    );
Parameters
_pSession
[in] A connected session. See SessionOpen.
_ProjectID
[in] The unique identifier of the project to get wall settings for. Currently only backlog project identifiers are valid here.
_pSettings
[out] Pointer to a pointer of a HPMProjectWallSettings object, representing the returned data.
Return Value
Returns an error code. See EHPMError.
Comments
The returned object must be freed with ObjectFree or a memory leak will result.
See Also
HPMSdkFunctions, ObjectFree, HPMProjectWallSettings
ProjectSetWallSettings
Sets wall setting on a project when the wall is in non Kanban mode.
HPMError ProjectSetWallSettings (
    void * _pSession,
    HPMUniqueID _ProjectID,
    const HPMProjectWallSettings * _pSettings
    );
Parameters
_pSession
[in] A connected session. See SessionOpen.
_ProjectID
[in] The unique identifier of the project to set wall settings on. Currently only backlog project identifiers are valid here.
_pSettings
[in] The wall settings to set on the project. See HPMProjectWallSettings.
Return Value
Returns an error code. See EHPMError.
See Also
HPMSdkFunctions, HPMProjectWallSettings
ProjectGetWallGroups
Gets wall groups for a project.
HPMError ProjectGetWallGroups (
    void * _pSession,
    HPMUniqueID _ProjectID,
    const HPMProjectWallGroups * * _pSettings
    );
Parameters
_pSession
[in] A connected session. See SessionOpen.
_ProjectID
[in] The unique identifier of the project to get wall groups for. Currently only backlog project identifiers are valid here.
_pSettings
[out] Pointer to a pointer of a HPMProjectWallGroups object, representing the returned data.
Return Value
Returns an error code. See EHPMError.
Comments
The returned object must be freed with ObjectFree or a memory leak will result.
See Also
HPMSdkFunctions, ObjectFree, HPMProjectWallGroups
ProjectSetWallGroups
Sets wall groups on a project.
HPMError ProjectSetWallGroups (
    void * _pSession,
    HPMUniqueID _ProjectID,
    const HPMProjectWallGroups * _pSettings
    );
Parameters
_pSession
[in] A connected session. See SessionOpen.
_ProjectID
[in] The unique identifier of the project to set wall groups on. Currently only backlog project identifiers are valid here.
_pSettings
[in] The wall groups to set on the project. See HPMProjectWallGroups.
Return Value
Returns an error code. See EHPMError.
See Also
HPMSdkFunctions, HPMProjectWallGroups
ProjectGetDetailedAccessRules
Gets detailed access rules for a project.
HPMError ProjectGetDetailedAccessRules (
    void * _pSession,
    HPMUniqueID _ProjectID,
    const HPMProjectDetailedAccessRules * * _pSettings
    );
Parameters
_pSession
[in] A connected session. See SessionOpen.
_ProjectID
[in] The unique identifier of the project to get detailed access rules for. Currently only QA project identifiers are valid here.
_pSettings
[out] Pointer to a pointer of a HPMProjectDetailedAccessRules object, representing the returned data.
Return Value
Returns an error code. See EHPMError.
Comments
The returned object must be freed with ObjectFree or a memory leak will result.
See Also
HPMSdkFunctions, ObjectFree, HPMProjectDetailedAccessRules
ProjectSetDetailedAccessRules
Sets detailed access rules on a project.
HPMError ProjectSetDetailedAccessRules (
    void * _pSession,
    HPMUniqueID _ProjectID,
    const HPMProjectDetailedAccessRules * _pSettings
    );
Parameters
_pSession
[in] A connected session. See SessionOpen.
_ProjectID
[in] The unique identifier of the project to set detailed access rules for. Currently only QA project identifiers are valid here.
_pSettings
[in] The detailed access rules to set on the project. See HPMProjectDetailedAccessRules.
Return Value
Returns an error code. See EHPMError.
See Also
HPMSdkFunctions, HPMProjectDetailedAccessRules
ProjectGetColumnResourcePermissionRules
Gets column resource permission rules for a project.
HPMError ProjectGetColumnResourcePermissionRules (
    void * _pSession,
    HPMUniqueID _ProjectID,
    HPMProjectColumnResourcePermissionRules const * * _pSettings
    );
Parameters
_pSession
[in] A connected session. See SessionOpen.
_ProjectID
[in] The unique identifier of the project to get permission rules for. Currently only Planning project identifiers are valid here.
_pSettings
[out] Pointer to a pointer of a HPMProjectColumnResourcePermissionRules object, representing the returned data.
Return Value
Returns an error code. See EHPMError.
Comments
The returned object must be freed with ObjectFree or a memory leak will result.
See Also
HPMSdkFunctions, ObjectFree, HPMProjectColumnResourcePermissionRules
ProjectSetColumnResourcePermissionRules
Sets column resource permission rules on a project.
HPMError ProjectSetColumnResourcePermissionRules (
    void * _pSession,
    HPMUniqueID _ProjectID,
    HPMProjectColumnResourcePermissionRules const * _pSettings
    );
Parameters
_pSession
[in] A connected session. See SessionOpen.
_ProjectID
[in] The unique identifier of the project to set permission rules for. Currently only Planning project identifiers are valid here.
_pSettings
[in] The column resource permission rules to set on the project. See HPMProjectColumnResourcePermissionRules.
Return Value
Returns an error code. See EHPMError.
See Also
HPMSdkFunctions, HPMProjectColumnResourcePermissionRules
ProjectGetReport
Gets a report for a report id in a project.
HPMError ProjectGetReport (
    void * _pSession,
    HPMUniqueID _ProjectID,
    HPMUniqueID _ResourceID,
    HPMUniqueID _ReportID,
    const HPMReport * * _pSettings
    );
Parameters
_pSession
[in] A connected session. See SessionOpen.
_ProjectID
[in] The unique identifier of the project to get the report in.
_ResourceID
[in] The unique identifier of the resource that created the report to get.
_ReportID
[in] The unique identifier of the report to get.
_pSettings
[out] Pointer to a pointer of a HPMReport object, representing the returned data.
Return Value
Returns an error code. See EHPMError.
Comments
The returned object must be freed with ObjectFree or a memory leak will result.
See Also
HPMSdkFunctions, ObjectFree, HPMReport
ProjectGetReports
Gets reports for a project.
HPMError ProjectGetReports (
    void * _pSession,
    HPMUniqueID _ProjectID,
    HPMUniqueID _ResourceID,
    const HPMReports * * _pSettings
    );
Parameters
_pSession
[in] A connected session. See SessionOpen.
_ProjectID
[in] The unique identifier of the project to get reports for.
_ResourceID
[in] The unique identifier of the resource to get reports for.
_pSettings
[out] Pointer to a pointer of a HPMReports object, representing the returned data.
Return Value
Returns an error code. See EHPMError.
Comments
The returned object must be freed with ObjectFree or a memory leak will result.
See Also
HPMSdkFunctions, ObjectFree, HPMReports
ProjectSetReports
Sets reports for a project.
HPMError ProjectSetReports (
    void * _pSession,
    HPMUniqueID _ProjectID,
    HPMUniqueID _ResourceID,
    const HPMReports * _pSettings
    );
Parameters
_pSession
[in] A connected session. See SessionOpen.
_ProjectID
[in] The unique identifier of the project to set reports for.
_ResourceID
[in] The unique identifier of the resource to set reports for.
_pSettings
[in] The reports to set on the project. See HPMReports.
Return Value
Returns an error code. See EHPMError.
Comments
Changes made in submitted reports will not show up in the Helix Plan client for users that are logged in. This will be fixed in a later release.
See Also
ProjectEnumReportResources
Enumerates resources that have created reports.
HPMError ProjectEnumReportResources (
    void * _pSession,
    HPMUniqueID _ProjectID,
    const HPMResourceEnum * * _pEnum
    );
Parameters
_pSession
[in] A connected session. See SessionOpen.
_ProjectID
[in] The unique identifier of the project to get resources for.
_pEnum
[out] Pointer to a pointer of a HPMResourceEnum object, representing the returned data.
Return Value
Returns an error code. See EHPMError.
Comments
The returned object must be freed with ObjectFree or a memory leak will result.
See Also
HPMSdkFunctions, ObjectFree, HPMResourceEnum
ProjectGetWorkflowStatusStats
Gets bug status statistics for a workflow status in a project.
HPMError ProjectGetWorkflowStatusStats (
    void * _pSession,
    HPMUniqueID _ProjectID,
    HPMUInt32 _WorkflowID,
    HPMUInt32 _WorkflowStatusID,
    const HPMProjectWorkflowStatusStats * * _pSettings
    );
Parameters
_pSession
[in] A connected session. See SessionOpen.
_ProjectID
[in] The unique identifier of the project to get workflow status statistics for.
_WorkflowID
[in] The workflow where the status exist.
_WorkflowStatusID
[in] The identifier of the workflow status to get statistics for.
_pSettings
[out] Pointer to a pointer of a HPMProjectWorkflowStatusStats object, representing the returned data.
Return Value
Returns an error code. See EHPMError.
Comments
The returned object must be freed with ObjectFree or a memory leak will result.
See Also
HPMSdkFunctions, ObjectFree, HPMProjectWorkflowStatusStats
ProjectGetCustomStatisticsSettings
Gets custom trends settings for a project.
HPMError ProjectGetCustomStatisticsSettings (
    void * _pSession,
    HPMUniqueID _ProjectID,
    const HPMProjectCustomStatisticsSettings * * _pSettings
    );
Parameters
_pSession
[in] A connected session. See SessionOpen.
_ProjectID
[in] The unique identifier of the project to get custom trends settings for.
_pSettings
[out] Pointer to a pointer of a HPMProjectCustomStatisticsSettings object, representing the returned data.
Return Value
Returns an error code. See EHPMError.
Comments
The returned object must be freed with ObjectFree or a memory leak will result.
See Also
HPMSdkFunctions, ObjectFree, HPMProjectCustomStatisticsSettings
ProjectSetCustomStatisticsSettings
Sets custom trends settings for a project.
HPMError ProjectSetCustomStatisticsSettings (
    void * _pSession,
    HPMUniqueID _ProjectID,
    const HPMProjectCustomStatisticsSettings * _pSettings
    );
Parameters
_pSession
[in] A connected session. See SessionOpen.
_ProjectID
[in] The unique identifier of the project to set custom trends settings for.
_pSettings
[in] The detailed access rules to set on the project. See HPMProjectCustomStatisticsSettings.
Return Value
Returns an error code. See EHPMError.
See Also
HPMSdkFunctions, HPMProjectCustomStatisticsSettings
ProjectUtilGetWorkflowStructure
Generates a workflow structure from a number of workflows.
HPMError ProjectUtilGetWorkflowStructure (
    void * _pSession,
    HPMUniqueID _ProjectID,
    HPMUInt32 _WorkflowID,
    const HPMProjectWorkflowStructure * * _pWorkflowStructure
    );
Parameters
_pSession
[in] A connected session. See SessionOpen.
_ProjectID
[in] The unique identifier of the project to generate a workflow structure in.
_WorkflowID
[in] Defines the workflow to start generating tasks from. Must be contained in the workflows defined in _pWorkflowStructure.
_pWorkflowStructure
[out] Pointer to a pointer of a HPMProjectWorkflowStructure object, representing the returned data.
Return Value
Returns an error code. See EHPMError.
Comments
The returned object must be freed with ObjectFree or a memory leak will result.
See Also
HPMSdkFunctions, ObjectFree, HPMProjectWorkflows, HPMProjectWorkflows, HPMProjectWorkflowStructure
ProjectGetCompletionStyle
Gets the completion style of a project.
HPMError ProjectGetCompletionStyle (
    void * _pSession,
    HPMUniqueID _ProjectID,
    HPMUInt32 * _pStyle
    );
Parameters
_pSession
[in] A connected session. See SessionOpen.
_ProjectID
[in] The unique identifier of the project to get the completion style of.
_pStyle
[out] Pointer to a variable that receive the completion style. Will be one of EHPMProjectTaskCompletionStyle.
Return Value
Returns an error code. See EHPMError.
See Also
HPMSdkFunctions, EHPMProjectTaskCompletionStyle
ProjectGetCustomSettingsValue
Gets the value of a project custom setting.
HPMError ProjectGetCustomSettingsValue (
    void * _pSession,
    HPMInt32 _SettingType,
    HPMUniqueID _ProjectID,
    const HPMChar * _pIdentifier,
    const HPMChar * _pSettingPath,
    const HPMCustomSettingValue * * _pData
    );
Parameters
_pSession
[in] A connected session. See SessionOpen.
_SettingType
[in] The type of the setting. Can be one of EHPMCustomSettingsType. Currently if the project ID points to a backlog or QA sub project EHPMCustomSettingsType_Admin is not valid for this function.
_ProjectID
[in] The project to get custom settings value for.
_pIdentifier
[in] The identifier of the integration. This value is used to isolate the custom settings of different integrations.
_pSettingPath
[in] The setting path to get the setting for.
_pData
[out] Pointer to a pointer of a HPMCustomSettingValue object, representing the returned data.
Return Value
Returns an error code. See EHPMError.
Comments
The returned object must be freed with ObjectFree or a memory leak will result.
See Also
HPMSdkFunctions, ObjectFree, HPMCustomSettingValue, GlobalRegisterCustomSettings, ProjectSetCustomSettingsValue, EHPMCustomSettingsType
ProjectSetCustomSettingsValue
Sets the value of a project custom setting.
HPMError ProjectSetCustomSettingsValue (
    void * _pSession,
    HPMInt32 _SettingType,
    HPMUniqueID _ProjectID,
    const HPMChar * _pIdentifier,
    const HPMChar * _pSettingPath,
    const HPMCustomSettingValue * _pData
    );
Parameters
_pSession
[in] A connected session. See SessionOpen.
_SettingType
[in] The type of the setting. Can be one of EHPMCustomSettingsType. Currently if the project ID points to a backlog or QA sub project EHPMCustomSettingsType_Admin is not valid for this function.
_ProjectID
[in] The project to set custom settings value for.
_pIdentifier
[in] The identifier of the integration. This value is used to isolate the custom settings of different integrations.
_pSettingPath
[in] The setting path to get the setting for.
_pData
[in] The custom settings value to set. If HPMCustomSettingValue::m_bIsDefault is set to false when setting a value the value is removed.
Return Value
Returns an error code. See EHPMError.
See Also
HPMSdkFunctions, ObjectFree, HPMCustomSettingValue GlobalRegisterCustomSettings, ProjectGetCustomSettingsValue, EHPMCustomSettingsType
ProjectGetSDKInternalData
Gets project SDK internal data.
HPMError ProjectGetSDKInternalData (
    void * _pSession,
    HPMUniqueID _ProjectID,
    const HPMChar * _pIdentifier,
    const HPMSDKInternalData * * _pData
    );
Parameters
_pSession
[in] A connected session. See SessionOpen.
_ProjectID
[in] The project to get SDK internal data for.
_pIdentifier
[in] The identifier of SDK internal data. This value is used to isolate the SDK internal data of different integrations.
_pData
[out] Pointer to a pointer of a HPMSDKInternalData object, representing the returned data.
Return Value
Returns an error code. See EHPMError.
Comments
The returned object must be freed with ObjectFree or a memory leak will result.
See Also
HPMSdkFunctions, ObjectFree, HPMSDKInternalData, ProjectSetSDKInternalData
ProjectSetSDKInternalData
Sets project SDK internal data.
HPMError ProjectSetSDKInternalData (
    void * _pSession,
    HPMUniqueID _ProjectID,
    const HPMChar * _pIdentifier,
    const HPMSDKInternalData * _pData
    );
Parameters
_pSession
[in] A connected session. See SessionOpen.
_ProjectID
[in] The project to set SDK internal data for.
_pIdentifier
[in] The identifier of SDK internal data. This value is used to isolate the SDK internal data of different integrations.
_pData
[in] The SDK internal data to set. If set to NULL the value will be set to its default value. See HPMSDKInternalData.
Return Value
Returns an error code. See EHPMError.
See Also
HPMSdkFunctions, ObjectFree, HPMSDKInternalData ProjectGetSDKInternalData
ProjectResourceAdd
Adds a resource to be a member of a project.
HPMError ProjectResourceAdd (
    void * _pSession,
    HPMUniqueID _ProjectID,
    HPMUniqueID _ResourceId,
    const HPMProjectResourceProperties * _pProperties
    );
Parameters
_pSession
[in] A connected session. See SessionOpen.
_ProjectID
[in] The unique identifier of the project to add a resource to.
_ResourceId
[in] The unique identifier of the resource to add as a member of the project.
_pProperties
[in] The properties of the resource member in this project. See HPMProjectResourceProperties
Return Value
Returns an error code. See EHPMError.
See Also
HPMSdkFunctions, HPMProjectResourceProperties
ProjectResourceRemove
Removes a resource from beeing a member of a project.
HPMError ProjectResourceRemove (
    void * _pSession,
    HPMUniqueID _ProjectID,
    HPMUniqueID _ResourceId
    );
Parameters
_pSession
[in] A connected session. See SessionOpen.
_ProjectID
[in] The unique identifier of the project to remove a resource from.
_ResourceId
[in] The unique identifier of the resource to remove from being a member of the project.
Return Value
Returns an error code. See EHPMError.
See Also
ProjectResourceEnum
Enumerates the resource members of a project.
HPMError ProjectResourceEnum (
    void * _pSession,
    HPMUniqueID _ProjectID,
    const HPMProjectResourceEnum * * _pEnum
    );
Parameters
_pSession
[in] A connected session. See SessionOpen.
_ProjectID
[in] The unique identifier of the project to enumerate members in.
_pEnum
[out] Pointer to a pointer of a HPMProjectResourceEnum object, representing the returned data.
Return Value
Returns an error code. See EHPMError.
Comments
The returned object must be freed with ObjectFree or a memory leak will result.
See Also
HPMSdkFunctions, ObjectFree, HPMProjectResourceEnum
ProjectResourceGroupAdd
Adds a resource group to be a member of a project.
HPMError ProjectResourceGroupAdd (
    void * _pSession,
    HPMUniqueID _ProjectID,
    HPMUniqueID _GroupID
    );
Parameters
_pSession
[in] A connected session. See SessionOpen.
_ProjectID
[in] The unique identifier of the project to add a resource to.
_GroupID
[in] The unique identifier of the resource group to add as a member of the project.
Return Value
Returns an error code. See EHPMError.
See Also
ProjectResourceGroupRemove
Removes a resource group from being a member of a project.
HPMError ProjectResourceGroupRemove (
    void * _pSession,
    HPMUniqueID _ProjectID,
    HPMUniqueID _GroupID
    );
Parameters
_pSession
[in] A connected session. See SessionOpen.
_ProjectID
[in] The unique identifier of the project to remove a resource from.
_GroupID
[in] The unique identifier of the resource group to remove from being a member of the project.
Return Value
Returns an error code. See EHPMError.
See Also
ProjectResourceGroupEnum
Enumerates the resource group members of a project.
HPMError ProjectResourceGroupEnum (
    void * _pSession,
    HPMUniqueID _ProjectID,
    const HPMProjectResourceEnum * * _pEnum
    );
Parameters
_pSession
[in] A connected session. See SessionOpen.
_ProjectID
[in] The unique identifier of the project to enumerate members in.
_pEnum
[out] Pointer to a pointer of a HPMProjectResourceEnum object, representing the returned data.
Return Value
Returns an error code. See EHPMError.
Comments
The returned object must be freed with ObjectFree or a memory leak will result.
See Also
HPMSdkFunctions, ObjectFree, HPMProjectResourceEnum
ProjectResourceGetProperties
Gets the properties for a resource in a project.
HPMError ProjectResourceGetProperties (
    void * _pSession,
    HPMUniqueID _ProjectID,
    HPMUniqueID _ResourceId,
    const HPMProjectResourceProperties * * _pProperties
    );
Parameters
_pSession
[in] A connected session. See SessionOpen.
_ProjectID
[in] The unique identifier of the project to get resource properties in.
_ResourceId
[in] The unique identifier of the resource to get properties of.
_pProperties
[out] Pointer to a pointer of a HPMProjectResourceProperties object, representing the returned data.
Return Value
Returns an error code. See EHPMError.
Comments
The returned object must be freed with ObjectFree or a memory leak will result.
See Also
HPMSdkFunctions, ObjectFree, HPMProjectResourceProperties
ProjectResourceSetProperties
Sets the properties for a resource in a project.
HPMError ProjectResourceSetProperties (
    void * _pSession,
    HPMUniqueID _ProjectID,
    HPMUniqueID _ResourceId,
    const HPMProjectResourceProperties * _pProperties
    );
Parameters
_pSession
[in] A connected session. See SessionOpen.
_ProjectID
[in] The unique identifier of the project to set resource properties in.
_ResourceId
[in] The unique identifier of the resource to set properties for.
_pProperties
[in] The properties to set for the resource in the project. See HPMProjectResourceProperties.
Return Value
Returns an error code. See EHPMError.
See Also
HPMSdkFunctions, HPMProjectResourceProperties
ProjectResourceGetParentTaskDisplayDepth
Gets the value of parent task display depth for a resource in a project.
HPMError ProjectResourceGetParentTaskDisplayDepth (
    void * _pSession,
    HPMUniqueID _ProjectID,
    HPMUniqueID _UserID,
    HPMInt32 * _pParentTaskDisplayDepthValue
    );
Parameters
_pSession
[in] A connected session. See SessionOpen.
_ProjectID
[in] The unique identifier of the project to get resource parent task display depth in.
_UserID
[in] The unique identifier of the resource to get parent task display depth of.
_pParentTaskDisplayDepthValue
[out] The value of parent task display depth to get.
Return Value
Returns an error code. See EHPMError.
See Also
HPMSdkFunctions, ProjectViewPresetApply , ProjectResourceSetParentTaskDisplayDepth
ProjectResourceSetParentTaskDisplayDepth
Sets the value of parent task display depth for a resource in a project.
HPMError ProjectResourceSetParentTaskDisplayDepth (
    void * _pSession,
    HPMUniqueID _ProjectID,
    HPMUniqueID _UserID,
    HPMInt32 _pParentTaskDisplayDepthValue
    );
Parameters
_pSession
[in] A connected session. See SessionOpen.
_ProjectID
[in] The unique identifier of the project to get resource parent task display depth in.
_UserID
[in] The unique identifier of the resource to get parent task display depth of.
_pParentTaskDisplayDepthValue
[in] The value of parent task display depth to set.
Return Value
Returns an error code. See EHPMError.
See Also
HPMSdkFunctions, ProjectViewPresetApply , ProjectResourceGetParentTaskDisplayDepth
ProjectResourceGetCustomSettingsValue
Gets the value of a project resource custom setting.
HPMError ProjectResourceGetCustomSettingsValue (
    void * _pSession,
    HPMInt32 _SettingType,
    HPMUniqueID _ProjectID,
    HPMUniqueID _ResourceID,
    const HPMChar * _pIdentifier,
    const HPMChar * _pSettingPath,
    const HPMCustomSettingValue * * _pData
    );
Parameters
_pSession
[in] A connected session. See SessionOpen.
_SettingType
[in] The type of the setting. Can be one of EHPMCustomSettingsType. Currently only EHPMCustomSettingsType_Admin is valid for this function.
_ProjectID
[in] The project to get custom settings value for. Must be a real project id, and not a backlog or QA project.
_ResourceID
[in] The resource id to get custom settings value for.
_pIdentifier
[in] The identifier of the integration. This value is used to isolate the custom settings of different integrations.
_pSettingPath
[in] The setting path to get the setting for.
_pData
[out] Pointer to a pointer of a HPMCustomSettingValue object, representing the returned data.
Return Value
Returns an error code. See EHPMError.
Comments
The returned object must be freed with ObjectFree or a memory leak will result.
See Also
HPMSdkFunctions, ObjectFree, HPMCustomSettingValue, GlobalRegisterCustomSettings, ProjectResourceSetCustomSettingsValue, EHPMCustomSettingsType
ProjectResourceSetCustomSettingsValue
Sets the value of a project resource custom setting.
HPMError ProjectResourceSetCustomSettingsValue (
    void * _pSession,
    HPMInt32 _SettingType,
    HPMUniqueID _ProjectID,
    HPMUniqueID _ResourceID,
    const HPMChar * _pIdentifier,
    const HPMChar * _pSettingPath,
    const HPMCustomSettingValue * _pData
    );
Parameters
_pSession
[in] A connected session. See SessionOpen.
_SettingType
[in] The type of the setting. Can be one of EHPMCustomSettingsType. Currently only EHPMCustomSettingsType_Admin is valid for this function.
_ProjectID
[in] The project to set custom settings value for. Must be a real project id, and not a backlog or QA project.
_ResourceID
[in] The resource id to set custom settings value for.
_pIdentifier
[in] The identifier of the integration. This value is used to isolate the custom settings of different integrations.
_pSettingPath
[in] The setting path to get the setting for.
_pData
[in] The custom settings value to set. If set to NULL the value will be set to its default value. See HPMCustomSettingValue.
Return Value
Returns an error code. See EHPMError.
See Also
HPMSdkFunctions, ObjectFree, HPMCustomSettingValue GlobalRegisterCustomSettings, ProjectResourceGetCustomSettingsValue, EHPMCustomSettingsType
ProjectResourceGetSDKInternalData
Gets project resource SDK internal data.
HPMError ProjectResourceGetSDKInternalData (
    void * _pSession,
    HPMUniqueID _ProjectID,
    HPMUniqueID _ResourceID,
    const HPMChar * _pIdentifier,
    const HPMSDKInternalData * * _pData
    );
Parameters
_pSession
[in] A connected session. See SessionOpen.
_ProjectID
[in] The project to get SDK internal data for. Must be a real project id, and not a backlog or QA project.
_ResourceID
[in] The resource id to get SDK internal data for.
_pIdentifier
[in] The identifier of SDK internal data. This value is used to isolate the SDK internal data of different integrations.
_pData
[out] Pointer to a pointer of a HPMSDKInternalData object, representing the returned data.
Return Value
Returns an error code. See EHPMError.
Comments
The returned object must be freed with ObjectFree or a memory leak will result.
See Also
HPMSdkFunctions, ObjectFree, HPMSDKInternalData, ProjectResourceSetSDKInternalData
ProjectResourceSetSDKInternalData
Sets project resource SDK internal data.
HPMError ProjectResourceSetSDKInternalData (
    void * _pSession,
    HPMUniqueID _ProjectID,
    HPMUniqueID _ResourceID,
    const HPMChar * _pIdentifier,
    const HPMSDKInternalData * _pData
    );
Parameters
_pSession
[in] A connected session. See SessionOpen.
_ProjectID
[in] The project to set SDK internal data for. Must be a real project id, and not a backlog or QA project.
_ResourceID
[in] The resource id to set SDK internal data for.
_pIdentifier
[in] The identifier of SDK internal data. This value is used to isolate the SDK internal data of different integrations.
_pData
[in] The SDK internal data to set. See HPMSDKInternalData.
Return Value
Returns an error code. See EHPMError.
See Also
HPMSdkFunctions, ObjectFree, HPMSDKInternalData ProjectResourceGetSDKInternalData
ProjectResourceUtilIsMember
Checks if a resource is member of a project.
HPMError ProjectResourceUtilIsMember (
    void * _pSession,
    HPMUniqueID _ProjectID,
    HPMUniqueID _ResourceID,
    HPMInt32 * _pReturn
    );
Parameters
_pSession
[in] A connected session. See SessionOpen.
_ProjectID
[in] The unique identifier of the project to check in.
_ResourceID
[in] The resource id to to check for membership.
_pReturn
[out] Returns 1 if the resource is a member 0 otherwise.
Return Value
Returns an error code. See EHPMError.
See Also
ProjectUtilGetBacklog
Gets the unique identifier of the backlog project of a project.
HPMError ProjectUtilGetBacklog (
    void * _pSession,
    HPMUniqueID _ProjectID,
    HPMUniqueID * _pReturn
    );
Parameters
_pSession
[in] A connected session. See SessionOpen.
_ProjectID
[in] The unique identifier of the project to get the backlog project for.
_pReturn
[out] Returns the unique identifier of the backlog project.
Return Value
Returns an error code. See EHPMError.
See Also
ProjectUtilGetQA
Gets the unique identifier of the QA project of a project.
HPMError ProjectUtilGetQA (
    void * _pSession,
    HPMUniqueID _ProjectID,
    HPMUniqueID * _pReturn
    );
Parameters
_pSession
[in] A connected session. See SessionOpen.
_ProjectID
[in] The unique identifier of the project to get the QA project for.
_pReturn
[out] Returns the unique identifier of the QA project.
Return Value
Returns an error code. See EHPMError.
See Also
ProjectUtilIsArchived
Checks if a project is archived.
HPMError ProjectUtilIsArchived (
    void * _pSession,
    HPMUniqueID _ProjectID,
    HPMInt32 * _pReturn
    );
Parameters
_pSession
[in] A connected session. See SessionOpen.
_ProjectID
[in] The unique identifier of the project to check if it is archived.
_pReturn
[out] Returns 1 if the project is archived 0 otherwise.
Return Value
Returns an error code. See EHPMError.
See Also
ProjectGetAgilePriorityCustomColumn
Gets the agile priority custom column hash or 0 if not set.
HPMError ProjectGetAgilePriorityCustomColumn (
    void * _pSession,
    HPMUniqueID _ProjectID,
    HPMUInt32 * _pData
    );
Parameters
_pSession
[in] A connected session. See SessionOpen.
_ProjectID
[in] The unique identifier of the project to get the agile priority custom column in.
_pData
[out] Pointer to a variable that will receive the custom column hash.
Return Value
Returns an error code. See EHPMError.
See Also
HPMSdkFunctions, EHPMTaskAgilePriorityCategory
ProjectSetAgilePriorityCustomColumn
Sets the agile priority custom column.
HPMError ProjectSetAgilePriorityCustomColumn (
    void * _pSession,
    HPMUniqueID _ProjectID,
    HPMUInt32 _Data
    );
Parameters
_pSession
[in] A connected session. See SessionOpen.
_ProjectID
[in] The unique identifier of the task to set the priority for.
_Data
[in] The hash of the custom column to set as agile priority column to set.
Return Value
Returns an error code. See EHPMError.
See Also
HPMSdkFunctions, EHPMTaskAgilePriorityCategory
ProjectGetCustomColumn
Gets a custom column.
HPMError ProjectGetCustomColumn (
    void * _pSession,
    HPMUniqueID _ProjectID,
    HPMUInt32 _ColumnHash,
    const HPMProjectCustomColumnsColumn * * _pCustomColumn
    );
Parameters
_pSession
[in] A connected session. See SessionOpen.
_ProjectID
[in] The unique identifier of the project to get the custom column in. If set to an invalid project id, only the values in HPMProjectCustomColumnsColumn common to all columns with the same hash, i.e. the hash values m_Hash, m_Type, m_pName, m_pUnit and m_pDropListItems will be set correctly, the other values will be default values
_ColumnHash
[in] The hash of the custom column.
_pCustomColumn
[out] Pointer to a pointer of a HPMProjectCustomColumnsColumn object, representing the returned data.
Return Value
Returns an error code. See EHPMError.
Comments
The returned object must be freed with ObjectFree or a memory leak will result.
See Also
HPMSdkFunctions, ObjectFree, HPMProjectCustomColumnsColumn
ProjectGetOldCustomColumn
Gets a custom column for a hash value of an old project column.
HPMError ProjectGetOldCustomColumn (
    void * _pSession,
    HPMUniqueID _ProjectID,
    HPMUInt32 _ColumnHash,
    const HPMProjectCustomColumnsColumn * * _pCustomColumn
    );
Parameters
_pSession
[in] A connected session. See SessionOpen.
_ProjectID
[in] The unique identifier of the project to get the custom column in.
_ColumnHash
[in] The hash of a deleted custom column.
_pCustomColumn
[out] Pointer to a pointer of a HPMProjectCustomColumnsColumn object, representing the returned data.
Return Value
Returns an error code. See EHPMError.
Comments
The returned object must be freed with ObjectFree or a memory leak will result.
See Also
HPMSdkFunctions, ObjectFree, HPMProjectCustomColumnsColumn
ProjectGetCustomColumnAncestry
Gets the ancestry for a custom column in a project.
HPMError ProjectGetCustomColumnAncestry (
    void * _pSession,
    HPMUniqueID _ProjectID,
    HPMUInt32 _ColumnHash,
    const HPMProjectCustomColumnAncestry * * _pAncestry
    );
Parameters
_pSession
[in] A connected session. See SessionOpen.
_ProjectID
[in] The unique identifier of the project when the custom column exists
_ColumnHash
[in] The column hash of the column to get ancestry for
_pAncestry
[out] Pointer to a pointer of a HPMProjectCustomColumnAncestry object, representing the returned data.
Return Value
Returns an error code. See EHPMError.
See Also
HPMSdkFunctions, HPMProjectCustomColumnAncestry
ProjectGetDefaultActivatedNonHidableColumns
Gets the default activated columns in a project.
HPMError ProjectGetDefaultActivatedNonHidableColumns (
    void * _pSession,
    HPMUniqueID _ProjectID,
    HPMUInt32 _Flags,
    const HPMProjectDefaultColumns * * _pColumns
    );
Parameters
_pSession
[in] A connected session. See SessionOpen.
_ProjectID
[in] The unique identifier of the project to get the default activated columns for.
_Flags
[in] Flags specifying which columns to get. Can be any combination of EHPMProjectGetDefaultActivatedNonHidableColumnsFlag.
_pColumns
[out] Pointer to a pointer of a HPMProjectDefaultColumns object, representing the returned data.
Return Value
Returns an error code. See EHPMError.
Comments
The returned object must be freed with ObjectFree or a memory leak will result. These are the default activated columns in a project that cannot be hidden. They are not included in the list returned by ProjectGetDefaultActivatedColumns
See Also
HPMSdkFunctions, ObjectFree, HPMProjectDefaultColumns, EHPMProjectGetDefaultActivatedNonHidableColumnsFlag
ProjectGetDefaultAvailableColumns
Gets all available default columns in a project.
HPMError ProjectGetDefaultAvailableColumns (
    void * _pSession,
    HPMUniqueID _ProjectID,
    const HPMProjectDefaultColumns * * _pColumns
    );
Parameters
_pSession
[in] A connected session. See SessionOpen.
_ProjectID
[in] The unique identifier of the project to get all available default columns for.
_pColumns
[out] Pointer to a pointer of a HPMProjectDefaultColumns object, representing the returned data.
Return Value
Returns an error code. See EHPMError.
Comments
The returned object must be freed with ObjectFree or a memory leak will result. The columns in ProjectGetDefaultActivatedNonHidableColumns are not included.
See Also
HPMSdkFunctions, ObjectFree, HPMProjectDefaultColumns
ProjectCalendarGetWorkingDays
Gets the calendar working days in a project.
HPMError ProjectCalendarGetWorkingDays (
    void * _pSession,
    HPMUniqueID _ProjectID,
    const HPMWorkingDays * * _pWorkingDays
    );
Parameters
_pSession
[in] A connected session. See SessionOpen.
_ProjectID
[in] The unique identifier of the project to get the calendar working days for.
_pWorkingDays
[out] Pointer to a pointer of a HPMWorkingDays object, representing the returned data.
Return Value
Returns an error code. See EHPMError.
Comments
The returned object must be freed with ObjectFree or a memory leak will result.
See Also
HPMSdkFunctions, ObjectFree, HPMWorkingDays
ProjectCalendarSetWorkingDays
Sets the calendar working days in a project.
HPMError ProjectCalendarSetWorkingDays (
    void * _pSession,
    HPMUniqueID _ProjectID,
    const HPMWorkingDays * _pWorkingDays
    );
Parameters
_pSession
[in] A connected session. See SessionOpen.
_ProjectID
[in] The unique identifier of the project to set the calendar working days for.
_pWorkingDays
[in] The calendar working days to set. See HPMWorkingDays.
Return Value
Returns an error code. See EHPMError.
See Also
HPMSdkFunctions, HPMWorkingDays
ProjectCalendarGetCustomWorkingDays
Gets the calendar custom working days for specific days in a project.
HPMError ProjectCalendarGetCustomWorkingDays (
    void * _pSession,
    HPMUniqueID _ProjectID,
    const HPMCustomWorkingDays * * _pChangedWorkingDays
    );
Parameters
_pSession
[in] A connected session. See SessionOpen.
_ProjectID
[in] The unique identifier of the project to get custom specific working days for.
_pChangedWorkingDays
[out] Pointer to a pointer of a HPMCustomWorkingDays object, representing the returned data.
Return Value
Returns an error code. See EHPMError.
Comments
The returned object must be freed with ObjectFree or a memory leak will result.
See Also
HPMSdkFunctions, ObjectFree, HPMCustomWorkingDays
ProjectCalendarSetCustomWorkingDays
Sets the calendar custom working days for specific days in a project.
HPMError ProjectCalendarSetCustomWorkingDays (
    void * _pSession,
    HPMUniqueID _ProjectID,
    const HPMCustomWorkingDays * _pChangedWorkingDays
    );
Parameters
_pSession
[in] A connected session. See SessionOpen.
_ProjectID
[in] The unique identifier of the project to set custom specific working days for.
_pChangedWorkingDays
[in] The custom working days. See HPMCustomWorkingDays.
Return Value
Returns an error code. See EHPMError.
See Also
HPMSdkFunctions, HPMCustomWorkingDays
ProjectCalendarGetWorkingHours
Gets the calendar default working hours for a project.
HPMError ProjectCalendarGetWorkingHours (
    void * _pSession,
    HPMUniqueID _ProjectID,
    const HPMWorkingHours * * _pWorkingHours
    );
Parameters
_pSession
[in] A connected session. See SessionOpen.
_ProjectID
[in] The unique identifier of the project to get the working hours for.
_pWorkingHours
[out] Pointer to a pointer of a HPMWorkingHours object, representing the returned data.
Return Value
Returns an error code. See EHPMError.
Comments
The returned object must be freed with ObjectFree or a memory leak will result.
See Also
HPMSdkFunctions, ObjectFree, HPMWorkingHours
ProjectCalendarSetWorkingHours
Sets the calendar default working hours for a project.
HPMError ProjectCalendarSetWorkingHours (
    void * _pSession,
    HPMUniqueID _ProjectID,
    const HPMWorkingHours * _pWorkingHours
    );
Parameters
_pSession
[in] A connected session. See SessionOpen.
_ProjectID
[in] The unique identifier of the project to set the working hours for.
_pWorkingHours
[in] The default working hours. See HPMWorkingHours.
Return Value
Returns an error code. See EHPMError.
See Also
HPMSdkFunctions, HPMWorkingHours
ProjectCalendarGetCustomWorkingHours
Gets the calendar custom working hours for specific days in a project
HPMError ProjectCalendarGetCustomWorkingHours (
    void * _pSession,
    HPMUniqueID _ProjectID,
    const HPMCustomWorkingHours * * _pCustomWorkingHours
    );
Parameters
_pSession
[in] A connected session. See SessionOpen.
_ProjectID
[in] The unique identifier of the project to get custom working hours for.
_pCustomWorkingHours
[out] Pointer to a pointer of a HPMCustomWorkingHours object, representing the returned data.
Return Value
Returns an error code. See EHPMError.
Comments
The returned object must be freed with ObjectFree or a memory leak will result.
See Also
HPMSdkFunctions, ObjectFree, HPMCustomWorkingHours
ProjectCalendarSetCustomWorkingHours
Sets calendar custom working hours for specific days in a project
HPMError ProjectCalendarSetCustomWorkingHours (
    void * _pSession,
    HPMUniqueID _ProjectID,
    const HPMCustomWorkingHours * _pCustomWorkingHours
    );
Parameters
_pSession
[in] A connected session. See SessionOpen.
_ProjectID
[in] The unique identifier of the project to set custom working hours for.
_pCustomWorkingHours
[in] The custom working hours to set. See HPMCustomWorkingHours.
Return Value
Returns an error code. See EHPMError.
See Also
HPMSdkFunctions, HPMCustomWorkingHours
ProjectCalendarGetHolidays
Gets the calendar holidays for a project.
HPMError ProjectCalendarGetHolidays (
    void * _pSession,
    HPMUniqueID _ProjectID,
    const HPMHolidays * * _pHolidays
    );
Parameters
_pSession
[in] A connected session. See SessionOpen.
_ProjectID
[in] The unique identifier of the project to get holidays for.
_pHolidays
[out] Pointer to a pointer of a HPMHolidays object, representing the returned data.
Return Value
Returns an error code. See EHPMError.
Comments
The returned object must be freed with ObjectFree or a memory leak will result.
See Also
HPMSdkFunctions, ObjectFree, HPMHolidays
ProjectCalendarSetHolidays
Sets the calendar holidays for a project.
HPMError ProjectCalendarSetHolidays (
    void * _pSession,
    HPMUniqueID _ProjectID,
    const HPMHolidays * _pHolidays
    );
Parameters
_pSession
[in] A connected session. See SessionOpen.
_ProjectID
[in] The unique identifier of the project to set holidays for.
_pHolidays
[in] Holidays to set. See HPMHolidays.
Return Value
Returns an error code. See EHPMError.
See Also
ProjectGetCalendarDayInfo
Gets the calendar info for a day in a project.
HPMError ProjectGetCalendarDayInfo (
    void * _pSession,
    HPMUniqueID _ProjectID,
    HPMUniqueID _UserID,
    HPMUInt64 _Date,
    const HPMCalendarDayInfo * * _pCalendarInfo
    );
Parameters
_pSession
[in] A connected session. See SessionOpen.
_ProjectID
[in] The unique identifier of the project to get the calendar info for a day for.
_UserID
[in] If set to a valid resource id, the calendar info will be valid for that resource. If set to -1 the returned info will be for the project.
_Date
[in] The date to get the calendar info for. Expressed as the number of micro seconds since 1970 UTC.
_pCalendarInfo
[out] Pointer to a pointer of a HPMCalendarDayInfo object, representing the returned data.
Return Value
Returns an error code. See EHPMError.
Comments
The returned object must be freed with ObjectFree or a memory leak will result.
See Also
HPMSdkFunctions, ObjectFree, HPMCalendarDayInfo
ProjectGetViewPresets
Gets the view presets for a project.
HPMError ProjectGetViewPresets (
    void * _pSession,
    HPMUniqueID _ProjectID,
    const HPMProjectViewPresets * * _pSettings
    );
Parameters
_pSession
[in] A connected session. See SessionOpen.
_ProjectID
[in] The unique identifier of the project to get view presets for.
_pSettings
[out] Pointer to a pointer of a HPMProjectViewPresets object, representing the returned data.
Return Value
Returns an error code. See EHPMError.
Comments
The returned object must be freed with ObjectFree or a memory leak will result.
See Also
HPMSdkFunctions, ObjectFree, HPMProjectViewPresets
ProjectViewPresetApply
Applies the view presets for a resource in a project.
HPMError ProjectViewPresetApply (
    void * _pSession,
    HPMUniqueID _ProjectID,
    HPMUniqueID _ResourceID,
    const HPMProjectViewPreset * _pSettings
    );
Parameters
_pSession
[in] A connected session. See SessionOpen.
_ProjectID
[in] The unique identifier of the project to apply the view preset in.
_ResourceID
[in] The resource to apply the user view preset for.
_pSettings
[in] User view preset to apply. See HPMProjectViewPreset.
Return Value
Returns an error code. See EHPMError.
See Also
HPMSdkFunctions, HPMProjectViewPreset
ProjectSetTimesheetLock
Sets the timesheet lock for a project.
HPMError ProjectSetTimesheetLock (
    void * _pSession,
    HPMUniqueID _ProjectID,
    HPMTimesheetLock const * _pTimesheetLock
    );
Parameters
_pSession
[in] A connected session. See SessionOpen.
_ProjectID
[in] The unique identifier of the project to set the timesheet lock in.
_pTimesheetLock
[in] The timesheet lock info to set. See HPMTimesheetLock.
Return Value
Returns an error code. See EHPMError.
See Also
HPMSdkFunctions, HPMTimesheetLock
ProjectGetTimesheetLock
Gets the timesheet lock for a project.
HPMError ProjectGetTimesheetLock (
    void * _pSession,
    HPMUniqueID _ProjectID,
    HPMTimesheetLock const * * _pTimesheetLock
    );
Parameters
_pSession
[in] A connected session. See SessionOpen.
_ProjectID
[in] The unique identifier of the project to get the timesheet lock from.
_pTimesheetLock
[out] Pointer to a pointer of a HPMTimesheetLock object, representing the returned data.
Return Value
Returns an error code. See EHPMError.
Comments
The returned object must be freed with ObjectFree or a memory leak will result.
See Also
HPMSdkFunctions, ObjectFree, HPMTimesheetLock
ProjectDisplayUserMessage
Displays a message in the client if the specified user is logged in.
HPMError ProjectDisplayUserMessage (
    void * _pSession,
    HPMUniqueID _ProjectID,
    HPMUniqueID _ResourceID,
    HPMInt32 _MessageType,
    const HPMUntranslatedString * _pMessage
    );
Parameters
_pSession
[in] A connected session. See SessionOpen.
_ProjectID
[in] The unique identifier of the project to display the message in client for. If set to -1 the message will display in all the windows in the client.
_ResourceID
[in] The unique identifier of the resource to display the message in client for if the resource is logged in. If called from a client plugin this user has to be the currently logged in resource.
_MessageType
[in] The type of message to display. Can be one of EHPMProjectUserMessageType.
_pMessage
[in] The message to display.
Return Value
Returns an error code. See EHPMError.
See Also
ProjectSetBugReportResources
Sets resources that can report bugs.
HPMError ProjectSetBugReportResources (
    void * _pSession,
    HPMUniqueID _ProjectID,
    HPMResourceDefinitionList const * _pResourceList
    );
Parameters
_pSession
[in] A connected session. See SessionOpen.
_ProjectID
[in] The unique identifier of the QA project to set resources that can report bugs in.
_pResourceList
[in] List of resources that can report bugs.
Return Value
Returns an error code. See EHPMError.
See Also
ProjectGetBugReportResources
Gets resources that can report bugs.
HPMError ProjectGetBugReportResources (
    void * _pSession,
    HPMUniqueID _ProjectID,
    HPMResourceDefinitionList const * * _pResourceList
    );
Parameters
_pSession
[in] A connected session. See SessionOpen.
_ProjectID
[in] The unique identifier of the QA project to set resources that can report bugs in.
_pResourceList
[out] List of resources that can report bugs.
Return Value
Returns an error code. See EHPMError.
Comments
The returned object must be freed with ObjectFree or a memory leak will result.
See Also
ProjectSetDefaultQAWorkflow
Sets the default QA workflow.
HPMError ProjectSetDefaultQAWorkflow (
    void * _pSession,
    HPMUniqueID _ProjectID,
    HPMUInt32 _WorkflowID
    );
Parameters
_pSession
[in] A connected session. See SessionOpen.
_ProjectID
[in] The unique identifier of the QA project to set default workflow in.
_WorkflowID
[in] The unique ID of the default workflow.
Return Value
Returns an error code. See EHPMError.
See Also
ProjectGetDefaultQAWorkflow
Gets the default QA workflow.
HPMError ProjectGetDefaultQAWorkflow (
    void * _pSession,
    HPMUniqueID _ProjectID,
    HPMUInt32 * _WorkflowID
    );
Parameters
_pSession
[in] A connected session. See SessionOpen.
_ProjectID
[in] The unique identifier of the QA project to set default workflow in.
_WorkflowID
[out] The unique ID of the default workflow.
Return Value
Returns an error code. See EHPMError.
See Also
ProjectGetConvertedQAWorkflow
Gets the old default QA workflow, i.e. the current workflow id of the QA workflow that was used before multiple workflows could be used in the QA section.
HPMError ProjectGetConvertedQAWorkflow (
    void * _pSession,
    HPMUniqueID _ProjectID,
    HPMUInt32 * _WorkflowID
    );
Parameters
_pSession
[in] A connected session. See SessionOpen.
_ProjectID
[in] The unique identifier of the QA project to set default workflow in.
_WorkflowID
[out] The unique ID of the current workflow that previously was the singular QA workflow.
Return Value
Returns an error code. See EHPMError.
See Also
ProjectCreateViewPreset
Creates a user view preset for a project.
HPMError ProjectCreateViewPreset (
    void * _pSession,
    HPMUniqueID _ProjectID,
    HPMProjectViewPreset const * _pPreset
    );
Parameters
_pSession
[in] A connected session. See SessionOpen.
_ProjectID
[in] The unique identifier of the project to create the user view preset in.
_pPreset
[in] The HPMProjectViewPreset preset to create.
Return Value
Returns an error code. See EHPMError.
See Also
HPMSdkFunctions, HPMProjectViewPreset
ProjectChangeViewPreset
Changes a user view preset for a project.
HPMError ProjectChangeViewPreset (
    void * _pSession,
    HPMUniqueID _ProjectID,
    HPMProjectViewPreset const * _pPreset
    );
Parameters
_pSession
[in] A connected session. See SessionOpen.
_ProjectID
[in] The unique identifier of the project to change the user view preset in.
_pPreset
[in] The HPMProjectViewPreset preset to change.
Return Value
Returns an error code. See EHPMError.
See Also
HPMSdkFunctions, HPMProjectViewPreset
ProjectDeleteViewPreset
Deletes a user view preset for a project.
HPMError ProjectDeleteViewPreset (
    void * _pSession,
    HPMUniqueID _ProjectID,
    HPMUniqueID _PresetID
    );
Parameters
_pSession
[in] A connected session. See SessionOpen.
_ProjectID
[in] The unique identifier of the project to delete the user view preset in.
_PresetID
[in] The unique identifier of the preset to delete.
Return Value
Returns an error code. See EHPMError.
See Also
HPMSdkFunctions, HPMProjectViewPreset
ProjectSetColumnMetaData
Sets meta data for a default column in a project.
HPMError ProjectSetColumnMetaData (
    void * _pSession,
    HPMUniqueID _ProjectID,
    HPMUInt32 _DefaultColumn,
    const HPMProjectColumnMetaData * _pMetaData
    );
Parameters
_pSession
[in] A connected session. See SessionOpen.
_ProjectID
[in] The unique identifier of the project to set column meta data.
_DefaultColumn
[in] The EHPMProjectDefaultColumn to set meta data on.
_pMetaData
[in] The HPMProjectColumnMetaData to set.
Return Value
Returns an error code. See EHPMError.
See Also
HPMSdkFunctions, HPMProjectColumnMetaData
ProjectGetColumnMetaData
Gets meta data for a column in a project.
HPMError ProjectGetColumnMetaData (
    void * _pSession,
    HPMUniqueID _ProjectID,
    HPMColumn const * _pColumn,
    HPMProjectColumnMetaData const * * _pMetaData
    );
Parameters
_pSession
[in] A connected session. See SessionOpen.
_ProjectID
[in] The unique identifier of the project to get column meta data.
_pColumn
[in] The HPMColumn to get meta data for.
_pMetaData
[out] Pointer to a pointer of a HPMProjectColumnMetaData object, representing the returned data.
Return Value
Returns an error code. See EHPMError.
Comments
The returned object must be freed with ObjectFree or a memory leak will result.
See Also
HPMSdkFunctions, HPMProjectColumnMetaData
ProjectGetFunctionColumnExpression
Gets the expression for a function column in a project. An expression is defined as a HPMFunctionColumnTokens list of tokens.
HPMError ProjectGetFunctionColumnExpression (
    void * _pSession,
    HPMUniqueID _ProjectID,
    HPMColumn const * _pColumn,
    ColumnTokens const * * _pExpression
    );
Parameters
_pSession
[in] A connected session. See SessionOpen.
_ProjectID
[in] The unique identifier of the project to get the column expression for.
_pColumn
[in] The HPMColumn to get the expression for.
_pExpression
[out] Pointer to a pointer of a HPMFunctionColumnTokens object, representing the returned data.
Return Value
Returns an error code. See EHPMError.
Comments
The returned object must be freed with ObjectFree or a memory leak will result.
See Also
HPMSdkFunctions, HPMFunctionColumnTokens
ProjectGetFunctionColumnExpressionError
Checks for possible expression error for a function column in a project.
HPMError ProjectGetFunctionColumnExpressionError (
    void * _pSession,
    HPMUniqueID _ProjectID,
    HPMColumn const * _pColumn,
    HPMProjectFunctionColumnExpressionsValidationError const * * _pExpressionError
    );
Parameters
_pSession
[in] A connected session. See SessionOpen.
_ProjectID
[in] The unique identifier of the project to get expression error.
_pColumn
[in] The HPMColumn to get expression error for.
_pExpressionError
[out] Pointer to a pointer of a HPMProjectFunctionColumnExpressionsValidationError object, representing the returned data.
Return Value
Returns an error code. See EHPMError.
See Also
HPMSdkFunctions, HPMProjectFunctionColumnExpressionsValidationError
ProjectGetAttachmentPath
Gets the attachment path for a project.
HPMError ProjectGetAttachmentPath (
    void * _pSession,
    HPMUniqueID _ProjectID,
    HPMString const * * _pData
    );
Parameters
_pSession
[in] A connected session. See SessionOpen.
_ProjectID
[in] The unique identifier of the project to get the attachment path for.
_pData
[out] Pointer to a pointer of a HPMString object, representing the returned data.
Return Value
Returns an error code. See EHPMError.
Comments
The returned object must be freed with ObjectFree or a memory leak will result.
See Also
ProjectSetOverviewText
Sets the project overview text. The formatting tags described in HPMTaskComment can be used in the text.
HPMError ProjectSetOverviewText (
    void * _pSession,
    HPMUniqueID _ProjectID,
    HPMChar const * _pData
    );
Parameters
_pSession
[in] A connected session. See SessionOpen.
_ProjectID
[in] The unique identifier of the project to get the overview text for.
_pData
[in] The new details text
Return Value
Returns an error code. See EHPMError.
See Also
ProjectGetOverviewText
Gets the project overview text.
HPMError ProjectGetOverviewText (
    void * _pSession,
    HPMUniqueID _ProjectID,
    HPMString const * * _pData
    );
Parameters
_pSession
[in] A connected session. See SessionOpen.
_ProjectID
[in] The unique identifier of the project to get the overview text for
_pData
[out] Pointer to a pointer of a HPMString object, representing the returned data.
Return Value
Returns an error code. See EHPMError.
Comments
The returned object must be freed with ObjectFree or a memory leak will result.
See Also
ProjectExportXML
Exports project as XML.
HPMError ProjectExportXML (
    void * _pSession,
    HPMUniqueID _ProjectID,
    HPMFindContextData const * _pFindContext,
    HPMString const * * _pData
    );
Parameters
_pSession
[in] A connected session. See SessionOpen.
_ProjectID
[in] The unique identifier of the project to get the XML for
_pFindContext
[in] The prepared find context to use for selecting tasks to be included in the XML export.
_pData
[out] Pointer to a pointer of a HPMString object, representing the returned data.
Return Value
Returns an error code. See EHPMError.
Comments
The returned object must be freed with ObjectFree or a memory leak will result.
See Also
HPMSdkFunctions, HPMFindContextData
ProjectUtilPrepareFunctionColumnLocalContext
Creates a local changes context for function columns in a project.
HPMError ProjectUtilPrepareFunctionColumnLocalContext (
    void * _pSession,
    HPMUniqueID _ProjectID,
    HPMProjectFunctionColumnLocalContext const * * _pContext
    );
Parameters
_pSession
[in] A connected session. See SessionOpen.
_ProjectID
[in] The unique identifier of the project to create a local changes context for.
_pContext
[out] Pointer to a pointer of a HPMProjectFunctionColumnLocalContext object, representing the context.
Return Value
Returns an error code. See EHPMError.
Comments
The returned object must be freed with ObjectFree or a memory leak will result. Use the local changes context if you want to: Parse a string representation of an expression into a tokenised expression with ProjectUtilParseLocalContextFunctionColumnExpression. Make a string representation of a tokenised expression with ProjectUtilGetLocalContextFunctionColumnExpressionString. Validate an expression with ProjectUtilValidateLocalContextFunctionColumnExpressionChanges. Merge multiple column changes locally and only send them to the server once. A common scenario is to get columns with ProjectUtilGetLocalContextCustomColumns, apply changes locally with ProjectUtilApplyLocalContextFunctionColumnChanges, get local columns after change with ProjectUtilGetLocalContextCustomColumns, merge with possible other changes and the send the changes to the server. Validate changes locally with ProjectUtilValidateLocalContextFunctionColumnExpressionChanges-
See Also
HPMSdkFunctions, HPMProjectFunctionColumnLocalContext, ProjectUtilParseLocalContextFunctionColumnExpression, ProjectUtilApplyLocalContextFunctionColumnChanges, ProjectUtilValidateLocalContextFunctionColumnExpressionChanges, ProjectUtilGetLocalContextFunctionColumnTokens, ProjectUtilGetLocalContextCustomColumnName, ProjectUtilGetLocalContextFunctionColumnExpressionString, ProjectUtilGetLocalContextCustomColumns,
ProjectUtilParseLocalContextFunctionColumnExpression
Parses string to a tokenized expression to be used for a function column.
HPMError ProjectUtilParseLocalContextFunctionColumnExpression (
    void * _pSession,
    HPMChar const * _pStrExpression,
    HPMProjectFunctionColumnLocalContext const * _pContext,
    HPMProjectFunctionColumnExpressionParseResult const * * _pResult
    );
Parameters
_pSession
[in] A connected session. See SessionOpen.
_pStrExpression
[in] String expression.
_pContext
[in] HPMProjectFunctionColumnLocalContext local changes context.
_pResult
[out] Pointer to a pointer of a HPMProjectFunctionColumnExpressionParseResult object, representing the parsing result.
Return Value
Returns an error code. See EHPMError.
Comments
The returned object must be freed with ObjectFree or a memory leak will result.
See Also
HPMSdkFunctions, HPMProjectFunctionColumnExpressionParseResult, HPMProjectFunctionColumnLocalContext
ProjectUtilApplyLocalContextFunctionColumnChanges
Apply function column changes to local changes context
HPMError ProjectUtilApplyLocalContextFunctionColumnChanges (
    void * _pSession,
    HPMProjectCustomColumnChanges const * _pChanges,
    HPMProjectFunctionColumnLocalContext const * _pContext,
    HPMProjectFunctionColumnExpressionsValidationErrors const * * _pResults
    );
Parameters
_pSession
[in] A connected session. See SessionOpen.
_pChanges
[in] HPMProjectCustomColumnChanges changes to validate.
_pContext
[in] HPMProjectFunctionColumnLocalContext local changes context.
_pResults
[out] HPMProjectFunctionColumnExpressionsValidationErrors validation results.
Return Value
Returns an error code. See EHPMError. Additional information might be available through UtilGetLastErrorDescription.
Comments
The returned object must be freed with ObjectFree or a memory leak will result.
See Also
HPMSdkFunctions, HPMProjectFunctionColumnExpressionsValidationErrors HPMProjectFunctionColumnLocalContext
ProjectUtilValidateLocalContextFunctionColumnExpressionChanges
Validates function column expression changes.
HPMError ProjectUtilValidateLocalContextFunctionColumnExpressionChanges (
    void * _pSession,
    HPMProjectFunctionColumnExpressions const * _pChanges,
    HPMProjectFunctionColumnLocalContext const * _pContext,
    HPMProjectFunctionColumnExpressionsValidationErrors const * * _pResults
    );
Parameters
_pSession
[in] A connected session. See SessionOpen.
_pChanges
[in] HPMProjectFunctionColumnExpressions changes to validate.
_pContext
[in] HPMProjectFunctionColumnLocalContext local changes context.
_pResults
[out] Validation results.
Return Value
Returns an error code. See EHPMError.
Comments
The returned object must be freed with ObjectFree or a memory leak will result.
See Also
HPMSdkFunctions, HPMProjectFunctionColumnExpressionsValidationErrors HPMProjectFunctionColumnLocalContext
ProjectUtilGetLocalContextFunctionColumnTokens
Get function column tokens from local changes
HPMError ProjectUtilGetLocalContextFunctionColumnTokens (
    void * _pSession,
    HPMUInt32 _ColumnID,
    HPMProjectFunctionColumnLocalContext const * _pContext,
    ColumnTokens const * * _pResults
    );
Parameters
_pSession
[in] A connected session. See SessionOpen.
_ColumnID
[in] Column hash/ID of function custom column to get tokenized expression for.
_pContext
[in] HPMProjectFunctionColumnLocalContext local changes context.
_pResults
[out] Pointer to a pointer of a HPMFunctionColumnTokens object, representing the returned data.
Return Value
Returns an error code. See EHPMError.
Comments
The returned object must be freed with ObjectFree or a memory leak will result.
See Also
HPMSdkFunctions, HPMProjectFunctionColumnLocalContext, HPMFunctionColumnTokens
ProjectUtilGetLocalContextCustomColumnName
Get custom column name from local context changes.
HPMError ProjectUtilGetLocalContextCustomColumnName (
    void * _pSession,
    HPMUInt32 _ColumnID,
    HPMProjectFunctionColumnLocalContext const * _pContext,
    HPMString const * * _pName
    );
Parameters
_pSession
[in] A connected session. See SessionOpen.
_ColumnID
[in] Column hash/ID of custom column to get column name for
_pContext
[in] HPMProjectFunctionColumnLocalContext local changes context.
_pName
[out] Pointer to a pointer of a HPMString object, representing the returned data.
Return Value
Returns an error code. See EHPMError.
Comments
The returned object must be freed with ObjectFree or a memory leak will result.
See Also
HPMSdkFunctions, HPMProjectFunctionColumnLocalContext
ProjectUtilGetLocalContextFunctionColumnExpressionString
Get expression string from tokenized expression from local changes context.
HPMError ProjectUtilGetLocalContextFunctionColumnExpressionString (
    void * _pSession,
    ColumnTokens const * _pTokenExpression,
    HPMLanguage const * _pLanguage,
    HPMProjectFunctionColumnLocalContext const * _pContext,
    HPMString const * * _pExpression
    );
Parameters
_pSession
[in] A connected session. See SessionOpen.
_pTokenExpression
[in] HPMFunctionColumnTokens tokens that represents the tokenized expression.
_pLanguage
[in] The HPMLanguage language to get the expression string in.
_pContext
[in] HPMProjectFunctionColumnLocalContext local changes context.
_pExpression
[out] Pointer to a pointer of a HPMString object, representing the returned data.
Return Value
Returns an error code. See EHPMError.
Comments
The returned object must be freed with ObjectFree or a memory leak will result.
See Also
HPMSdkFunctions, HPMProjectFunctionColumnLocalContext, HPMFunctionColumnTokens, HPMLanguage
ProjectUtilGetLocalContextCustomColumns
Get all columns from a local changes context.
HPMError ProjectUtilGetLocalContextCustomColumns (
    void * _pSession,
    HPMProjectFunctionColumnLocalContext const * _pContext,
    HPMProjectCustomColumns const * * _pResultColumns
    );
Parameters
_pSession
[in] A connected session. See SessionOpen.
_pContext
[in] HPMProjectFunctionColumnLocalContext local changes context.
_pResultColumns
[out] Pointer to a pointer of a HPMProjectCustomColumns object, representing the returned data.
Return Value
Returns an error code. See EHPMError.
Comments
The returned object must be freed with ObjectFree or a memory leak will result.
See Also
HPMSdkFunctions, HPMProjectFunctionColumnLocalContext
UtilDecodeStringPosition
Gets function column expression character position from a string position.
HPMError UtilDecodeStringPosition (
    void * _pSession,
    HPMChar const * _pExpression,
    HPMStringPosition const * _pStringPosition,
    HPMInt32 * _pCharacterPosition
    );
Parameters
_pSession
[in] A connected session. See SessionOpen.
_pExpression
[in] Function column expression.
_pStringPosition
[in] HPMStringPosition position of token.
_pCharacterPosition
[out] Character position of token in the function column expression.
Return Value
Returns an error code. See EHPMError.
See Also
HPMStringPosition, HPMFunctionColumnTokens
UtilEncodeStringPosition
Gets function column expression token string position from character position in corresponding string.
HPMError UtilEncodeStringPosition (
    void * _pSession,
    HPMChar const * _pString,
    HPMInt32 _CharacterPosition,
    HPMStringPosition const * * _pStringPosition
    );
Parameters
_pSession
[in] A connected session. See SessionOpen.
_pString
[in] String to encode the string position from.
_CharacterPosition
[in] Character position in string.
_pStringPosition
[out] HPMStringPosition position of token.
Return Value
Returns an error code. See EHPMError.
Comments
The returned object must be freed with ObjectFree or a memory leak will result.
See Also
HPMStringPosition, HPMFunctionColumnTokens
ProjectUtilCompareCustomColumns
Creates difference between two states of HPMProjectCustomColumns in HPMProjectCustomColumnChanges.
HPMError ProjectUtilCompareCustomColumns (
    void * _pSession,
    HPMUniqueID _ProjectID,
    HPMProjectCustomColumns const * _pOldCustomColumns,
    HPMProjectCustomColumns const * _pNewCustomColumns,
    HPMProjectCustomColumnChangeHashes const * _pColumnChangeHashes,
    HPMProjectCustomColumnChanges const * * _pCustomColumnChanges
    );
Parameters
_pSession
[in] A connected session. See SessionOpen.
_ProjectID
[in] The unique identifier of the project for custom columns.
_pOldCustomColumns
[in] Old HPMProjectCustomColumns custom columns.
_pNewCustomColumns
[in] New HPMProjectCustomColumns custom columns.
_pColumnChangeHashes
[in] Custom column HPMProjectCustomColumnChangeHashes hash changes.
_pCustomColumnChanges
[out] Pointer to a pointer of a HPMProjectCustomColumnChanges object, representing the returned data.
Return Value
Returns an error code. See EHPMError.
Comments
The returned object must be freed with ObjectFree or a memory leak will result.
See Also
HPMSdkFunctions, HPMProjectCustomColumnChanges, HPMProjectCustomColumns, HPMProjectCustomColumnChangeHashes
ProjectWaitUntilFunctionColumnCalculated
Blocks the thread until a function column calculation is done.
HPMError ProjectWaitUntilFunctionColumnCalculated (
    void * _pSession,
    HPMUniqueID _ProjectID,
    HPMUInt32 _ColumnHash
    );
Parameters
_pSession
[in] A connected session. See SessionOpen.
_ProjectID
[in] The unique identifier of the custom function column project.
_ColumnHash
[in] Hash identifier of function column to wait on. If _ColumnHash is 0, function will wait for all function column calculations in progress.
Return Value
Returns an error code. See EHPMError.
See Also
ProjectGetMilestones
Gets a list of all milestone task reference ids for the specified project
HPMError ProjectGetMilestones (
    void * _pSession,
    HPMUniqueID _ProjectID,
    HPMProjectMilestones const * * _pData
    );
Parameters
_pSession
[in] A connected session. See SessionOpen.
_ProjectID
[in] The unique identifier of the project to get milestones for.
_pData
[out] Pointer to a pointer of a HPMProjectMilestones object, representing the returned data.
Return Value
Returns an error code. See EHPMError.
Comments
The returned object must be freed with ObjectFree or a memory leak will result.
See Also
ProjectGetSprints
Gets a list of all sprint task ids for the specified project
HPMError ProjectGetSprints (
    void * _pSession,
    HPMUniqueID _ProjectID,
    HPMProjectSprints const * * _pData
    );
Parameters
_pSession
[in] A connected session. See SessionOpen.
_ProjectID
[in] The unique identifier of the project to get sprints for.
_pData
[out] Pointer to a pointer of a HPMProjectSprints object, representing the returned data.
Return Value
Returns an error code. See EHPMError.
Comments
The returned object must be freed with ObjectFree or a memory leak will result.
See Also
ProjectGetName
Gets the name of a project.
HPMError ProjectGetName (
    void * _pSession,
    HPMUniqueID _ProjectID,
    HPMString const * * _pData
    );
Parameters
_pSession
[in] A connected session. See SessionOpen.
_ProjectID
[in] The unique identifier of the project to get name for.
_pData
[out] Pointer to a pointer of a HPMString object, representing the returned data.
Return Value
Returns an error code. See EHPMError.
Comments
The returned object must be freed with ObjectFree or a memory leak will result.
See Also
HPMSdkFunctions, ObjectFree, HPMString, EHPMError
ProjectGetSortName
Gets the sorting name of a project.
HPMError ProjectGetSortName (
    void * _pSession,
    HPMUniqueID _ProjectID,
    HPMString const * * _pData
    );
Parameters
_pSession
[in] A connected session. See SessionOpen.
_ProjectID
[in] The unique identifier of the project to get sorting name for.
_pData
[out] Pointer to a pointer of a HPMString object, representing the returned data.
Return Value
Returns an error code. See EHPMError.
Comments
The returned object must be freed with ObjectFree or a memory leak will result.
See Also
HPMSdkFunctions, ObjectFree, HPMString, EHPMError
ProjectGetNiceName
Gets the nice name of a project.
HPMError ProjectGetNiceName (
    void * _pSession,
    HPMUniqueID _ProjectID,
    HPMString const * * _pData
    );
Parameters
_pSession
[in] A connected session. See SessionOpen.
_ProjectID
[in] The unique identifier of the project to get nice name for.
_pData
[out] Pointer to a pointer of a HPMString object, representing the returned data.
Return Value
Returns an error code. See EHPMError.
Comments
The returned object must be freed with ObjectFree or a memory leak will result.
See Also
HPMSdkFunctions, ObjectFree, HPMString, EHPMError
ProjectGetProjectMethod
Gets the project method of a project.
HPMError ProjectGetProjectMethod (
    void * _pSession,
    HPMUniqueID _ProjectID,
    HPMUInt32 * _pMethod
    );
Parameters
_pSession
[in] A connected session. See SessionOpen.
_ProjectID
[in] The unique identifier of the project to get the project method of.
_pMethod
[out] Pointer to a variable that receive the project method. Will be one of EHPMProjectMethod.
Return Value
Returns an error code. See EHPMError.
See Also
HPMSdkFunctions, EHPMProjectMethod
ProjectGetDefaultEditorMode
Gets the default editor mode of a project.
HPMError ProjectGetDefaultEditorMode (
    void * _pSession,
    HPMUniqueID _ProjectID,
    HPMUInt32 * _pMode
    );
Parameters
_pSession
[in] A connected session. See SessionOpen.
_ProjectID
[in] The unique identifier of the project to get the default editor mode of.
_pMode
[out] Pointer to a variable that receive the default editor mode. Will be one of EHPMProjectDefaultEditorMode.
Return Value
Returns an error code. See EHPMError.
See Also
HPMSdkFunctions, EHPMProjectDefaultEditorMode
ProjectGetAgileTemplate
Gets the agile template of a project.
HPMError ProjectGetAgileTemplate (
    void * _pSession,
    HPMUniqueID _ProjectID,
    HPMUInt32 * _pTemplate
    );
Parameters
_pSession
[in] A connected session. See SessionOpen.
_ProjectID
[in] The unique identifier of the project to get the agile template of.
_pTemplate
[out] Pointer to a variable that receive the agile template. Will be one of EHPMProjectAgileTemplate.
Return Value
Returns an error code. See EHPMError.
See Also
HPMSdkFunctions, EHPMProjectAgileTemplate
ProjectUtilGetCustomColumnIsHidden
Checks if a custom column is hidden in a project
HPMError ProjectUtilGetCustomColumnIsHidden (
    void * _pSession,
    HPMUniqueID _ProjectID,
    HPMUInt32 _ColumnHash,
    HPMInt32 * _pIsHidden
    );
Parameters
_pSession
[in] A connected session. See SessionOpen.
_ProjectID
[in] The unique project id to to get the custom column from.
_ColumnHash
[in] The hash of the custom column.
_pIsHidden
[out] Returns 1 if the custom column is hidden, 0 otherwise.
Return Value
Returns an error code. See EHPMError.
See Also
ProjectGetCustomName
Gets the custom name from a project method template setting.
HPMError ProjectGetCustomName (
    void * _pSession,
    HPMUniqueID _ProjectID,
    HPMInt32 _CustomNameType,
    HPMUntranslatedString const * * _pCustomName
    );
Parameters
_pSession
[in] A connected session. See SessionOpen.
_ProjectID
[in] The unique identifier of the project to get the custom name in.
_CustomNameType
[in] The type of the custom name. Can be one of EHPMProjectCustomNameType.
_pCustomName
[out] Pointer to a pointer of a HPMReport object, representing the returned data.
Return Value
Returns an error code. See EHPMError.
Comments
The returned object must be freed with ObjectFree or a memory leak will result.
See Also
HPMSdkFunctions, ObjectFree, HPMUntranslatedString EHPMProjectCustomNameType
ProjectUtilCustomColumnExistInProject
Checks if a custom column exists in a project
HPMError ProjectUtilCustomColumnExistInProject (
    void * _pSession,
    HPMUniqueID _ProjectID,
    HPMUInt32 _ColumnHash,
    HPMInt32 * _pExist
    );
Parameters
_pSession
[in] A connected session. See SessionOpen.
_ProjectID
[in] The unique project id to to check the custom column in.
_ColumnHash
[in] The hash of the custom column.
_pExist
[out] Returns 1 if the custom column is exists in the project, 0 otherwise.
Return Value
Returns an error code. See EHPMError.
See Also
EHPMTaskField
Task field identifier used in HPMChangeCallbackData_TaskChange, HPMDataHistoryEntry::m_FieldID, HPMTaskField::m_FieldID and HPMProjectDetailedAccessRuleFunction::m_FunctionID.
enum EHPMTaskField {
EHPMTaskField_NewVersionOfSDKRequired = 0,
EHPMTaskField_Container = 1,
EHPMTaskField_BacklogCategory = 2,
EHPMTaskField_Color = 3,
EHPMTaskField_ComplexityPoints = 4,
EHPMTaskField_Confidence = 5,
EHPMTaskField_EstimatedIdealDays = 6,
EHPMTaskField_Priority = 7,
EHPMTaskField_Risk = 8,
EHPMTaskField_StartOffset = 9,
EHPMTaskField_Duration = 10,
EHPMTaskField_ForceSubProject = 11,
EHPMTaskField_BudgetedWork = 12,
EHPMTaskField_LockedType = 13,
EHPMTaskField_PercentComplete = 14,
EHPMTaskField_Status = 15,
EHPMTaskField_Type = 16,
EHPMTaskField_Unlocked = 17,
EHPMTaskField_VacationOptions = 18,
EHPMTaskField_Comment = 19,
EHPMTaskField_Description = 20,
EHPMTaskField_Hyperlink = 21,
EHPMTaskField_LinkedToMilestone = 22,
EHPMTaskField_LinkedToSprint = 23,
EHPMTaskField_LockedBy = 24,
EHPMTaskField_OriginallyCreatedBy = 25,
EHPMTaskField_AttachedDocuments = 26,
EHPMTaskField_DelegateTo = 27,
EHPMTaskField_SprintAllocatedResources = 28,
EHPMTaskField_Completed = 29,
EHPMTaskField_TimeZones = 30,
EHPMTaskField_VisibleTo = 31,
EHPMTaskField_WorkRemaining = 32,
EHPMTaskField_SprintResourceAllocation = 33,
EHPMTaskField_CommentsOptions = 34,
EHPMTaskField_WorkflowStatus = 35,
EHPMTaskField_LastUpdatedTime = 36,
EHPMTaskField_Severity = 37,
EHPMTaskField_DetailedDescription = 38,
EHPMTaskField_UserStoryFlag = 39,
EHPMTaskField_SprintResourcesHaveFullRights = 40,
EHPMTaskField_ID = 41,
EHPMTaskField_StepsToReproduce = 42,
EHPMTaskField_LinkedTo = 43,
EHPMTaskField_CustomColumnData = 44,
EHPMTaskField_TimeZoneStart = 45,
EHPMTaskField_TimeZoneEnd = 46,
EHPMTaskField_ResourceAllocationFirst = 47,
EHPMTaskField_ResourceAllocationFirstPercent = 48,
EHPMTaskField_ResourceAllocationMore = 49,
EHPMTaskField_WallItemColor = 50,
EHPMTaskField_WallItemPositions = 51,
EHPMTaskField_Workflow = 52,
EHPMTaskField_LinkedToPipelineTask = 53,
EHPMTaskField_CreatedPipelineTasks = 54,
EHPMTaskField_CreatedFromWorkflowObject = 55,
EHPMTaskField_TotalDuration = 56,
EHPMTaskField_DefaultWorkflow = 57,
EHPMTaskField_FullyCreated = 58,
EHPMTaskField_SprintPriority = 59,
EHPMTaskField_BacklogPriority = 60,
EHPMTaskField_BugPriority = 61,
EHPMTaskField_Archived = 62,
EHPMTaskField_IdealDaysHistory = 63,
EHPMTaskField_PointsHistory = 64,
EHPMTaskField_Undefined = 65,
EHPMTaskField_LastUserInterfaceAction = 66,
EHPMTaskField_WorkRemainingHistory = 67,
EHPMTaskField_CommentStore = 68,
EHPMTaskField_OriginallyCreatedOnTime = 69,
EHPMTaskField_EpicFlag = 70,
EHPMTaskField_LastUpdatedBy = 71,
EHPMTaskField_Board_Elements = 72,
EHPMTaskField_Board_CardAttributeColumns = 73,
EHPMTaskField_BoardCommit_LaneID = 74,
EHPMTaskField_BoardCommit_ColumnID = 75,
EHPMTaskField_BoardCommit_Position = 76,
EHPMTaskField_BoardCommit_Flags = 77,
EHPMTaskField_SprintIsBoard = 78,
EHPMTaskField_Board_ColumnToStatus = 79,
EHPMTaskField_OldAllocation = 80,
EHPMTaskField_DatabaseID = 81,
};
Values
EHPMTaskField_NewVersionOfSDKRequired
The task field did not exist when this SDK was created. Upgrade to a newer version of the SDK to be able to use this format.
EHPMTaskField_Container
The container a task resides in. Can be for example the project schedule, the backlog project or the QA project. Used: Change callback.
EHPMTaskField_BacklogCategory
The backlog category of the task. Used: Change callback, task history.
EHPMTaskField_Color
The color of the task. Used: Change callback, task history.
EHPMTaskField_ComplexityPoints
The complexity points of the task. Used: Change callback, task history.
EHPMTaskField_Confidence
The confidence of the task. Used: Change callback, task history.
EHPMTaskField_EstimatedIdealDays
The estimated ideal days of the task. Used: Change callback, task history.
EHPMTaskField_Priority
The priority of the task. Used: Change callback, task history.
EHPMTaskField_Risk
The risk of the task. Used: Change callback, task history.
EHPMTaskField_StartOffset
The start offset of the task. Used: Change callback, task history.
EHPMTaskField_Duration
The duration of the task. Used: Change callback, task history.
EHPMTaskField_ForceSubProject
The force sub project status of the task. Used: Change callback, task history.
EHPMTaskField_BudgetedWork
The budgeted work of the task. Used: Change callback, task history.
EHPMTaskField_LockedType
The locked type of the task. Used: Change callback, task history.
EHPMTaskField_PercentComplete
The percent complete of the task. Used: Change callback, task history.
EHPMTaskField_Status
The status of the task. Used: Change callback, task history.
EHPMTaskField_Type
The type of the task. Used: Change callback, task history.
EHPMTaskField_Unlocked
The unlocked status of the task. Used: Change callback, task history.
EHPMTaskField_VacationOptions
The vacations options of the task. Used: Change callback, task history.
EHPMTaskField_Comment
The comments on the task. Used: Task history.
EHPMTaskField_Description
The description of the task. Used: Change callback, task history, access rules.
EHPMTaskField_Hyperlink
The hyper link of the task. Used: Change callback, task history.
EHPMTaskField_LinkedToMilestone
The milestone a task is linked to. Used: Change callback, task history.
EHPMTaskField_LinkedToSprint
The sprint a task is linked to. Used: Change callback, task history.
EHPMTaskField_LockedBy
The user a task is locked by. Used: Change callback.
EHPMTaskField_OriginallyCreatedBy
The originally created/reported by user of a task. Used: Change callback, task history.
EHPMTaskField_AttachedDocuments
The attached documents of a task. Used: Change callback, task history.
EHPMTaskField_DelegateTo
The resources a task is delegated to. Used: Change callback, task history.
EHPMTaskField_SprintAllocatedResources
The resources allocated to a sprint. Used: Change callback, task history.
EHPMTaskField_Completed
The completed status of a task. Used: Change callback, task history.
EHPMTaskField_TimeZones
The time zones of a scheduled task. Used: Change callback, task history.
EHPMTaskField_VisibleTo
The resources a task is visible to. Used: Change callback, task history.
EHPMTaskField_WorkRemaining
The work remaining of the task. Used: Change callback, task history.
EHPMTaskField_SprintResourceAllocation
The resource allocation of resources on a task. Used: Change callback, task history.
EHPMTaskField_CommentsOptions
The comments options set on a task. Used: Change callback, task history.
EHPMTaskField_WorkflowStatus
The workflow status of a task. Used: Change callback, task history.
EHPMTaskField_LastUpdatedTime
The last time a task was updated. Used: Change callback.
EHPMTaskField_Severity
The severity of a task. Used: Change callback, task history.
EHPMTaskField_DetailedDescription
The detailed description for a task. Used: Change callback, task history, access rules.
EHPMTaskField_UserStoryFlag
The user story flag for a task. Used: Change callback, task history.
EHPMTaskField_SprintResourcesHaveFullRights
The sprint resources full rights flag for a task. Used: Change callback, task history.
EHPMTaskField_ID
The id for a task or bug. Used: Change callback.
EHPMTaskField_StepsToReproduce
The steps to reproduce for a task. Used: Change callback, task history, access rules.
EHPMTaskField_LinkedTo
The linked to field of a task. Used: Change callback, task history.
EHPMTaskField_CustomColumnData
Data for a custom column on a task. Used: Task history.
EHPMTaskField_TimeZoneStart
Data for time zone start. Used: Task history.
EHPMTaskField_TimeZoneEnd
Data for time zone end. Used: Task history.
EHPMTaskField_ResourceAllocationFirst
Data for the first allocated resource. Used: Task history.
EHPMTaskField_ResourceAllocationFirstPercent
Data for the percentage resource allocation of the first resource. Used: Task history.
EHPMTaskField_ResourceAllocationMore
Data for the rest of the allocated resources (resource and resource allocation percentage). Used: Task history.
EHPMTaskField_WallItemColor
The color of a task when viewed as wall item. Used: Change callback, task history.
EHPMTaskField_WallItemPositions
The positions of a task when viewed as wall item. Used: Change callback.
EHPMTaskField_Workflow
The workflow set on a task. Used: Change callback, task history.
EHPMTaskField_LinkedToPipelineTask
The pipeline task that this task is linked to. Used: Change callback, task history.
EHPMTaskField_CreatedPipelineTasks
The tasks created by a pipeline task. Used: Change callback.
EHPMTaskField_CreatedFromWorkflowObject
The workflow and workflow object that the pipeline task was created from. Used: Change callback.
EHPMTaskField_TotalDuration
The total duration of a scheduled task calculated from time zones. Used: Change callback, task history.
EHPMTaskField_DefaultWorkflow
The default workflow that will be set on new sub tasks. Used: Change callback, task history.
EHPMTaskField_FullyCreated
The fully created flag. Used: Change callback, task history.
EHPMTaskField_SprintPriority
The sprint priority. Used: Change callback, task history.
EHPMTaskField_BacklogPriority
The main backlog priority. Used: Change callback, task history.
EHPMTaskField_BugPriority
The bug priority. Used: Change callback, task history.
EHPMTaskField_Archived
The archived status. Used: Change callback, task history.
EHPMTaskField_IdealDaysHistory
The ideal days history. Used: Change callback, task history.
EHPMTaskField_PointsHistory
The points history. Used: Change callback, task history.
EHPMTaskField_Undefined
The task field is not defined, used if there is no mapping between column and task field.
EHPMTaskField_LastUserInterfaceAction
The last user interface action on item. Used: Task history, change callback
EHPMTaskField_WorkRemainingHistory
Work remaining history. Used: Task history, change callback
EHPMTaskField_CommentStore
SDK internal data comment store. Used: Task history, change callback
EHPMTaskField_OriginallyCreatedOnTime
Originally created on time. Used: Task history, change callback
EHPMTaskField_EpicFlag
Epic flag for a task. Used: Task history, change callback
EHPMTaskField_LastUpdatedBy
The last user that updated a task. Used: Change callback.
EHPMTaskField_Board_Elements
List of board elements.
EHPMTaskField_Board_CardAttributeColumns
List of card attribute columns. Used: Change callback.
EHPMTaskField_BoardCommit_LaneID
ID of the lane the Task is committed to. Used: Task history, change callback
EHPMTaskField_BoardCommit_ColumnID
ID of the column the Task is committed to. Used: Task history, change callback
EHPMTaskField_BoardCommit_Position
Position of task card in column. Used: Change callback.
EHPMTaskField_BoardCommit_Flags
Task card flags. Used: Change callback.
EHPMTaskField_SprintIsBoard
Shows whether board is added to sprint. Used: Task history
EHPMTaskField_Board_ColumnToStatus
Board's columns to statuses mapping.
EHPMTaskField_OldAllocation
List of all previous partial task allocations.
EHPMTaskField_DatabaseID
The unique database id of a task or bug.
Comments
The task fields identifiers correspond to the different TaskSetxxx and TaskGetxxx functions.
See Also
HPMChangeCallbackData_TaskChange, HPMDataHistoryEntry, HPMProjectDetailedAccessRuleFunction
EHPMTaskRefField
Task reference field identifier used in HPMChangeCallbackData_TaskRefChange.
enum EHPMTaskRefField {
EHPMTaskRefField_NewVersionOfSDKRequired = 0,
EHPMTaskRefField_TaskID = 1,
EHPMTaskRefField_TreeLevel = 2,
EHPMTaskRefField_ParentID = 3,
EHPMTaskRefField_NewlyCreated = 4,
EHPMTaskRefField_UIDHistory = 5,
EHPMTaskRefField_ParentIDWorkPriority = 6,
};
Values
EHPMTaskRefField_NewVersionOfSDKRequired
The task reference field did not exist when this SDK was created. Upgrade to a newer version of the SDK to be able to use this format.
EHPMTaskRefField_TaskID
The unique identifier of the task the reference is referring to.
EHPMTaskRefField_TreeLevel
The tree level that the task reference is at.
EHPMTaskRefField_ParentID
The unique identifier of the task that is the parent of this task in the tree.
EHPMTaskRefField_NewlyCreated
If the task in newly created and not inspected by the user.
EHPMTaskRefField_UIDHistory
The unique id history of the task. This history is used to keep track of project history when various operations are performed.
EHPMTaskRefField_ParentIDWorkPriority
The unique identifier of the task that is the parent of this task in the work priority list.
Comments
The task fields identifiers correspond to the different TaskRefSetxxx and TaskRefGetxxx functions.
See Also
HPMChangeCallbackData_TaskRefChange
EHPMTaskConnectionType
Connection type used for TaskConnectionSetConnectionType and TaskConnectionGetConnectionType
enum EHPMTaskConnectionType {
EHPMTaskConnectionType_NewVersionOfSDKRequired = 0,
EHPMTaskConnectionType_EndToStart = 1,
EHPMTaskConnectionType_EndToEnd = 2,
EHPMTaskConnectionType_StartToEnd = 3,
EHPMTaskConnectionType_StartToStart = 4,
};
Values
EHPMTaskConnectionType_NewVersionOfSDKRequired
The connection type did not exist when this SDK was created. Upgrade to a newer version of the SDK to be able to use this format.
EHPMTaskConnectionType_EndToStart
End to start connection type.
EHPMTaskConnectionType_EndToEnd
End to end connection type.
EHPMTaskConnectionType_StartToEnd
Start to end connection type.
EHPMTaskConnectionType_StartToStart
Start to end connection type.
See Also
TaskConnectionSetConnectionType, TaskConnectionGetConnectionType
EHPMTaskStatus
Task status used for TaskGetStatus and TaskSetStatus.
enum EHPMTaskStatus {
EHPMTaskStatus_NewVersionOfSDKRequired = 0,
EHPMTaskStatus_NoStatus = 1,
EHPMTaskStatus_NotDone = 2,
EHPMTaskStatus_InProgress = 3,
EHPMTaskStatus_Completed = 4,
EHPMTaskStatus_Blocked = 5,
EHPMTaskStatus_Deleted = 6,
};
Values
EHPMTaskStatus_NewVersionOfSDKRequired
The task status type did not exist when this SDK was created. Upgrade to a newer version of the SDK to be able to use this format.
EHPMTaskStatus_NoStatus
The task has no status.
EHPMTaskStatus_NotDone
The task is not done.
EHPMTaskStatus_InProgress
The task is in progress.
EHPMTaskStatus_Completed
The task is completed.
EHPMTaskStatus_Blocked
The task is blocked.
EHPMTaskStatus_Deleted
The task is deleted.
See Also
EHPMTaskLockedType
Task locked type used for HPMTaskChangeDispositionEntry and TaskGetLockedType.
enum EHPMTaskLockedType {
EHPMTaskLockedType_NewVersionOfSDKRequired = 0,
EHPMTaskLockedType_Normal = 1,
EHPMTaskLockedType_BacklogItem = 2,
EHPMTaskLockedType_SprintItem = 3,
EHPMTaskLockedType_QABug = 4,
};
Values
EHPMTaskLockedType_NewVersionOfSDKRequired
The task locked type did not exist when this SDK was created. Upgrade to a newer version of the SDK to be able to use this format.
EHPMTaskLockedType_Normal
Normal task.
EHPMTaskLockedType_BacklogItem
Locked to be a backlog item.
EHPMTaskLockedType_SprintItem
Locked to be a sprint item.
EHPMTaskLockedType_QABug
Locked to be an QA bug.
See Also
HPMTaskChangeDispositionEntry, TaskGetLockedType
EHPMTaskType
Task type used for HPMTaskChangeDispositionEntry and TaskGetType.
enum EHPMTaskType {
EHPMTaskType_NewVersionOfSDKRequired = 0,
EHPMTaskType_Planned = 1,
EHPMTaskType_Milestone = 2,
};
Values
EHPMTaskType_NewVersionOfSDKRequired
The task type did not exist when this SDK was created. Upgrade to a newer version of the SDK to be able to use this format.
EHPMTaskType_Planned
The task is a planned task.
EHPMTaskType_Milestone
The task is a milestone.
See Also
HPMTaskChangeDispositionEntry, TaskGetType
EHPMTaskBacklogCategory
Backlog category used for TaskSetBacklogCategory and TaskGetBacklogCategory.
enum EHPMTaskBacklogCategory {
EHPMTaskBacklogCategory_NewVersionOfSDKRequired = 0,
EHPMTaskBacklogCategory_None = 1,
EHPMTaskBacklogCategory_Requirement = 2,
EHPMTaskBacklogCategory_Enhancement = 3,
EHPMTaskBacklogCategory_TechnologyUpgrade = 4,
EHPMTaskBacklogCategory_BugA = 5,
EHPMTaskBacklogCategory_BugB = 6,
EHPMTaskBacklogCategory_BugC = 7,
EHPMTaskBacklogCategory_BugD = 8,
};
Values
EHPMTaskBacklogCategory_NewVersionOfSDKRequired
The backlog category did not exist when this SDK was created. Upgrade to a newer version of the SDK to be able to use this format.
EHPMTaskBacklogCategory_None
No backlog category (unset).
EHPMTaskBacklogCategory_Requirement
A requirement.
EHPMTaskBacklogCategory_Enhancement
An enhancement.
EHPMTaskBacklogCategory_TechnologyUpgrade
A technology upgrade.
EHPMTaskBacklogCategory_BugA
A "A Bug".
EHPMTaskBacklogCategory_BugB
A "B Bug".
EHPMTaskBacklogCategory_BugC
A "C Bug".
EHPMTaskBacklogCategory_BugD
A "D Bug".
See Also
TaskSetBacklogCategory, TaskGetBacklogCategory
EHPMTaskSeverity
Backlog category used for TaskSetSeverity and TaskGetSeverity.
enum EHPMTaskSeverity {
EHPMTaskSeverity_NewVersionOfSDKRequired = 0,
EHPMTaskSeverity_None = 1,
EHPMTaskSeverity_A = 2,
EHPMTaskSeverity_B = 3,
EHPMTaskSeverity_C = 4,
EHPMTaskSeverity_D = 5,
};
Values
EHPMTaskSeverity_NewVersionOfSDKRequired
The severity type did not exist when this SDK was created. Upgrade to a newer version of the SDK to be able to use this severity type.
EHPMTaskSeverity_None
No severity (unset).
EHPMTaskSeverity_A
Severity type A.
EHPMTaskSeverity_B
Severity type B.
EHPMTaskSeverity_C
Severity type C.
EHPMTaskSeverity_D
Severity type D.
See Also
TaskSetSeverity, TaskGetSeverity
EHPMTaskConfidence
Confidence used for TaskSetConfidence and TaskGetConfidence.
enum EHPMTaskConfidence {
EHPMTaskConfidence_NewVersionOfSDKRequired = 0,
EHPMTaskConfidence_None = 1,
EHPMTaskConfidence_Low = 2,
EHPMTaskConfidence_Medium = 3,
EHPMTaskConfidence_High = 4,
};
Values
EHPMTaskConfidence_NewVersionOfSDKRequired
The confidence level did not exist when this SDK was created. Upgrade to a newer version of the SDK to be able to use this format.
EHPMTaskConfidence_None
No confidence (unset).
EHPMTaskConfidence_Low
Low confidence.
EHPMTaskConfidence_Medium
Medium confidence.
EHPMTaskConfidence_High
High confidence.
See Also
TaskSetConfidence, TaskGetConfidence
EHPMTaskPriority
Priority used for data history for deprecated priority.
enum EHPMTaskPriority {
EHPMTaskPriority_NewVersionOfSDKRequired = 0,
EHPMTaskPriority_None = 1,
EHPMTaskPriority_Low = 2,
EHPMTaskPriority_Medium = 3,
EHPMTaskPriority_High = 4,
};
Values
EHPMTaskPriority_NewVersionOfSDKRequired
The priority level did not exist when this SDK was created. Upgrade to a newer version of the SDK to be able to use this format.
EHPMTaskPriority_None
No priority (unset).
EHPMTaskPriority_Low
Low priority.
EHPMTaskPriority_Medium
Medium priority.
EHPMTaskPriority_High
High priority.
See Also
EHPMTaskRisk
Risk used for TaskSetRisk and TaskGetRisk
enum EHPMTaskRisk {
EHPMTaskRisk_NewVersionOfSDKRequired = 0,
EHPMTaskRisk_None = 1,
EHPMTaskRisk_Low = 2,
EHPMTaskRisk_Medium = 3,
EHPMTaskRisk_High = 4,
};
Values
EHPMTaskRisk_NewVersionOfSDKRequired
The risk level did not exist when this SDK was created. Upgrade to a newer version of the SDK to be able to use this format.
EHPMTaskRisk_None
No risk (unset).
EHPMTaskRisk_Low
Low risk.
EHPMTaskRisk_Medium
Medium risk.
EHPMTaskRisk_High
High risk.
See Also
EHPMTaskLastUserInterfaceAction
Last user interface action used for task history.
enum EHPMTaskLastUserInterfaceAction {
EHPMTaskLastUserInterfaceAction_NewVersionOfSDKRequired = 0,
EHPMTaskLastUserInterfaceAction_None = 1,
EHPMTaskLastUserInterfaceAction_WhenCreating = 2,
EHPMTaskLastUserInterfaceAction_AutoSummary = 3,
EHPMTaskLastUserInterfaceAction_UndoRedoProjectView = 4,
EHPMTaskLastUserInterfaceAction_UndoRedoWallView = 5,
EHPMTaskLastUserInterfaceAction_DraggingWallView = 6,
EHPMTaskLastUserInterfaceAction_SettingFromWorkRemaining_ProjectView = 7,
EHPMTaskLastUserInterfaceAction_SettingItemStatus_ProjectView = 8,
EHPMTaskLastUserInterfaceAction_SettingFromWorkRemaining_LosingFocus_DetailsWindow = 9,
EHPMTaskLastUserInterfaceAction_SettingFromWorkRemaining_SettingDirectly_DetailsWindow = 10,
EHPMTaskLastUserInterfaceAction_SettingItemStatus_DetailsWindow = 11,
};
Values
EHPMTaskLastUserInterfaceAction_NewVersionOfSDKRequired
The interface action did not exist when this SDK was created. Upgrade to a newer version of the SDK to be able to use this format.
EHPMTaskLastUserInterfaceAction_None
None.
EHPMTaskLastUserInterfaceAction_WhenCreating
Creating an item.
EHPMTaskLastUserInterfaceAction_AutoSummary
Auto summarizing an item.
EHPMTaskLastUserInterfaceAction_UndoRedoProjectView
When doing undo redo in project view.
EHPMTaskLastUserInterfaceAction_UndoRedoWallView
When doing undo redo in wall view.
EHPMTaskLastUserInterfaceAction_DraggingWallView
When dragging in wall view.
EHPMTaskLastUserInterfaceAction_SettingFromWorkRemaining_ProjectView
When setting work remaining from project view.
EHPMTaskLastUserInterfaceAction_SettingItemStatus_ProjectView
When setting item status from project view.
EHPMTaskLastUserInterfaceAction_SettingFromWorkRemaining_LosingFocus_DetailsWindow
When setting work remaining when focus is lost in details window.
EHPMTaskLastUserInterfaceAction_SettingFromWorkRemaining_SettingDirectly_DetailsWindow
When setting work remaining when directly inputting in details window.
EHPMTaskLastUserInterfaceAction_SettingItemStatus_DetailsWindow
When setting item status in details window.
See Also
EHPMTaskVacationOptionsFlag
Flags used for HPMTaskVacationOptions::m_Flags.
enum EHPMTaskVacationOptionsFlag {
EHPMTaskVacationOptionsFlag_None = 0,
EHPMTaskVacationOptionsFlag_WorkMonday = 1,
EHPMTaskVacationOptionsFlag_WorkTuesday = 2,
EHPMTaskVacationOptionsFlag_WorkWednesday = 4,
EHPMTaskVacationOptionsFlag_WorkThursday = 8,
EHPMTaskVacationOptionsFlag_WorkFriday = 16,
EHPMTaskVacationOptionsFlag_WorkSaturday = 32,
EHPMTaskVacationOptionsFlag_WorkSunday = 64,
EHPMTaskVacationOptionsFlag_IsVacationTask = 128,
EHPMTaskVacationOptionsFlag_WorkDaysValid = 256,
EHPMTaskVacationOptionsFlag_WorkPassesValid = 512,
EHPMTaskVacationOptionsFlag_UnionFreeDays = 1024,
EHPMTaskVacationOptionsFlag_UnionWorkingDays = 2048,
EHPMTaskVacationOptionsFlag_ShortestWorkingHours = 4096,
EHPMTaskVacationOptionsFlag_LongestWorkingHours = 8192,
};
Values
EHPMTaskVacationOptionsFlag_None
TBD
EHPMTaskVacationOptionsFlag_WorkMonday
Work on Mondays.
EHPMTaskVacationOptionsFlag_WorkTuesday
Work on Tuesdays.
EHPMTaskVacationOptionsFlag_WorkWednesday
Work on Wednesdays.
EHPMTaskVacationOptionsFlag_WorkThursday
Work on Thursdays.
EHPMTaskVacationOptionsFlag_WorkFriday
Work on Fridays.
EHPMTaskVacationOptionsFlag_WorkSaturday
Work on Saturdays.
EHPMTaskVacationOptionsFlag_WorkSunday
Work on Sundays.
EHPMTaskVacationOptionsFlag_IsVacationTask
This task is a vacation/out of office task. If this flag is not set, all other flags are ineffective.
EHPMTaskVacationOptionsFlag_WorkDaysValid
The work day flags are valid. If this flag is not set the work day flags are ignored.
EHPMTaskVacationOptionsFlag_WorkPassesValid
Work passes valid. If this flag is not set HPMTaskVacationOptions::m_WorkDays are ignored.
EHPMTaskVacationOptionsFlag_UnionFreeDays
Overlapping regions will union free days.
EHPMTaskVacationOptionsFlag_UnionWorkingDays
Overlapping regions will union working days.
EHPMTaskVacationOptionsFlag_ShortestWorkingHours
Overlapping regions will choose shortest working hours.
EHPMTaskVacationOptionsFlag_LongestWorkingHours
Overlapping regions will choose longest working hours.
Comments
If EHPMTaskVacationOptionsFlag_WorkDaysValid or EHPMTaskVacationOptionsFlag_WorkPassesValid is set the vacation task will we counted as a calender modifying task, otherwise it's a vacation task.
See Also
EHPMTaskCommentFlag
Flags used for HPMTaskComment::m_Flags.
enum EHPMTaskCommentFlag {
EHPMTaskCommentFlag_None = 0,
EHPMTaskCommentFlag_IsPosted = 1,
EHPMTaskCommentFlag_IsWriting = 2,
};
Values
EHPMTaskCommentFlag_None
TBD
EHPMTaskCommentFlag_IsPosted
The comment is posted.
EHPMTaskCommentFlag_IsWriting
Someone is writing in the comment.
See Also
EHPMTaskLinkedToLinkType
Link type used for HPMTaskLinkedToLink::m_LinkedToType.
enum EHPMTaskLinkedToLinkType {
EHPMTaskLinkedToLinkType_NewVersionOfSDKRequired = 0,
EHPMTaskLinkedToLinkType_TaskItemOrBug = 1,
EHPMTaskLinkedToLinkType_External = 2,
};
Values
EHPMTaskLinkedToLinkType_NewVersionOfSDKRequired
The linked to type did not exist when this SDK was created. Upgrade to a newer version of the SDK to be able to use this type.
EHPMTaskLinkedToLinkType_TaskItemOrBug
Linked to a task item or bug. The identifier should point to a task reference.
EHPMTaskLinkedToLinkType_External
Linked to an external URL. The HPMTaskLinkedToLink::m_LinkURL member must be set.
See Also
EHPMTaskLinkedToLinkSubType
Link type used for HPMTaskLinkedToLink::m_LinkedToSubType.
enum EHPMTaskLinkedToLinkSubType {
EHPMTaskLinkedToLinkSubType_NewVersionOfSDKRequired = 0,
EHPMTaskLinkedToLinkSubType_NotSet = 1,
EHPMTaskLinkedToLinkSubType_Duplicate = 2,
EHPMTaskLinkedToLinkSubType_Blocking = 3,
};
Values
EHPMTaskLinkedToLinkSubType_NewVersionOfSDKRequired
The linked to type did not exist when this SDK was created. Upgrade to a newer version of the SDK to be able to use this type.
EHPMTaskLinkedToLinkSubType_NotSet
EHPMTaskLinkedToLinkSubType_Duplicate
EHPMTaskLinkedToLinkSubType_Blocking
See Also
EHPMTaskWallItemColor
Wall item color used for TaskSetWallItemColor and TaskGetWallItemColor
enum EHPMTaskWallItemColor {
EHPMTaskWallItemColor_NewVersionOfSDKRequired = 0,
EHPMTaskWallItemColor_Yellow = 1,
EHPMTaskWallItemColor_Blue = 2,
EHPMTaskWallItemColor_Green = 3,
EHPMTaskWallItemColor_Red = 4,
EHPMTaskWallItemColor_Magenta = 5,
EHPMTaskWallItemColor_Orange = 6,
EHPMTaskWallItemColor_Cyan_DEPRECATED = 7,
};
Values
EHPMTaskWallItemColor_NewVersionOfSDKRequired
The wall item color did not exist when this SDK was created. Upgrade to a newer version of the SDK to be able to use this type.
EHPMTaskWallItemColor_Yellow
Yellow wall item color.
EHPMTaskWallItemColor_Blue
Blue wall item color.
EHPMTaskWallItemColor_Green
Green wall item color.
EHPMTaskWallItemColor_Red
Red wall item color.
EHPMTaskWallItemColor_Magenta
Magenta wall item color.
EHPMTaskWallItemColor_Orange
Orange wall item color.
EHPMTaskWallItemColor_Cyan_DEPRECATED
Cyan wall item color. No longer used by client. Will be treated as blue
See Also
TaskSetWallItemColor, TaskGetWallItemColor
EHPMTaskColor
Color used for TaskSetColor and TaskGetColor
enum EHPMTaskColor {
EHPMTaskColor_NewVersionOfSDKRequired = 0,
EHPMTaskColor_NotSet = 1,
EHPMTaskColor_Blue = 2,
EHPMTaskColor_Green = 3,
EHPMTaskColor_Red = 4,
EHPMTaskColor_Cyan = 5,
EHPMTaskColor_Magenta = 6,
EHPMTaskColor_Orange = 7,
EHPMTaskColor_Black = 8,
EHPMTaskColor_White = 9,
EHPMTaskColor_Pink = 10,
EHPMTaskColor_Yellow = 11,
EHPMTaskColor_Brown = 12,
};
Values
EHPMTaskColor_NewVersionOfSDKRequired
The color did not exist when this SDK was created. Upgrade to a newer version of the SDK to be able to use this type.
EHPMTaskColor_NotSet
Not set/No color.
EHPMTaskColor_Blue
Blue color.
EHPMTaskColor_Green
Green color.
EHPMTaskColor_Red
Red color.
EHPMTaskColor_Cyan
Cyan color.
EHPMTaskColor_Magenta
Magenta color.
EHPMTaskColor_Orange
Orange color.
EHPMTaskColor_Black
Black color.
EHPMTaskColor_White
White color.
EHPMTaskColor_Pink
Pink color.
EHPMTaskColor_Yellow
Yellow color.
EHPMTaskColor_Brown
Brown color.
See Also
EHPMTaskAgilePriorityCategory
The priorities used in TaskGetAgilePriorityCategory, TaskSetAgilePriorityCategory, TaskGetSprintPriority, TaskSetSprintPriority, TaskGetBacklogPriority, TaskSetBacklogPriority, TaskGetBugPriority and TaskSetBugPriority
enum EHPMTaskAgilePriorityCategory {
EHPMTaskAgilePriorityCategory_NewVersionOfSDKRequired = 0,
EHPMTaskAgilePriorityCategory_None = 1,
EHPMTaskAgilePriorityCategory_VeryLow = 2,
EHPMTaskAgilePriorityCategory_Low = 3,
EHPMTaskAgilePriorityCategory_Medium = 4,
EHPMTaskAgilePriorityCategory_High = 5,
EHPMTaskAgilePriorityCategory_VeryHigh = 6,
};
Values
EHPMTaskAgilePriorityCategory_NewVersionOfSDKRequired
The priorty dd not exist when this SDK was created. Upgrade to a newer version of the SDK to be able to use this type.
EHPMTaskAgilePriorityCategory_None
The no category.
EHPMTaskAgilePriorityCategory_VeryLow
The very low category.
EHPMTaskAgilePriorityCategory_Low
The low category.
EHPMTaskAgilePriorityCategory_Medium
The medium category.
EHPMTaskAgilePriorityCategory_High
The high category.
EHPMTaskAgilePriorityCategory_VeryHigh
The very high category.
See Also
TaskGetAgilePriorityCategory, TaskSetAgilePriorityCategory, TaskGetSprintPriority, TaskSetSprintPriority, TaskGetBacklogPriority, TaskSetBacklogPriority, TaskGetBugPriority, TaskSetBugPriority
EHPMTaskChangeDispositionEntryChangeFlag
Flags used for HPMTaskChangeDispositionEntry::m_ChangeFlags.
enum EHPMTaskChangeDispositionEntryChangeFlag {
EHPMTaskChangeDispositionEntryChangeFlag_None = 0,
EHPMTaskChangeDispositionEntryChangeFlag_PreviousRefID = 1,
EHPMTaskChangeDispositionEntryChangeFlag_TreeLevel = 2,
EHPMTaskChangeDispositionEntryChangeFlag_LinkedToSprint = 4,
EHPMTaskChangeDispositionEntryChangeFlag_LinkToMainRealWorkflowItem = 8,
EHPMTaskChangeDispositionEntryChangeFlag_TaskType = 16,
EHPMTaskChangeDispositionEntryChangeFlag_TaskLockedType = 32,
EHPMTaskChangeDispositionEntryChangeFlag_BoardPosition = 64,
};
Values
EHPMTaskChangeDispositionEntryChangeFlag_None
TBD
EHPMTaskChangeDispositionEntryChangeFlag_PreviousRefID
TBD
EHPMTaskChangeDispositionEntryChangeFlag_TreeLevel
TBD
EHPMTaskChangeDispositionEntryChangeFlag_LinkedToSprint
TBD
EHPMTaskChangeDispositionEntryChangeFlag_LinkToMainRealWorkflowItem
TBD
EHPMTaskChangeDispositionEntryChangeFlag_TaskType
TBD
EHPMTaskChangeDispositionEntryChangeFlag_TaskLockedType
TBD
EHPMTaskChangeDispositionEntryChangeFlag_BoardPosition
TBD
See Also
EHPMTaskChangeDispositionOptionFlag
Flags used for HPMTaskChangeDisposition::m_OptionFlags.
enum EHPMTaskChangeDispositionOptionFlag {
EHPMTaskChangeDispositionOptionFlag_None = 0,
EHPMTaskChangeDispositionOptionFlag_ChangeWorkPriorityDisposition = 1,
EHPMTaskChangeDispositionOptionFlag_ReportDebugInfoOnRejection = 2,
EHPMTaskChangeDispositionOptionFlag_AllowInvalidChanges = 4,
};
Values
EHPMTaskChangeDispositionOptionFlag_None
TBD
EHPMTaskChangeDispositionOptionFlag_ChangeWorkPriorityDisposition
Use to true to change the order of the work priority list. In this case only the HPMTaskChangeDispositionEntry::m_PreviousRefID property is valid.
EHPMTaskChangeDispositionOptionFlag_ReportDebugInfoOnRejection
Use to get a string of the task tree returned for debugging purposes if a rejection occurs for the disposition change. Will only be honored available in debug mode.
EHPMTaskChangeDispositionOptionFlag_AllowInvalidChanges
Use to allow invalid changes for debug purposes.
See Also
EHPMTaskCreateOptionFlag
Flags used for HPMTaskCreateUnified::m_OptionFlags.
enum EHPMTaskCreateOptionFlag {
EHPMTaskCreateOptionFlag_None = 0,
EHPMTaskCreateOptionFlag_UpdateCustomDateColumns = 1,
EHPMTaskCreateOptionFlag_SetDefaultValues = 2,
};
Values
EHPMTaskCreateOptionFlag_None
TBD
EHPMTaskCreateOptionFlag_UpdateCustomDateColumns
If set all custom date columns with EHPMProjectCustomColumnsColumnFlag_UpdateDate_OnNew will be set on creation and all custom date columns with EHPMProjectCustomColumnsColumnFlag_UpdateDate_OnCommited will be set on commit.
EHPMTaskCreateOptionFlag_SetDefaultValues
If set all columns with a default value defined in HPMProjectColumnMetaData will be populated with the default value on creation.
See Also
EHPMTaskConnectionFlag
Flags used for TaskRefConnectionsEnum.
enum EHPMTaskConnectionFlag {
EHPMTaskConnectionFlag_None = 0,
EHPMTaskConnectionFlag_Dependencies = 1,
EHPMTaskConnectionFlag_Dependents = 2,
};
Values
EHPMTaskConnectionFlag_None
TBD
EHPMTaskConnectionFlag_Dependencies
Include connections from the given task reference.
EHPMTaskConnectionFlag_Dependents
Include connections to the given task reference.
See Also
EHPMTaskSetStatusFlag
Flags used for TaskSetWorkflowStatus, TaskSetStatus and TaskSetResourceAllocation.
enum EHPMTaskSetStatusFlag {
EHPMTaskSetStatusFlag_None = 0,
EHPMTaskSetStatusFlag_DoAutoAssignments = 1,
EHPMTaskSetStatusFlag_DoAutoCompletion = 2,
EHPMTaskSetStatusFlag_All = 2147483647,
};
Values
EHPMTaskSetStatusFlag_None
TBD
EHPMTaskSetStatusFlag_DoAutoAssignments
Auto assign resources according to workflow rules
EHPMTaskSetStatusFlag_DoAutoCompletion
Set item status and work remaining according to worklow rules
EHPMTaskSetStatusFlag_All
TBD
See Also
TaskSetWorkflowStatus, TaskSetStatus, TaskSetResourceAllocation
EHPMTaskFindFlag
Flags used for TaskFind.
enum EHPMTaskFindFlag {
EHPMTaskFindFlag_None = 0,
EHPMTaskFindFlag_ArchivedProjects = 1,
};
Values
EHPMTaskFindFlag_None
TBD
EHPMTaskFindFlag_ArchivedProjects
Include archived projects in global find.
See Also
HPMTaskEnum
Used for enumerating tasks or task references in a container.
struct HPMTaskEnum {
HPMUInt32 m_nTasks;
const HPMUniqueID * m_pTasks;
} HPMTaskEnum;
Members
m_nTasks
The number of task enumerated.
m_pTasks
Pointer to a list of unique identifiers pointing to the tasks or task references.
See Also
TaskEnum, TaskRefEnum, TaskEnumReferences
HPMTaskConnectionEnum
Used for enumerating connected tasks.
struct HPMTaskConnectionEnum {
HPMUInt32 m_nConnectedTasks;
const HPMUniqueID * m_pConnectedTasks;
} HPMTaskConnectionEnum;
Members
m_nConnectedTasks
The number of connected tasks enumerated.
m_pConnectedTasks
Pointer to a list of unique reference identifiers pointing to the connected task refs.
See Also
HPMTaskCustomColumnDataEnum
Used for enumerating custom column data on a task.
struct HPMTaskCustomColumnDataEnum {
HPMUInt32 m_nHashes;
const HPMUInt32 * m_pHashes;
} HPMTaskCustomColumnDataEnum;
Members
m_nHashes
The enumerated column hash values
m_pHashes
Pointer to a list of column hash values that represent the custom column data that is stored on a task.
See Also
HPMTaskCreateUnifiedReference
Used for HPMTaskCreateUnifiedEntry.
struct HPMTaskCreateUnifiedReference {
HPMInt32 m_bLocalID;
HPMInt32 m_bHasNonSumbittedBetween;
HPMUniqueID m_RefID;
} HPMTaskCreateUnifiedReference;
Members
m_bLocalID
Set to 1 if m_RefID points to a local id. Local ID:s are only valid for tasks specified in the same HPMTaskCreateUnified structure.
m_bHasNonSumbittedBetween
Set to 1 if m_RefID points to a id that has tasks after it that was not included in this create command.
m_RefID
The unique ID of the task to link to. Can be both a reference ID and a normal task ID depending on the thing referred to.
See Also
HPMTaskCreateUnifiedEntry
Used for HPMTaskCreateUnified. All entries are sanitized on the server, and changed to the most appropriate value. If for example the immediate parent doesn't exist, the task is created under the next immediate parent and so forth.
struct HPMTaskCreateUnifiedEntry {
HPMInt32 m_bIsProxy;
HPMUniqueID m_LocalID;
HPMUniqueID m_ReuseUniqueRefID;
HPMInt32 m_TaskType;
HPMInt32 m_TaskLockedType;
HPMUniqueID m_Proxy_ReferToRefTaskID;
HPMUniqueID m_NonProxy_ReuseUniqueID;
HPMUInt32 m_NonProxy_ReuseID;
HPMUInt32 m_NonProxy_WorkflowID;
HPMUInt32 m_NonProxy_bRestoreFromHistory;
HPMTaskCreateUnifiedReference m_PreviousRefID;
HPMTaskCreateUnifiedReference m_PreviousWorkPrioRefID;
HPMUInt32 m_nParentRefIDs;
const HPMTaskCreateUnifiedReference * m_pParentRefIDs;
HPMUInt32 m_bIsBoard;
HPMInt32 m_bUseNonDefaultBoardConfiguration;
HPMBoardConfiguration m_BoardConfiguration;
HPMUniqueID m_ColumnID;
HPMFP64 m_Position;
HPMUInt32 m_bUseLocalColumnID;
} HPMTaskCreateUnifiedEntry;
Members
m_bIsProxy
Set to true if this entry is a proxy.
m_LocalID
Used to match this entry against against HPMChangeCallbackData_TaskCreateUnified::m_LocalTempRefID. Also used to refer to this task by local id in HPMTaskCreateUnifiedReference.
m_ReuseUniqueRefID
Valid for both proxies and normal tasks. If a unique task reference identifier is free and the task originates from that identifier, specify it here. This is used in undo/redo/copy/paste/import/export/etc to be able to keep track of tasks in project history. This is the reference identifier.
m_TaskType
Should be one of EHPMTaskType. If a type that is invalid in the particular position or type of project this task is created in, the type will be reset to a valid value.
m_TaskLockedType
Should be one of EHPMTaskLockedType. If a type that is invalid in the particular position or type of project this task is created in, the type will be reset to a valid value.
m_Proxy_ReferToRefTaskID
Valid only for proxy tasks, ignored otherwise. This is the task reference unique identifier of the task that the proxy is to refer to. Currently the only supported usage is to create a proxy in a sprint where the proxy points to a task reference in the project backlog.
m_NonProxy_ReuseUniqueID
Valid only for normal tasks, ignored otherwise. If the a unique task identifier is free and the task originates from that identifier, specify it here. This is used to preserve task history for the task.
m_NonProxy_ReuseID
Valid only for normal tasks, ignored otherwise. If the a identifier is free and the task originates from that identifier, specify it here. This is used in undo/redo/copy/paste/import/export/etc to be able to keep the same user id. This is the identifier that is presented as the numeric identifier to the user.
m_NonProxy_WorkflowID
Valid only for normal tasks, ignored otherwise. If this is set to anything else than 0xffffffff this refers to the workflow or pipeline the newly created task should have.
m_NonProxy_bRestoreFromHistory
Restores task properties from change history found on the ID in m_NonProxy_ReuseUniqueID.
m_PreviousRefID
This should refer to the previous reference of the task you want to insert this task after in the schedule disposition. This is a flat list. If you want to insert it at the top of the list specify -1.
m_PreviousWorkPrioRefID
This should refer to the previous reference of the task you want to insert this task after in the work priority list. If you want to insert it at the top of the list specify -2.
m_nParentRefIDs
The number of parent references this task has.
m_pParentRefIDs
Here you should specify the whole list of parent references for the place where you want to create this task in the schedule disposition. The first entry should be the task closest to the root of the schedule, the last entry the immediate parent of the task you are creating. You must at least specify the closest parent. The whole parent chain is only used if a parent is deleted before the create message reaches the server. If the chain is sent and a parent is deleted, the new task will end up as close as possible to the intended location, otherwise it will end up at the root level.
m_bIsBoard
Represents whether to create sprint as a board.
m_bUseNonDefaultBoardConfiguration
If you create board and want to create it with non default configuration set this to true and specify m_BoardConfiguration.
m_BoardConfiguration
Optional board configuration.
m_ColumnID
Optional, for tasks committed to Board only. Id of the board's column to insert task in. This is used only if task is being created in board. If column with this ID does not exist - task will be committed to the end of Board's default column.
m_Position
Optional, for tasks committed to Board only. Position for task in m_ColumnID. This is used only when non proxy task is being created in board and m_ColumnID identifies existing column. Otherwise task will be appended to the end of Board's default column.
m_bUseLocalColumnID
Represents whether m_ColumnID points to Database ID, or to local column ID (one of the columnIDs that are passing with some m_BoardConfiguration of some board in the same task creation command).
See Also
HPMTaskCreateUnified
Used for TaskCreateUnified.
struct HPMTaskCreateUnified {
HPMUInt32 m_nTasks;
const HPMTaskCreateUnifiedEntry * m_pTasks;
HPMUInt32 m_OptionFlags;
} HPMTaskCreateUnified;
Members
m_nTasks
The number of tasks to create.
m_pTasks
Link to a list of HPMTaskCreateUnifiedEntry specifying the properties of the tasks you want to create.
m_OptionFlags
The options for this create. Can be any combination of EHPMTaskCreateOptionFlag.
See Also
HPMTaskChangeDispositionEntry
Used for HPMTaskChangeDisposition. All entries are sanitized and changed to the most appropriete value. If for example the immediate parent doesn't exist, the task is created under the next immediate parent and so forth.
struct HPMTaskChangeDispositionEntry {
HPMUniqueID m_TaskRefID;
HPMUInt32 m_ChangeFlags;
HPMUniqueID m_PreviousRefID;
HPMUInt32 m_TreeLevel;
HPMUniqueID m_LinkedToSprint;
HPMUniqueID m_LinkedToPipelineTask;
HPMUInt32 m_TaskType;
HPMUInt32 m_TaskLockedType;
HPMUniqueID m_ColumnID;
HPMFP64 m_Position;
} HPMTaskChangeDispositionEntry;
Members
m_TaskRefID
The unique reference ID of the task to change disposition for.
m_ChangeFlags
Determines the values you want to set for this task. If the corresponding flag is not set, the values below are ignored. Can be any combination of EHPMTaskChangeDispositionEntryChangeFlag.
m_PreviousRefID
The previous ID to set for the of the task ref.
m_TreeLevel
The tree level to set for the task ref.
m_LinkedToSprint
The task reference ID of the sprint to set on the task ID for the task reference id.
m_LinkedToPipelineTask
The task ID of the pipeline task to set on the task ID for the task reference id.
m_TaskType
The task type to set on the task ID for the task reference id. Can be one of EHPMTaskType.
m_TaskLockedType
The task type to set on the task ID for the task reference id. Can be one of EHPMTaskLockedType.
m_ColumnID
Optional, used for tasks committed to board only (m_LinkedToSprint represents a board). ID of the column on the board to insert task in. This is used only if task is being committed to a board. If a column with this ID does not exist, the task will be committed to the last position of the board's default column.
m_Position
Optional, used for tasks committed to Board only (m_LinkedToSprint represents a board). Position for task in m_ColumnID. This is used only when a task is being committed to board and m_ColumnID identifies an existing column. Otherwise the task will be appended to the last position of the board's default column.
See Also
HPMTaskChangeDisposition
Used for TaskChangeDisposition.
struct HPMTaskChangeDisposition {
HPMUInt32 m_OptionFlags;
HPMUInt32 m_nTasksToChange;
const HPMTaskChangeDispositionEntry * m_pTasksToChange;
} HPMTaskChangeDisposition;
Members
m_OptionFlags
The options for this disposition change. Can be any combination of EHPMTaskChangeDispositionOptionFlag.
m_nTasksToChange
The number of tasks to change disposition for.
m_pTasksToChange
Link to a list of HPMTaskChangeDispositionEntry specifying the changes you want to make to the tasks.
See Also
HPMTaskAttachedDocumentsEntry
Attached document entry used by HPMTaskAttachedDocuments::m_pAttachedDocuments.
struct HPMTaskAttachedDocumentsEntry {
HPMUniqueID m_AddedByResource;
HPMUInt64 m_FileID;
} HPMTaskAttachedDocumentsEntry;
Members
m_AddedByResource
The resource that attached the document.
m_FileID
The file id of the document. To get the file id from a file path, use VersionControlUtilPathToFileID.
See Also
HPMTaskAttachedDocuments, VersionControlUtilPathToFileID
HPMTaskAttachedDocuments
Used for specifying attached documents in TaskSetAttachedDocuments and TaskGetAttachedDocuments
struct HPMTaskAttachedDocuments {
HPMUInt32 m_nAttachedDocuments;
const HPMTaskAttachedDocumentsEntry * m_pAttachedDocuments;
HPMUInt64 m_TaskMainImageID;
} HPMTaskAttachedDocuments;
Members
m_nAttachedDocuments
The number of attached documents.
m_pAttachedDocuments
Pointer to a list of attached documents. See HPMTaskAttachedDocumentsEntry.
m_TaskMainImageID
The file id of image that is shown on task in board. 0xffffffffffffffff indicates no image.
See Also
TaskSetAttachedDocuments, TaskGetAttachedDocuments, HPMTaskAttachedDocumentsEntry
HPMTaskResourceAllocationResource
Used in HPMTaskResourceAllocation::m_pResources to specify how much of a resource is allocated to a task.
struct HPMTaskResourceAllocationResource {
HPMUniqueID m_ResourceID;
HPMInt32 m_PercentAllocated;
} HPMTaskResourceAllocationResource;
Members
m_ResourceID
The unique identifier of the resource allocated to the task.
m_PercentAllocated
The number of percent the resource is allocated to the task. 0 - 100.
See Also
HPMTaskResourceAllocation
Used for specifying resource allocation in TaskSetResourceAllocation and TaskGetResourceAllocation.
struct HPMTaskResourceAllocation {
HPMUInt32 m_nResources;
const HPMTaskResourceAllocationResource * m_pResources;
} HPMTaskResourceAllocation;
Members
m_nResources
The number of resources to allocate to the task
m_pResources
Pointer to a list of resources allocated to the task. See HPMTaskResourceAllocationResource.
See Also
TaskSetResourceAllocation, TaskGetResourceAllocation, HPMTaskResourceAllocationResource
HPMResourceReference
Used to specify a reference to a resource or resource group.
struct HPMResourceReference {
HPMInt32 m_ResourceType;
HPMUniqueID m_ID;
} HPMResourceReference;
Members
m_ResourceType
The type of reference. See EHPMResourceGroupingType.
m_ID
The unique identifier of the resource or resource group.
See Also
HPMTaskSprintAllocatedResources, HPMTaskCommentsOptions, EHPMResourceGroupingType
HPMTaskSprintAllocatedResources
Used for specifying resource allocation in TaskSetSprintAllocatedResources and TaskGetSprintAllocatedResources
struct HPMTaskSprintAllocatedResources {
HPMUInt32 m_nResources;
const HPMResourceReference * m_pResources;
} HPMTaskSprintAllocatedResources;
Members
m_nResources
The number of resources allocated to the sprint.
m_pResources
Pointer to a list of HPMResourceReference to specify the resources allocated to this sprint.
See Also
TaskSetSprintAllocatedResources, TaskGetSprintAllocatedResources, HPMResourceReference
HPMTaskSprintResourceAllocationResource
Used for specifying the percent allocation of a resource in HPMTaskSprintResourceAllocation.
struct HPMTaskSprintResourceAllocationResource {
HPMUniqueID m_ID;
HPMUInt32 m_AllocatedPercent;
} HPMTaskSprintResourceAllocationResource;
Members
m_ID
The unique identifier of the resource to specify the allocated percent for.
m_AllocatedPercent
The allocated percent of the resource.
See Also
HPMTaskSprintResourceAllocation
HPMTaskSprintResourceAllocation
Used in TaskSetSprintResourceAllocation and TaskGetSprintResourceAllocation to specify the number of percent of a resource is allocated to a sprint.
struct HPMTaskSprintResourceAllocation {
HPMUInt32 m_nResources;
const HPMTaskSprintResourceAllocationResource * m_pResources;
} HPMTaskSprintResourceAllocation;
Members
m_nResources
The number of resources to specify allocation for
m_pResources
Pointer to a list of HPMTaskSprintResourceAllocationResource to specify the allocated percent of resources.
Comments
Resources not specified here but allocated to the sprint implicitly have 100 % resource allocation.
See Also
TaskSetSprintResourceAllocation, TaskGetSprintResourceAllocation, HPMTaskSprintResourceAllocationResource
HPMTaskTimeZonesZone
Used in HPMTaskTimeZones to specify the start and end time of a zone.
struct HPMTaskTimeZonesZone {
HPMUInt64 m_Start;
HPMUInt64 m_End;
} HPMTaskTimeZonesZone;
Members
m_Start
The start time expressed as micro seconds since 1970 UTC.
m_End
The end time expressed as micro seconds since 1970 UTC.
See Also
HPMTaskTimeZones
Used in TaskSetTimeZones and TaskGetTimeZones to specify the timezones for a task.
struct HPMTaskTimeZones {
HPMUInt32 m_nZones;
const HPMTaskTimeZonesZone * m_pZones;
} HPMTaskTimeZones;
Members
m_nZones
The number of timezones in the task.
m_pZones
Pointer to a list of HPMTaskTimeZonesZone specifying the time zones.
Comments
The time zones should be specified ordered by start date and should not overlap. The zones should also be aligned on days so they start and end at midnight.
HPMTaskUIDHistory
Used in TaskRefSetUIDHistory and TaskRefGetUIDHistory to specify the unique identifier history of a task reference.
struct HPMTaskUIDHistory {
HPMUInt32 m_nUIDs;
const HPMUniqueID * m_pUIDs;
} HPMTaskUIDHistory;
Members
m_nUIDs
The number of unique identifiers in the history.
m_pUIDs
Pointer to a list of unique identifiers.
Comments
The history is updated when a task is copied etc to keep track of the parentage of a task. This allows tasks to be matched in the project history. When you copy tasks you should update this member if you want the project history to work correctly. The newest unique id should be at the start of the list so that older identifiers remain at the end of the list.
See Also
TaskRefSetUIDHistory, TaskRefGetUIDHistory
HPMResourceAllocationHistoryEntry
Used in HPMTaskWorkRemainingHistory to specify a the hours remaining of a task on a specific day.
struct HPMResourceAllocationHistoryEntry {
HPMUniqueID m_ResourceID;
HPMInt32 m_PercentAllocated;
} HPMResourceAllocationHistoryEntry;
Members
m_ResourceID
The unique identifier of the resource allocated to the task.
m_PercentAllocated
The number of percent the resource is allocated to the task. 0 - 100.
See Also
HPMTaskWorkRemainingHistoryEntry
Used in HPMTaskWorkRemainingHistory to specify a the hours remaining of a task on a specific day.
struct HPMTaskWorkRemainingHistoryEntry {
HPMUniqueID m_TaskRefID;
HPMFP32 m_nHoursRemaining;
HPMInt32 m_bResourcesValid;
HPMUInt32 m_nResourceAllocationEntries;
const HPMResourceAllocationHistoryEntry * m_pResourceAllocationEntries;
} HPMTaskWorkRemainingHistoryEntry;
Members
m_TaskRefID
The unique identifier of a task reference that belongs to a sprint.
m_nHoursRemaining
The number of hours that is remaining on the task.
m_bResourcesValid
Specifies whether or not the resource allocation entries are valid.
m_nResourceAllocationEntries
The number of resource allocation entries for this history entry.
m_pResourceAllocationEntries
Pointer to a list of HPMResourceAllocationHistoryEntry to specify the resource allocation entries for this history entry.
See Also
HPMTaskWorkRemainingHistory
Used in TaskSetWorkRemainingHistory and TaskGetWorkRemainingHistory to specify the work remaining on a number of tasks for a specific date.
struct HPMTaskWorkRemainingHistory {
HPMInt32 m_bHaveSetData;
HPMUInt32 m_nEntries;
const HPMTaskWorkRemainingHistoryEntry * m_pEntries;
} HPMTaskWorkRemainingHistory;
Members
m_bHaveSetData
Set to 1 if there exist any data, 0 otherwise.
m_nEntries
The number of tasks to specify work remaining for.
m_pEntries
Pointer to a list of HPMTaskWorkRemainingHistoryEntry to specify work remaining on tasks.
See Also
TaskSetWorkRemainingHistory, TaskGetWorkRemainingHistory, HPMTaskWorkRemainingHistoryEntry
HPMTaskWorkRemainingHistoryDaysEnum
Used in TaskEnumWorkRemainingHistoryDays to enumerate the days that has work remaining history specified for on sprint task.
struct HPMTaskWorkRemainingHistoryDaysEnum {
HPMUInt32 m_nDays;
const HPMUInt32 * m_pDays;
} HPMTaskWorkRemainingHistoryDaysEnum;
Members
m_nDays
The number of days that has work remaining history specified.
m_pDays
Pointer to a list of days that has work remaining history specified. The days are expressed as the number of days from the start of the sprint.
See Also
TaskEnumWorkRemainingHistoryDays
HPMTaskIdealDaysHistoryEntry
Used in HPMTaskIdealDaysHistory to specify a the ideal days of a task on a specific day.
struct HPMTaskIdealDaysHistoryEntry {
HPMUniqueID m_TaskRefID;
HPMFP32 m_Value;
HPMFP32 m_ValueNotDone;
HPMInt32 m_bResourcesValid;
HPMUInt32 m_nResourceAllocationEntries;
const HPMResourceAllocationHistoryEntry * m_pResourceAllocationEntries;
} HPMTaskIdealDaysHistoryEntry;
Members
m_TaskRefID
The unique identifier of a task reference that belongs to a sprint.
m_Value
The number of ideal days that that are completed on the task.
m_ValueNotDone
The number of ideal days that are not completed on the task.
m_bResourcesValid
Specifies whether or not the resource allocation entries are valid.
m_nResourceAllocationEntries
The number of resource allocation entries for this history entry.
m_pResourceAllocationEntries
Pointer to a list of HPMResourceAllocationHistoryEntry to specify the resource allocation entries for this history entry.
See Also
HPMTaskIdealDaysHistory
Used in TaskSetIdealDaysHistory and TaskGetIdealDaysHistory to specify the ideal days on a number of tasks for a specific date.
struct HPMTaskIdealDaysHistory {
HPMInt32 m_bHaveSetData;
HPMUInt32 m_nEntries;
const HPMTaskIdealDaysHistoryEntry * m_pEntries;
} HPMTaskIdealDaysHistory;
Members
m_bHaveSetData
Set to 1 if there exist any data, 0 otherwise.
m_nEntries
The number of tasks to specify ideal days for.
m_pEntries
Pointer to a list of HPMTaskIdealDaysHistoryEntry to specify work remaining on tasks.
See Also
TaskSetIdealDaysHistory, TaskGetIdealDaysHistory, HPMTaskIdealDaysHistoryEntry
HPMTaskPointsHistoryEntry
Used in HPMTaskPointsHistory to specify points of a task on a specific day.
struct HPMTaskPointsHistoryEntry {
HPMUniqueID m_TaskRefID;
HPMInt32 m_Value;
HPMInt32 m_ValueNotDone;
HPMInt32 m_bResourcesValid;
HPMUInt32 m_nResourceAllocationEntries;
const HPMResourceAllocationHistoryEntry * m_pResourceAllocationEntries;
} HPMTaskPointsHistoryEntry;
Members
m_TaskRefID
The unique identifier of a task reference that belongs to a sprint.
m_Value
The number of points that are completed on the task.
m_ValueNotDone
The number of points that are not completed on the task.
m_bResourcesValid
Specifies whether or not the resource allocation entries are valid.
m_nResourceAllocationEntries
The number of resource allocation entries for this history entry.
m_pResourceAllocationEntries
Pointer to a list of HPMResourceAllocationHistoryEntry to specify the resource allocation entries for this history entry.
See Also
HPMTaskPointsHistory
Used in TaskSetPointsHistory and TaskGetPointsHistory to specify the points on a number of tasks for a specific date.
struct HPMTaskPointsHistory {
HPMInt32 m_bHaveSetData;
HPMUInt32 m_nEntries;
const HPMTaskPointsHistoryEntry * m_pEntries;
} HPMTaskPointsHistory;
Members
m_bHaveSetData
Set to 1 if there exist any data, 0 otherwise.
m_nEntries
The number of tasks to specify points for.
m_pEntries
Pointer to a list of HPMTaskPointsHistoryEntry to specify work remaining on tasks.
See Also
TaskSetPointsHistory, TaskGetPointsHistory, HPMTaskPointsHistoryEntry
HPMTaskHistoryDaysEnum
Used in TaskEnumPointsHistoryDays and TaskEnumIdealDaysHistoryDays to enumerate the days that has ideal days or points history specified for on sprint task.
struct HPMTaskHistoryDaysEnum {
HPMUInt32 m_nDays;
const HPMUInt32 * m_pDays;
} HPMTaskHistoryDaysEnum;
Members
m_nDays
The number of days that has history specified.
m_pDays
Pointer to a list of days that history specified. The days are expressed as the number of days from the start of the sprint.
See Also
TaskEnumPointsHistoryDays, TaskEnumIdealDaysHistoryDays
HPMTaskVacationOptions
Used in TaskGetVacationOptions and TaskGetVacationOptions to specify the vacations options for a task.
struct HPMTaskVacationOptions {
HPMUInt32 m_Flags;
HPMWorkDay m_WorkDays[7];
} HPMTaskVacationOptions;
Members
m_Flags
Vacation/calender flags. Can be any combination of EHPMTaskVacationOptionsFlag.
m_WorkDays
Used to specify work passes for the days of the week. See HPMWorkDay.
See Also
TaskGetVacationOptions, TaskSetVacationOptions
HPMTaskLinkedToMilestones
Used in TaskSetLinkedToMilestones and TaskGetLinkedToMilestones to specify the milestones a task is linked to.
struct HPMTaskLinkedToMilestones {
HPMUInt32 m_nMilestones;
const HPMUniqueID * m_pMilestones;
} HPMTaskLinkedToMilestones;
Members
m_nMilestones
The number of milestones the task is linked to.
m_pMilestones
Pointer to a list of unique identifiers pointing to the task references of the milestones this task is linked to.
See Also
TaskSetLinkedToMilestones, TaskGetLinkedToMilestones
HPMTaskMilestones
Used to specify the milestones a task is linked to.
struct HPMTaskMilestones {
HPMUniqueID m_TaskID;
HPMUInt32 m_nMilestoneIDs;
const HPMUniqueID * m_pMilestoneIDs;
} HPMTaskMilestones;
Members
m_TaskID
The unique ID of the task.
m_nMilestoneIDs
The number of milestones the task is linked to.
m_pMilestoneIDs
Pointer to a list of unique identifiers pointing to the task references of the milestones the task m_TaskID is linked to.
See Also
HPMTaskMilestonesList
List of {HPMTaskMilestones}. Used in TaskLinkToMilestones to link a group of tasks to milestones within one DB command.
struct HPMTaskMilestonesList {
HPMUInt32 m_nTaskMilestones;
HPMTaskMilestones * m_pTaskMilestones;
} HPMTaskMilestonesList;
Members
m_nTaskMilestones
The size of the list.
m_pTaskMilestones
Pointer to the head of a list of HPMTaskMilestones.
See Also
HPMTaskMilestones, TaskLinkToMilestones
HPMTaskEffectiveLinkedToMilestones
Used in TaskUtilGetEffectiveLinkedToMilestones to specify the milestones a task is linked to.
struct HPMTaskEffectiveLinkedToMilestones {
HPMInt32 m_bInherited;
HPMInt32 m_bInheritedFromBacklog;
HPMTaskLinkedToMilestones m_Milestones;
} HPMTaskEffectiveLinkedToMilestones;
Members
m_bInherited
Set to 1 if the milestones are inherited from parent.
m_bInheritedFromBacklog
Set to 1 if the milestones are inherited from an item in the backlog, when the task is in the scheduled view.
m_Milestones
The effective milestones
See Also
TaskUtilGetEffectiveLinkedToMilestones
HPMTaskLinkedToLink
Used in HPMTaskLinkedTo::m_pLinkedTo to specify an object the task is linked to.
struct HPMTaskLinkedToLink {
HPMInt32 m_LinkedToType;
HPMUniqueID m_LinkedTo;
HPMInt32 m_LinkedToSubType;
HPMInt32 m_bLinkedFrom;
const HPMChar * m_pLinkNotes;
const HPMChar * m_pLinkURL;
} HPMTaskLinkedToLink;
Members
m_LinkedToType
The type of link. See EHPMTaskLinkedToLinkType.
m_LinkedTo
The identifier of the linked to object.
m_LinkedToSubType
The type of sublink. See EHPMTaskLinkedToLinkSubType.
m_bLinkedFrom
Set to 1 if link is 'From' vs 'To' the item
m_pLinkNotes
Text of the notes associated with the link
m_pLinkURL
The URL for links of type=EHPMTaskLinkedToLinkType_External
See Also
HPMTaskLinkedTo, EHPMTaskLinkedToLinkType
HPMTaskLinkedTo
Used in TaskSetLinkedTo and TaskGetLinkedTo to specify the objects a task is linked to.
struct HPMTaskLinkedTo {
HPMUInt32 m_nLinkedTo;
const HPMTaskLinkedToLink * m_pLinkedTo;
} HPMTaskLinkedTo;
Members
m_nLinkedTo
The number of objects the task is linked to.
m_pLinkedTo
Pointer to a list of HPMTaskLinkedToLink the task is linked to.
See Also
TaskSetLinkedTo, TaskGetLinkedTo, HPMTaskLinkedToLink
HPMTaskComment
Used for TaskSetComment and TaskGetComment to specify the properties of a comment post.
struct HPMTaskComment {
HPMInt32 m_ParentID;
HPMUInt32 m_Flags;
HPMUInt64 m_PostDate;
HPMUniqueID m_PostedByResourceID;
const HPMChar * m_pPostedByResource;
const HPMChar * m_pMessageText;
HPMUInt32 m_nMentionedUsers;
HPMUniqueID const * m_pMentionedUsers;
} HPMTaskComment;
Members
m_ParentID
The identifier of the parent of this post. -1 for root comment.
m_Flags
Comment flags. Can be any combination of EHPMTaskCommentFlag.
m_PostDate
The time this comment was posted. Expressed as the number of micro seconds since 1970 UTC.
m_PostedByResourceID
The unique identifier of the resource that posted the comment.
m_pPostedByResource
The name of the resource that posted the comment. This is used if the resource identifier is invalid after the resource has been deleted.
m_pMessageText
The text contents of the comment post. See comments for supported formatting tags.
m_nMentionedUsers
Number of users that are mentioned in comment post.
m_pMentionedUsers
Pointer to list of users that are mentioned in comment post.
Comments
The following formatting tags can be used in the message text: Quotes: <QUOTE></QUOTE> Ordered Lists: <OL> <LI>Item 1</LI> <LI>Item 2</LI> </OL> Unordered Lists: <UL> <LI>Item 1</LI> <LI>Item 2</LI> </UL> Images: <Image="URL"/> Link: <URL="URL">Link Text</URL> Color: <COLOR="R,G,B">Text</COLOR> Background Color: <BGCOLOR="R,G,B">Text</BGCOLOR > Bold: <BOLD>Text</BOLD> Underline: <UNDERLINE>Text</UNDERLINE> Italic: <ITALIC>Text</ITALIC>
See Also
TaskSetComment, TaskGetComment
HPMTaskCommentEnum
Used in TaskEnumComments to enumerate the comment posts of a task.
struct HPMTaskCommentEnum {
HPMUInt32 m_nComments;
const HPMInt32 * m_pComments;
} HPMTaskCommentEnum;
Members
m_nComments
The number of comments the task contains.
m_pComments
Pointer to a list of post identifiers contained in the task.
See Also
HPMTaskCommentsOptions
Used in TaskSetCommentsOptions and TaskGetCommentsOptions to specify the task comment options.
struct HPMTaskCommentsOptions {
HPMUInt32 m_nCCNotificationsTo;
const HPMResourceReference * m_pCCNotificationsTo;
} HPMTaskCommentsOptions;
Members
m_nCCNotificationsTo
The number of resources or resource groups to CC comment changes of this task to.
m_pCCNotificationsTo
Pointer to a list of HPMResourceReference that specifies the resources to CC comment changes to.
See Also
TaskSetCommentsOptions, TaskGetCommentsOptions, HPMResourceReference
HPMTaskWallPosition
Used in HPMTaskWallPositions to specify a wall position.
struct HPMTaskWallPosition {
HPMInt32 m_GroupingType;
HPMUInt32 m_GroupingID;
HPMUniqueID m_GroupingSprintUID;
HPMFP32 m_PositionX;
HPMFP32 m_PositionY;
HPMInt32 m_bPositionHasBeenSet;
} HPMTaskWallPosition;
Members
m_GroupingType
The grouping type this wall position specifies a position for. Can be one of EHPMWallGroupingType.
m_GroupingID
The identifier within the grouping type specifying the grouping. Only valid when m_GroupingType is EHPMWallGroupingType_DefaultColumn or EHPMWallGroupingType_CustomColumn.
m_GroupingSprintUID
The unique identifier of the selected sprint in the main project wall view.
m_PositionX
The horizontal position of the task on the the wall.
m_PositionY
The vertical position of the task on the wall.
m_bPositionHasBeenSet
Set to 1 if the position has been explicitly set.
See Also
HPMTaskWallPositions, EHPMWallGroupingType
HPMTaskCustomSummaryValue
Used in HPMTaskSummary to hold summation of custom integer and float columns.
struct HPMTaskCustomSummaryValue {
HPMUInt32 m_Hash;
HPMUInt32 m_Type;
HPMInt32 m_IntegerValue;
HPMFP64 m_FloatValue;
HPMUInt32 m_Errors;
} HPMTaskCustomSummaryValue;
Members
m_Hash
The hash of the column. To calculate the hash of a column you can use UtilGetColumnHash.
m_Type
The type of column. Can be EHPMProjectCustomColumnsColumnType_IntegerNumber or EHPMProjectCustomColumnsColumnType_FloatNumber.
m_IntegerValue
If HPMTaskCustomSummaryValue::m_Type is set to EHPMProjectCustomColumnsColumnType_IntegerNumber this holds the value otherwise it is set to 0.
m_FloatValue
If HPMTaskCustomSummaryValue::m_Type is set to EHPMProjectCustomColumnsColumnType_FloatNumber this holds the value otherwise it is set to 0.0.
m_Errors
The number of calculation errors.
See Also
HPMTaskSummary, EHPMProjectCustomColumnsColumnType
HPMTaskWallPositions
Used in TaskSetWallPositions and TaskGetWallPositions to specify the task wall positions.
struct HPMTaskWallPositions {
HPMUInt32 m_nWallPositions;
const HPMTaskWallPosition * m_pWallPositions;
} HPMTaskWallPositions;
Members
m_nWallPositions
The number of wall positions.
m_pWallPositions
Pointer to a list of HPMTaskWallPosition specifying the wall positions.
See Also
TaskSetWallPositions, TaskGetWallPositions, HPMTaskWallPosition
HPMTaskSummary
Used in TaskRefGetSummary to hold the summation values for a header.
struct HPMTaskSummary {
HPMUInt32 m_Completed;
HPMUInt32 m_Uncompleted;
HPMUInt32 m_AssignedUncompleted;
HPMInt32 m_TaskStatus;
HPMInt32 m_ComplexityPoints;
HPMInt32 m_ComplexityPoints_NotDone;
HPMInt32 m_EarnedValue;
HPMInt32 m_BudgetedWork;
HPMFP64 m_WorkRemaining;
HPMFP64 m_EstimatedIdealDays;
HPMFP64 m_EstimatedIdealDays_NotDone;
HPMFP64 m_DurationDays;
HPMFP64 m_DurationDays_NotDone;
HPMUInt32 m_nCustomSummaryValues;
const HPMTaskCustomSummaryValue * m_pCustomSummaryValues;
} HPMTaskSummary;
Members
m_Completed
The number of completed tasks.
m_Uncompleted
The number of uncompleted tasks.
m_AssignedUncompleted
The number of assigned uncompleted tasks.
m_TaskStatus
The summation of task status. Can be one of EHPMTaskStatus.
m_ComplexityPoints
The summation of complexity points.
m_ComplexityPoints_NotDone
The summation of not done complexity points.
m_EarnedValue
The summation of earned value.
m_BudgetedWork
The summation of budgeted work.
m_WorkRemaining
The summation of work remaining.
m_EstimatedIdealDays
The summation of estimated ideal days.
m_EstimatedIdealDays_NotDone
The summation of not done estimated ideal days.
m_DurationDays
The summation of duration in days.
m_DurationDays_NotDone
The summation of not done duration in days;
m_nCustomSummaryValues
The number of custom summary values.
m_pCustomSummaryValues
Pointer to a list of HPMTaskCustomSummaryValue that holds the summary values for custom columns.
See Also
HPMMilestoneSummary
Used in TaskRefGetMilestoneSummary to hold the summation values for a milestone.
struct HPMMilestoneSummary {
HPMUInt32 m_Completed;
HPMUInt32 m_Uncompleted;
HPMUInt32 m_Overdue;
HPMUInt32 m_AssignedUncompleted;
HPMUInt32 m_nMilestoneDependantIDs;
const HPMUniqueID * m_pMilestoneDependantIDs;
HPMFP64 m_IdealDays;
HPMFP64 m_IdealDays_NotDone;
HPMFP64 m_WorkRemaining;
HPMUInt32 m_Points;
HPMUInt32 m_Points_NotDone;
HPMFP64 m_DurationDays;
HPMFP64 m_DurationDays_NotDone;
HPMUInt64 m_StartTime;
} HPMMilestoneSummary;
Members
m_Completed
The number of completed tasks.
m_Uncompleted
The number of uncompleted tasks.
m_Overdue
The number of overdue tasks.
m_AssignedUncompleted
The number of assigned uncompleted tasks.
m_nMilestoneDependantIDs
The number of task references that are dependent on this milestone.
m_pMilestoneDependantIDs
Pointer to a list of unique identifiers pointing to the task references that are dependent on this milestone.
m_IdealDays
The summation of ideal days.
m_IdealDays_NotDone
The summation of not done ideal days.
m_WorkRemaining
The summation of work remaining.
m_Points
The summation of points.
m_Points_NotDone
The summation of points not done.
m_DurationDays
The summation of duration in days.
m_DurationDays_NotDone
The summation of not done duration in days;
m_StartTime
The milestone start time expressed as micro seconds since 1970 UTC.
See Also
HPMTaskWorkflowTransitionRequirementsNotMet
Used in TaskRefGetMilestoneSummary to the workflow transition requirements for a given transition that have not been met, if any.
struct HPMTaskWorkflowTransitionRequirementsNotMet {
HPMUInt32 m_bRequirementsMet;
HPMUInt32 m_nRequiredFieldsMissing;
const HPMTaskField * m_pRequiredFieldsMissing;
} HPMTaskWorkflowTransitionRequirementsNotMet;
Members
m_bRequirementsMet
Specifies if all transition requirements have been met. 0 = No. 1 = Yes.
m_nRequiredFieldsMissing
The number of required fields that are not set.
m_pRequiredFieldsMissing
An array of HPMTaskFields that are not set but are required to be set by the transition.
See Also
HPMTaskOldAllocationEntry
Used for specifying old allocation for one resource.
struct HPMTaskOldAllocationEntry {
HPMUniqueID m_ID;
HPMUInt32 m_AllocatedPercent;
} HPMTaskOldAllocationEntry;
Members
m_ID
The unique identifier of the resource to specify the previous allocated percent for.
m_AllocatedPercent
The allocated percent of the resource.
See Also
HPMTaskOldAllocation
Used in TaskGetOldPercentResourceAllocation to retrieve all previous partial allocations (percent != 100) for a task
struct HPMTaskOldAllocation {
HPMUInt32 m_nEntries;
HPMTaskOldAllocationEntry const * m_pEntries;
} HPMTaskOldAllocation;
Members
m_nEntries
The number of entries to specify previous allocation for task
m_pEntries
Pointer to a list of HPMTaskOldAllocationEntry to specify previous allocated percents (non-equal to 100) of resources.
See Also
TaskGetOldPercentResourceAllocation, HPMTaskOldAllocationEntry
HPMTaskInformation
Used in UtilGetTaskInfoFromHelixPlanURL to retrieve basic information about a task from a Helix Plan URL.
struct HPMTaskInformation {
HPMUniqueID m_DatabaseID;
HPMInt32 m_ID;
HPMChar const * m_pDescription;
HPMChar const * m_pDetailedDescription;
HPMUntranslatedString const * m_pStatus;
HPMUntranslatedString const * m_pWorkflowStatus;
HPMUInt64 m_TaskMainImageID;
HPMInt32 m_nResourceNames;
const HPMString * m_pResourceNames;
} HPMTaskInformation;
Members
m_DatabaseID
The unique database ID of the task.
m_ID
The unique project ID of the task.
m_pDescription
The description of the task.
m_pDetailedDescription
The detailed description of the task.
m_pStatus
Current status of task expressed as text.
m_pWorkflowStatus
Current workflow status of task expressed as text.
m_TaskMainImageID
The file id of the main image of the task. 0xffffffffffffffff indicates no image.
m_nResourceNames
The number of resource expressed as text the task is assigned to.
m_pResourceNames
The list of resource expressed as text the task is assigned to.
See Also
UtilGetTaskInfoFromHelixPlanURL, HPMUntranslatedString
HPMResourceNameInformation
Used in TaskGetLastUpdatedByResourceName to retrieve resource name information.
struct HPMResourceNameInformation {
const HPMChar * m_pResourceName;
HPMInt32 m_bDeleted;
} HPMResourceNameInformation;
Members
m_pResourceName
The name of the resource.
m_bDeleted
Boolean flag to indicate if the resource has been deleted.
See Also
TaskGetLastUpdatedByResourceName
HPMReportSubGroup
A sub group in a HPMReportSubGroup sub group list.
struct HPMReportSubGroup {
HPMUntranslatedString const * m_pSubGroupName;
HPMTaskEnum m_TaskRefs;
} HPMReportSubGroup;
Members
m_pSubGroupName
The name of the sub group the tasks on this level are grouped by.
m_TaskRefs
The task references in the sub group
See Also
HPMTaskEnum, HPMReportMainGroup, HPMUntranslatedString
HPMReportMainGroup
A main group in a HPMReportFind main group list.
struct HPMReportMainGroup {
HPMUntranslatedString const * m_pMainGroupName;
HPMTaskEnum m_TaskRefs;
HPMUInt32 m_nSubGroups;
struct @class_00005238; HPMReportSubGroup const * m_pSubGroups;
} HPMReportMainGroup;
Members
m_pMainGroupName
The name of the main group the tasks on this level are grouped by.
m_TaskRefs
If the report is not grouped, the found task references are listed here.
m_nSubGroups
The number of HPMReportSubGroup sub groups. Used if the report in TaskRefReportFind is grouping the main group by a column.
m_pSubGroups
Pointer to a list of HPMReportSubGroup that lists all sub groups.
See Also
HPMTaskEnum, HPMReportSubGroup, HPMUntranslatedString
HPMReportFind
Returned by TaskRefReportFind. Returns all tasks references found by a report. If the report is sorted by and/or grouped by, the task refs will be returned in the correct sort order and added to groups. Each optional first level group can be grouped by an optional second level sub group.
struct HPMReportFind {
HPMTaskEnum m_TaskRefs;
HPMUInt32 m_nMainGroups;
struct @class_0000524b; HPMReportMainGroup const * m_pMainGroups;
} HPMReportFind;
Members
m_TaskRefs
If the report is not grouped, the found task references are listed here.
m_nMainGroups
The number of HPMReportMainGroup main groups. Used if the report in TaskRefReportFind is grouped by a column. Each main group can have its own sub grouping if set by the report.
m_pMainGroups
Pointer to a list of HPMReportMainGroup that lists all main groups.
See Also
HPMTaskEnum, TaskRefReportFind, HPMUntranslatedString HPMReportMainGroup, HPMReportSubGroup
TaskCreateUnified
Creates a number of tasks or proxies in a container.
HPMError TaskCreateUnified (
    void * _pSession,
    HPMUniqueID _ContainerID,
    const HPMTaskCreateUnified * _pCreateData,
    const HPMChangeCallbackData_TaskCreateUnified * * _pReturn
    );
Parameters
_pSession
[in] A connected session. See SessionOpen.
_ContainerID
[in] A unique identifier of a container. Can be a project, backlog project or a QA project.
_pCreateData
[in] Pointer to a HPMTaskCreateUnified object specifying the tasks to create.
_pReturn
[out] Pointer to a pointer of a HPMChangeCallbackData_TaskCreateUnified object, representing the returned data. If this parameter is not NULL, the function will block.
Return Value
Returns an error code. See EHPMError.
Comments
The returned object must be freed with ObjectFree or a memory leak will result.
See Also
HPMSdkFunctions, ObjectFree, HPMTaskCreateUnified, HPMChangeCallbackData_TaskCreateUnified
TaskMoveProject
Moves a number of tasks into a new project.
HPMError TaskMoveProject (
    void * _pSession,
    HPMUniqueID _ContainerID,
    const HPMTaskCreateUnified * _pCreateData,
    const HPMChangeCallbackData_TaskCreateUnified * * _pReturn
    );
Parameters
_pSession
[in] A connected session. See SessionOpen.
_ContainerID
[in] A unique identifier of a container. Can be a project, backlog project or a QA project.
_pCreateData
[in] Pointer to a HPMTaskCreateUnified object specifying the tasks to create.
_pReturn
[out] Pointer to a pointer of a HPMChangeCallbackData_TaskCreateUnified object, representing the returned data. If this parameter is not NULL, the function will block.
Return Value
Returns an error code. See EHPMError.
Comments
The returned object must be freed with ObjectFree or a memory leak will result. Use HPMTaskCreateUnifiedEntry::m_NonProxy_ReuseUniqueID to specify the tasks to move. Any proxies attached to the tasks will be deleted. You cannot move proxies between projects, so it's not valid to specify proxies in the HPMTaskCreateUnified struct.
See Also
HPMSdkFunctions, ObjectFree, HPMTaskCreateUnified, HPMChangeCallbackData_TaskCreateUnified
TaskChangeDisposition
Changes the disposition of tasks in a container.
HPMError TaskChangeDisposition (
    void * _pSession,
    HPMUniqueID _ContainerID,
    const HPMTaskChangeDisposition * _pDispositionChanges,
    const HPMChangeCallbackData_TaskChangeDisposition * * _pReturn
    );
Parameters
_pSession
[in] A connected session. See SessionOpen.
_ContainerID
[in] A unique identifier of a container. Can be a main project or backlog project. You cannot change the disposition in QA.
_pDispositionChanges
[in] Pointer to a HPMTaskChangeDisposition object specifying the tasks to create.
_pReturn
[out] Pointer to a pointer of a HPMChangeCallbackData_TaskChangeDisposition object, representing the returned data. If this parameter is not NULL, the function will block.
Return Value
Returns an error code. See EHPMError.
Comments
The changes must give a correct tree otherwise the changes will be rejected. The returned object must be freed with ObjectFree or a memory leak will result.
See Also
HPMSdkFunctions, ObjectFree, HPMTaskChangeDisposition, HPMChangeCallbackData_TaskChangeDisposition
TaskDelete
Deletes a task and the references that points to it.
HPMError TaskDelete (
    void * _pSession,
    HPMUniqueID _TaskID
    );
Parameters
_pSession
[in] A connected session. See SessionOpen.
_TaskID
[in] The unique identifier of the task to be deleted. This can be either a task reference identifier or a task identifier.
Return Value
Returns an error code. See EHPMError.
Comments
This can be used to delete a task by its reference or directly. You can also us this function to delete a proxy task. When you send a proxy task reference to this function only the proxy will be removed, not the task in the main backlog.
See Also
TaskEnum
Enumerates tasks in a container.
HPMError TaskEnum (
    void * _pSession,
    HPMUniqueID _ContainerID,
    const HPMTaskEnum * * _pEnum
    );
Parameters
_pSession
[in] A connected session. See SessionOpen.
_ContainerID
[in] A unique identifier of a container. Can be a project, backlog project or a QA project.
_pEnum
[out] Pointer to a pointer of a HPMTaskEnum object, representing the returned data.
Return Value
Returns an error code. See EHPMError.
Comments
The returned object must be freed with ObjectFree or a memory leak will result.
See Also
HPMSdkFunctions, ObjectFree, HPMTaskEnum
TaskEnumReferences
Enumerates tasks references of a task.
HPMError TaskEnumReferences (
    void * _pSession,
    HPMUniqueID _TaskID,
    const HPMTaskEnum * * _pEnum
    );
Parameters
_pSession
[in] A connected session. See SessionOpen.
_TaskID
[in] The unique identifier of the task to enum references for.
_pEnum
[out] Pointer to a pointer of a HPMTaskEnum object, representing the returned data.
Return Value
Returns an error code. See EHPMError.
Comments
Returns all task references that point to the given task. E.g., if the task is created directly in the project only 1 reference will be returned, if the task is created in the backlog and is dragged into a sprint 2 will be returned (one in the backlog and one in the main project). Also there will be 1 reference for every resource the task is assigned to (The my work view for that resource). The returned object must be freed with ObjectFree or a memory leak will result.
See Also
HPMSdkFunctions, ObjectFree, HPMTaskEnum
TaskEnumConnections
Enumerates connected tasks in a container.
HPMError TaskEnumConnections (
    void * _pSession,
    HPMUniqueID _ContainerID,
    const HPMTaskConnectionEnum * * _pEnum
    );
Parameters
_pSession
[in] A connected session. See SessionOpen.
_ContainerID
[in] A unique identifier of a container. Can be a project, backlog project or a QA project.
_pEnum
[out] Pointer to a pointer of a HPMTaskConnectionEnum object, representing the returned data.
Return Value
Returns an error code. See EHPMError.
Comments
The returned object must be freed with ObjectFree or a memory leak will result.
See Also
HPMSdkFunctions, ObjectFree, HPMTaskConnectionEnum
TaskGetMainReference
Gets the main task reference of a task.
HPMError TaskGetMainReference (
    void * _pSession,
    HPMUniqueID _TaskID,
    HPMUniqueID * _pMainRefID
    );
Parameters
_pSession
[in] A connected session. See SessionOpen.
_TaskID
[in] The unique identifier of the task to get the main reference of.
_pMainRefID
[out] Pointer to a variable that will receive the unique reference identifier of the main task reference.
Return Value
Returns an error code. See EHPMError.
Comments
This will return the main reference of a task. This is the task reference found in the main project, backlog project or QA project.
See Also
TaskGetProxy
Gets the proxy of a task if it exists.
HPMError TaskGetProxy (
    void * _pSession,
    HPMUniqueID _TaskID,
    HPMUniqueID * _pProxyID
    );
Parameters
_pSession
[in] A connected session. See SessionOpen.
_TaskID
[in] The unique identifier of the task to get the proxy of.
_pProxyID
[out] Pointer to a variable that will receive the unique reference identifier of the proxy for this task.
Return Value
Returns an error code. See EHPMError.
Comments
This function will return the reference unique identifier of the proxy of a task. This is useful to find the proxy in the sprint backlog of a project backlog item.
See Also
TaskGetContainer
Gets the container a task resides in.
HPMError TaskGetContainer (
    void * _pSession,
    HPMUniqueID _TaskID,
    HPMUniqueID * _pContainerID
    );
Parameters
_pSession
[in] A connected session. See SessionOpen.
_TaskID
[in] The unique identifier of the task to get the container of.
_pContainerID
[out] Pointer to a variable that will receive the unique identifier of the container.
Return Value
Returns an error code. See EHPMError.
Comments
You can determine the type of the container with UtilIsIDProject, UtilIsIDBacklogProject and UtilIsIDQAProject.
See Also
HPMSdkFunctions, UtilIsIDProject, UtilIsIDBacklogProject, UtilIsIDQAProject
TaskEnumCustomColumnData
Enumerates the custom column data set on a task.
HPMError TaskEnumCustomColumnData (
    void * _pSession,
    HPMUniqueID _TaskID,
    const HPMTaskCustomColumnDataEnum * * _pEnum
    );
Parameters
_pSession
[in] A connected session. See SessionOpen.
_TaskID
[in] The unique identifier of the task to enum custom column data for.
_pEnum
[out] Pointer to a pointer of a HPMTaskCustomColumnDataEnum object, representing the returned data.
Return Value
Returns an error code. See EHPMError.
Comments
The returned object must be freed with ObjectFree or a memory leak will result.
See Also
HPMSdkFunctions, ObjectFree, HPMTaskCustomColumnDataEnum
TaskSetBacklogCategory
Sets the backlog category of a task.
HPMError TaskSetBacklogCategory (
    void * _pSession,
    HPMUniqueID _TaskID,
    HPMInt32 _Data
    );
Parameters
_pSession
[in] A connected session. See SessionOpen.
_TaskID
[in] The unique identifier of the task to to set the backlog category of.
_Data
[in] The backlog category to set on the task. Can be one of EHPMTaskBacklogCategory.
Return Value
Returns an error code. See EHPMError.
See Also
HPMSdkFunctions, EHPMTaskBacklogCategory
TaskGetBacklogCategory
Gets the backlog category of a task.
HPMError TaskGetBacklogCategory (
    void * _pSession,
    HPMUniqueID _TaskID,
    HPMInt32 * _pData
    );
Parameters
_pSession
[in] A connected session. See SessionOpen.
_TaskID
[in] The unique identifier of the task to get the backlog category of.
_pData
[out] Pointer to a variable that receive the backlog category. Will be one of EHPMTaskBacklogCategory.
Return Value
Returns an error code. See EHPMError.
See Also
HPMSdkFunctions, EHPMTaskBacklogCategory
TaskSetColor
Sets the color of a task.
HPMError TaskSetColor (
    void * _pSession,
    HPMUniqueID _TaskID,
    HPMUInt32 _Data
    );
Parameters
_pSession
[in] A connected session. See SessionOpen.
_TaskID
[in] The unique identifier of the task to set the color of.
_Data
[in] The color to set on the task.
Return Value
Returns an error code. See EHPMError.
See Also
TaskGetColor
Gets the color of a task.
HPMError TaskGetColor (
    void * _pSession,
    HPMUniqueID _TaskID,
    HPMUInt32 * _pData
    );
Parameters
_pSession
[in] A connected session. See SessionOpen.
_TaskID
[in] The unique identifier of the task to get the color of.
_pData
[out] Pointer to a variable that receive the color.
Return Value
Returns an error code. See EHPMError.
See Also
TaskSetFullyCreated
Sets the fully created flag on a task. This means that the task will start showing in the client GUI. Do not set this until you have set all other properties of the task you are creating.
HPMError TaskSetFullyCreated (
    void * _pSession,
    HPMUniqueID _TaskID
    );
Parameters
_pSession
[in] A connected session. See SessionOpen.
_TaskID
[in] The unique identifier of the task to set fully created.
Return Value
Returns an error code. See EHPMError.
See Also
HPMSdkFunctions, TaskGetFullyCreated
TaskGetFullyCreated
Gets the fully created flag of a task. When this flag is set the task has all properties correctly set after creation.
HPMError TaskGetFullyCreated (
    void * _pSession,
    HPMUniqueID _TaskID,
    HPMInt32 * _pData
    );
Parameters
_pSession
[in] A connected session. See SessionOpen.
_TaskID
[in] The unique identifier of the task to get the color of.
_pData
[out] Pointer to a variable that receive the fully created flag.
Return Value
Returns an error code. See EHPMError.
See Also
HPMSdkFunctions, TaskSetFullyCreated
TaskSetWallItemColor
Sets the wall item color of a task.
HPMError TaskSetWallItemColor (
    void * _pSession,
    HPMUniqueID _TaskID,
    HPMInt32 _Data
    );
Parameters
_pSession
[in] A connected session. See SessionOpen.
_TaskID
[in] The unique identifier of the task to set the wall item color of.
_Data
[in] The wall item color to set on the task. Can be one of EHPMTaskWallItemColor.
Return Value
Returns an error code. See EHPMError.
See Also
HPMSdkFunctions, EHPMTaskWallItemColor
TaskGetWallItemColor
Gets the color of a task.
HPMError TaskGetWallItemColor (
    void * _pSession,
    HPMUniqueID _TaskID,
    HPMInt32 * _pData
    );
Parameters
_pSession
[in] A connected session. See SessionOpen.
_TaskID
[in] The unique identifier of the task to get the wall item color of.
_pData
[out] Pointer to a variable that receive the wall item color. Can be one of EHPMTaskWallItemColor.
Return Value
Returns an error code. See EHPMError.
See Also
HPMSdkFunctions, EHPMTaskWallItemColor
TaskSetComplexityPoints
Sets the complexity points of a task.
HPMError TaskSetComplexityPoints (
    void * _pSession,
    HPMUniqueID _TaskID,
    HPMInt32 _Data
    );
Parameters
_pSession
[in] A connected session. See SessionOpen.
_TaskID
[in] The unique identifier of the task to set complexity points on.
_Data
[in] The complexity points to set on the task. Range is 0 to 1000000.
Return Value
Returns an error code. See EHPMError.
See Also
TaskGetComplexityPoints
Gets the complexity points of a task.
HPMError TaskGetComplexityPoints (
    void * _pSession,
    HPMUniqueID _TaskID,
    HPMInt32 * _pData
    );
Parameters
_pSession
[in] A connected session. See SessionOpen.
_TaskID
[in] The unique identifier of the task to get the complexity points of.
_pData
[out] Pointer to a variable that receive the complexity points. Range is 0 to 1000000.
Return Value
Returns an error code. See EHPMError.
See Also
TaskSetConfidence
Sets the confidence of a task.
HPMError TaskSetConfidence (
    void * _pSession,
    HPMUniqueID _TaskID,
    HPMInt32 _Data
    );
Parameters
_pSession
[in] A connected session. See SessionOpen.
_TaskID
[in] The unique identifier of the task to set the confidence on.
_Data
[in] The confidence to set on the task. Can be one of EHPMTaskConfidence.
Return Value
Returns an error code. See EHPMError.
See Also
HPMSdkFunctions, EHPMTaskConfidence
TaskGetConfidence
Gets the confidence of a task.
HPMError TaskGetConfidence (
    void * _pSession,
    HPMUniqueID _TaskID,
    HPMInt32 * _pData
    );
Parameters
_pSession
[in] A connected session. See SessionOpen.
_TaskID
[in] The unique identifier of the task to get confidence points of.
_pData
[out] Pointer to a variable that receive the confidence. Will be one of EHPMTaskConfidence.
Return Value
Returns an error code. See EHPMError.
See Also
HPMSdkFunctions, EHPMTaskConfidence
TaskSetEstimatedIdealDays
Sets the estimated ideal days of a task.
HPMError TaskSetEstimatedIdealDays (
    void * _pSession,
    HPMUniqueID _TaskID,
    HPMFP64 _Data
    );
Parameters
_pSession
[in] A connected session. See SessionOpen.
_TaskID
[in] The unique identifier of the task to set estimated ideal days on.
_Data
[in] The number of estimated ideal days to set on the task.
Return Value
Returns an error code. See EHPMError.
See Also
TaskGetEstimatedIdealDays
Gets the estimated ideal days of a task.
HPMError TaskGetEstimatedIdealDays (
    void * _pSession,
    HPMUniqueID _TaskID,
    HPMFP64 * _pData
    );
Parameters
_pSession
[in] A connected session. See SessionOpen.
_TaskID
[in] The unique identifier of the task to get estimated ideal days on.
_pData
[out] Pointer to a variable that will receive the number of estimated ideal days.
Return Value
Returns an error code. See EHPMError.
See Also
TaskSetRisk
Sets the risk of a task.
HPMError TaskSetRisk (
    void * _pSession,
    HPMUniqueID _TaskID,
    HPMInt32 _Data
    );
Parameters
_pSession
[in] A connected session. See SessionOpen.
_TaskID
[in] The unique identifier of the task to set the risk on.
_Data
[in] The risk to set on the task. Can be one of EHPMTaskRisk.
Return Value
Returns an error code. See EHPMError.
See Also
TaskGetRisk
Gets the risk of a task.
HPMError TaskGetRisk (
    void * _pSession,
    HPMUniqueID _TaskID,
    HPMInt32 * _pData
    );
Parameters
_pSession
[in] A connected session. See SessionOpen.
_TaskID
[in] The unique identifier of the task to get the risk of.
_pData
[out] Pointer to a variable that will receive the risk. Will be one of EHPMTaskRisk.
Return Value
Returns an error code. See EHPMError.
See Also
TaskSetStartOffset
Sets the start offset of a task.
HPMError TaskSetStartOffset (
    void * _pSession,
    HPMUniqueID _TaskID,
    HPMInt32 _Data
    );
Parameters
_pSession
[in] A connected session. See SessionOpen.
_TaskID
[in] The unique identifier of the task to set the start offset of.
_Data
[in] The number of hours to offset the task from its start date.
Return Value
Returns an error code. See EHPMError.
Comments
Used to offset start dates of tasks to be able to have many tasks on a single day.
See Also
TaskGetStartOffset
Gets the start offset of a task.
HPMError TaskGetStartOffset (
    void * _pSession,
    HPMUniqueID _TaskID,
    HPMInt32 * _pData
    );
Parameters
_pSession
[in] A connected session. See SessionOpen.
_TaskID
[in] The unique identifier of the task to get start offset of.
_pData
[out] Pointer to a variable that will receive the number of hours to offset the task from its start date.
Return Value
Returns an error code. See EHPMError.
Comments
Used to offset start dates of tasks to be able to have many tasks on a single day.
See Also
TaskSetDuration
Sets the hour duration of a task.
HPMError TaskSetDuration (
    void * _pSession,
    HPMUniqueID _TaskID,
    HPMInt32 _Data
    );
Parameters
_pSession
[in] A connected session. See SessionOpen.
_TaskID
[in] The unique identifier of the task to set the hour duration of.
_Data
[in] The duration of the task expressed in hours.
Return Value
Returns an error code. See EHPMError.
Comments
Used to specify the hour duration of a task to be able to have many tasks on a single day.
See Also
TaskGetDuration
Gets the hour duration of a task.
HPMError TaskGetDuration (
    void * _pSession,
    HPMUniqueID _TaskID,
    HPMInt32 * _pData
    );
Parameters
_pSession
[in] A connected session. See SessionOpen.
_TaskID
[in] The unique identifier of the task to get the hour duration of.
_pData
[out] Pointer to a variable that will receive the duration of the task expressed in hours.
Return Value
Returns an error code. See EHPMError.
Comments
Used to specify the hour duration of a task to be able to have many tasks on a single day.
See Also
TaskSetForceSubProject
Sets the force sub project flag on a task.
HPMError TaskSetForceSubProject (
    void * _pSession,
    HPMUniqueID _TaskID,
    HPMInt32 _Data
    );
Parameters
_pSession
[in] A connected session. See SessionOpen.
_TaskID
[in] The unique identifier of the task to set the force sub project flag on.
_Data
[in] The force sub project flag state to set on the task.
Return Value
Returns an error code. See EHPMError.
See Also
TaskGetForceSubProject
Gets the force sub project flag on a task.
HPMError TaskGetForceSubProject (
    void * _pSession,
    HPMUniqueID _TaskID,
    HPMInt32 * _pData
    );
Parameters
_pSession
[in] A connected session. See SessionOpen.
_TaskID
[in] The unique identifier of the task to get the force sub project flag of.
_pData
[out] Pointer to a variable that will receive the sub project flag state.
Return Value
Returns an error code. See EHPMError.
See Also
TaskSetBudgetedWork
Sets the budgeted work of a task.
HPMError TaskSetBudgetedWork (
    void * _pSession,
    HPMUniqueID _TaskID,
    HPMInt32 _Data
    );
Parameters
_pSession
[in] A connected session. See SessionOpen.
_TaskID
[in] The unique identifier of the task to set budgeted work on.
_Data
[in] The number of hours of budgeted work to set on the task.
Return Value
Returns an error code. See EHPMError.
See Also
TaskGetBudgetedWork
Gets the budgeted work of a task.
HPMError TaskGetBudgetedWork (
    void * _pSession,
    HPMUniqueID _TaskID,
    HPMInt32 * _pData
    );
Parameters
_pSession
[in] A connected session. See SessionOpen.
_TaskID
[in] The unique identifier of the task to get budgeted work of.
_pData
[out] Pointer to a variable that will receive the number of hours of budgeted work.
Return Value
Returns an error code. See EHPMError.
See Also
TaskGetLockedType
Gets the locked type of a task.
HPMError TaskGetLockedType (
    void * _pSession,
    HPMUniqueID _TaskID,
    HPMInt32 * _pData
    );
Parameters
_pSession
[in] A connected session. See SessionOpen.
_TaskID
[in] The unique identifier of the task to get the locked type of.
_pData
[out] Pointer to a variable that will receive the locked type. Will be one of EHPMTaskLockedType.
Return Value
Returns an error code. See EHPMError.
See Also
HPMSdkFunctions, EHPMTaskLockedType
TaskSetPercentComplete
Sets the percent complete of a task.
HPMError TaskSetPercentComplete (
    void * _pSession,
    HPMUniqueID _TaskID,
    HPMInt32 _Data
    );
Parameters
_pSession
[in] A connected session. See SessionOpen.
_TaskID
[in] The unique identifier of the task to set the percent complete on.
_Data
[in] The number of percent complete to set the task to. Range is 0 to 100.
Return Value
Returns an error code. See EHPMError.
See Also
TaskGetPercentComplete
Gets the percent complete of a task.
HPMError TaskGetPercentComplete (
    void * _pSession,
    HPMUniqueID _TaskID,
    HPMInt32 * _pData
    );
Parameters
_pSession
[in] A connected session. See SessionOpen.
_TaskID
[in] The unique identifier of the task to get the percent complete of.
_pData
[out] Pointer to a variable that will receive the number of percent complete the task is. Range is 0 to 100.
Return Value
Returns an error code. See EHPMError.
See Also
TaskSetStatus
Sets the status of a task.
HPMError TaskSetStatus (
    void * _pSession,
    HPMUniqueID _TaskID,
    HPMInt32 _Data,
    HPMInt32 _bGotoWorkflowStatus,
    HPMInt32 _SetStatusFlags
    );
Parameters
_pSession
[in] A connected session. See SessionOpen.
_TaskID
[in] The unique identifier of the task to set the status on.
_Data
[in] The status to set on the task. Can be one of EHPMTaskStatus.
_bGotoWorkflowStatus
[in] If set to 1 and HPMProjectWorkflowObject::m_WorkflowStatus_WorkflowStatusOnItemStatusChange has a progression set for the status specified in ${TaskSetStatus}._Data the workflow status will progress. This function will block even in non-blocking mode if this parameter is 1.
_SetStatusFlags
[in] The flags to use for workflow status changes if _bGotoWorkflowStatus is 1.
Return Value
Returns an error code. See EHPMError.
See Also
HPMSdkFunctions, EHPMTaskStatus
TaskGetStatus
Gets the status of a task
HPMError TaskGetStatus (
    void * _pSession,
    HPMUniqueID _TaskID,
    HPMInt32 * _pData
    );
Parameters
_pSession
[in] A connected session. See SessionOpen.
_TaskID
[in] The unique identifier of the task to get the status of.
_pData
[out] Pointer to a variable that will receive the status. Will be one of EHPMTaskStatus.
Return Value
Returns an error code. See EHPMError.
See Also
HPMSdkFunctions, EHPMTaskStatus
TaskGetType
Gets the type of a task.
HPMError TaskGetType (
    void * _pSession,
    HPMUniqueID _TaskID,
    HPMInt32 * _pData
    );
Parameters
_pSession
[in] A connected session. See SessionOpen.
_TaskID
[in] The unique identifier of the task to get the type of.
_pData
[out] Pointer to a variable that will receive the type. Will be one of EHPMTaskType.
Return Value
Returns an error code. See EHPMError.
See Also
TaskSetDescription
Sets the description of a task.
HPMError TaskSetDescription (
    void * _pSession,
    HPMUniqueID _TaskID,
    const HPMChar * _pData
    );
Parameters
_pSession
[in] A connected session. See SessionOpen.
_TaskID
[in] The unique identifier of the task to set the description on.
_pData
[in] Pointer to the HPMChar to set as description.
Return Value
Returns an error code. See EHPMError.
See Also
TaskGetDescription
Gets the description of a task.
HPMError TaskGetDescription (
    void * _pSession,
    HPMUniqueID _TaskID,
    const HPMString * * _pData
    );
Parameters
_pSession
[in] A connected session. See SessionOpen.
_TaskID
[in] The unique identifier of the task to get the description of.
_pData
[out] Pointer to a pointer of a HPMString object, representing the returned data.
Return Value
Returns an error code. See EHPMError.
Comments
The returned object must be freed with ObjectFree or a memory leak will result.
See Also
HPMSdkFunctions, ObjectFree, HPMString
TaskSetHyperlink
Sets the hyperlink of a task.
HPMError TaskSetHyperlink (
    void * _pSession,
    HPMUniqueID _TaskID,
    const HPMChar * _Data
    );
Parameters
_pSession
[in] A connected session. See SessionOpen.
_TaskID
[in] The unique identifier of the task to set the hyperlink on.
_Data
[in] Pointer to the HPMChar to set as hyperlink.
Return Value
Returns an error code. See EHPMError.
See Also
TaskGetHyperlink
Gets the hyperlink of a task.
HPMError TaskGetHyperlink (
    void * _pSession,
    HPMUniqueID _TaskID,
    const HPMString * * _pData
    );
Parameters
_pSession
[in] A connected session. See SessionOpen.
_TaskID
[in] The unique identifier of the task to get the hyperlink of.
_pData
[out] Pointer to a pointer of a HPMString object, representing the returned data.
Return Value
Returns an error code. See EHPMError.
Comments
The returned object must be freed with ObjectFree or a memory leak will result.
See Also
HPMSdkFunctions, ObjectFree, HPMString
TaskGetLinkedToSprint
Gets the sprint a task is linked to.
HPMError TaskGetLinkedToSprint (
    void * _pSession,
    HPMUniqueID _TaskID,
    HPMUniqueID * _pData
    );
Parameters
_pSession
[in] A connected session. See SessionOpen.
_TaskID
[in] The unique identifier of the task to get the linked sprint of.
_pData
[out] Pointer to a variable that will receive the unique reference identifier of the sprint this task is linked to.
Return Value
Returns an error code. See EHPMError.
See Also
TaskSetLockedBy
Sets the resource that has a task locked.
HPMError TaskSetLockedBy (
    void * _pSession,
    HPMUniqueID _TaskID,
    HPMUniqueID _Data
    );
Parameters
_pSession
[in] A connected session. See SessionOpen.
_TaskID
[in] The unique identifier of the task to set the resource that has locked this task on.
_Data
[in] The unique identifier of the resource to set as the resource that has locked this task.
Return Value
Returns an error code. See EHPMError.
Comments
A task should be locked when the resource is working on an area in the schedule.
See Also
TaskGetLockedBy
Gets the resource that has a task locked.
HPMError TaskGetLockedBy (
    void * _pSession,
    HPMUniqueID _TaskID,
    HPMUniqueID * _pData
    );
Parameters
_pSession
[in] A connected session. See SessionOpen.
_TaskID
[in] The unique identifier of the task to get the resource that has locked this task for.
_pData
[out] Pointer to a variable that will receive the unique identifier of the resource that has locked this task.
Return Value
Returns an error code. See EHPMError.
Comments
A task should be locked when the resource is working on an area in the schedule.
See Also
TaskSetOriginallyCreatedBy
Sets the originally created/reported by user of a task.
HPMError TaskSetOriginallyCreatedBy (
    void * _pSession,
    HPMUniqueID _TaskID,
    HPMUniqueID _Data
    );
Parameters
_pSession
[in] A connected session. See SessionOpen.
_TaskID
[in] The unique identifier of the task to set the owner on.
_Data
[in] The unique identifier of the originally created/reported by resource to set.
Return Value
Returns an error code. See EHPMError.
See Also
TaskGetOriginallyCreatedBy
Gets the originally created/reported by user of a task.
HPMError TaskGetOriginallyCreatedBy (
    void * _pSession,
    HPMUniqueID _TaskID,
    HPMUniqueID * _pData
    );
Parameters
_pSession
[in] A connected session. See SessionOpen.
_TaskID
[in] The unique identifier of the task to get the owner of.
_pData
[out] Pointer to a variable that will receive the unique identifier of the originally created/reported by resource.
Return Value
Returns an error code. See EHPMError.
See Also
TaskSetCustomColumnData
Sets the data for a custom column on a task.
HPMError TaskSetCustomColumnData (
    void * _pSession,
    HPMUniqueID _TaskID,
    HPMUInt32 _ColumnHash,
    const HPMChar * _pData,
    HPMInt32 _bDoAutoAssignments
    );
Parameters
_pSession
[in] A connected session. See SessionOpen.
_TaskID
[in] The unique identifier of the task to set custom column data on.
_ColumnHash
[in] The column hash of the column to set custom column data for.
_pData
[in] Pointer to the HPMChar to set as column data.
_bDoAutoAssignments
[in] This parameter is only valid if the type of the custom column is EHPMProjectCustomColumnsColumnType::_DropList. If set to 1 the auto assignments in HPMProjectCustomColumnsColumnDropListItem::m_pAutoAssignResources that are defined for a specific drop list item status are done. This function will block even in non-blocking mode if this parameter is 1.
Return Value
Returns an error code. See EHPMError.
See Also
Comments
Depending on the type of the custom column the data is generated differently:
EHPMProjectCustomColumnsColumnType_Text
Set the data directly as a string.
EHPMProjectCustomColumnsColumnType_Hyperlink
Set the data directly as a string containing the hyperlink.
EHPMProjectCustomColumnsColumnType_DropList
Use the HPMProjectCustomColumnsColumnDropListItem::m_Id corresponding to drop list item you want to set and format that integer as a string.
EHPMProjectCustomColumnsColumnType_IntegerNumber
Format the data as a 64 bit signed integer.
EHPMProjectCustomColumnsColumnType_FloatNumber
Format the data as a 64 bit floating point number.
EHPMProjectCustomColumnsColumnType_DateTime
Use UtilEncodeCustomColumnDateTimeValue to encode the data into a string.
EHPMProjectCustomColumnsColumnType_MultiLineText
Set the data directly as a string with \r\n as line separator.
EHPMProjectCustomColumnsColumnType_Resources
Use UtilEncodeCustomColumnResourcesValue to encode the data.
EHPMProjectCustomColumnsColumnType_AccumulatedTime
Format the data as a 64 bit floating point number representing the number of hours.
EHPMProjectCustomColumnsColumnType_MultiSelectionDropList
Use the HPMProjectCustomColumnsColumnDropListItem::m_Id corresponding to drop list items you want to set and format those integers as strings separated by ;
EHPMProjectCustomColumnsColumnType_DateTimeWithTime
Use UtilEncodeCustomColumnDateTimeValue to encode the data into the number of micro seconds since 1970 UTC. The value will be rounded down to the second.
TaskGetCustomColumnData
Gets the data for a custom column on a task.
HPMError TaskGetCustomColumnData (
    void * _pSession,
    HPMUniqueID _TaskID,
    HPMUInt32 _ColumnHash,
    const HPMString * * _pData
    );
Parameters
_pSession
[in] A connected session. See SessionOpen.
_TaskID
[in] The unique identifier of the task to get custom column data of.
_ColumnHash
[in] The column hash of the column to get custom column data for.
_pData
[out] Pointer to a pointer of a HPMString object, representing the returned data.
Return Value
Returns an error code. See EHPMError.
Comments
The returned object must be freed with ObjectFree or a memory leak will result. Depending on the type of the custom column the data is interpreted differently:
EHPMProjectCustomColumnsColumnType_Text
Use the data directly as a string.
EHPMProjectCustomColumnsColumnType_Hyperlink
Use the data directly as a string containing the hyperlink.
EHPMProjectCustomColumnsColumnType_DropList
Parse the data as an integer and this integer will correspond to HPMProjectCustomColumnsColumnDropListItem::m_Id.
EHPMProjectCustomColumnsColumnType_IntegerNumber
Parse the data as a 64 bit signed integer.
EHPMProjectCustomColumnsColumnType_FloatNumber
Parse the data as a 64 bit floating point number.
EHPMProjectCustomColumnsColumnType_DateTime
Use UtilDecodeCustomColumnDateTimeValue to decode the data into the number of micro seconds since 1970. Always display as is without timezone conversion.
EHPMProjectCustomColumnsColumnType_MultiLineText
Use the data directly as a string with \r\n as line separator.
EHPMProjectCustomColumnsColumnType_Resources
Use UtilDecodeCustomColumnResourcesValue to decode the data.
EHPMProjectCustomColumnsColumnType_AccumulatedTime
Parse the data as a 64 bit floating point number representing the number of hours.
EHPMProjectCustomColumnsColumnType_MultiSelectionDropList
Parse the string as integers separated by ; and these integers till correspond to HPMProjectCustomColumnsColumnDropListItem::m_Id.
EHPMProjectCustomColumnsColumnType_DateTimeWithTime
Use UtilDecodeCustomColumnDateTimeValue to decode the data into the number of micro seconds since 1970 UTC. The value has a precision of a second.
EHPMProjectCustomColumnsColumnType_Function
Use UtilDecodeCustomColumnCalculatedValue to decode the data into a HPMCalculatedColumnValue.
See Also
HPMSdkFunctions, ObjectFree, HPMString
TaskSetLastResourceCommentReadTime
Sets the last resource comment read time for a resource on a task.
HPMError TaskSetLastResourceCommentReadTime (
    void * _pSession,
    HPMUniqueID _TaskID,
    HPMUniqueID _ResourceID,
    HPMUInt64 _Data
    );
Parameters
_pSession
[in] A connected session. See SessionOpen.
_TaskID
[in] The unique identifier of the task to set comment last read time on.
_ResourceID
[in] The unique identifier of the resource to set comment last read time for.
_Data
[in] The time the resource last read comments for a task. Expressed as number of micro seconds since 1970 UTC.
Return Value
Returns an error code. See EHPMError.
See Also
TaskGetLastResourceCommentReadTime
Gets the last resource comment read time for a resource on a task.
HPMError TaskGetLastResourceCommentReadTime (
    void * _pSession,
    HPMUniqueID _TaskID,
    HPMUniqueID _ResourceID,
    HPMUInt64 * _pData
    );
Parameters
_pSession
[in] A connected session. See SessionOpen.
_TaskID
[in] The unique identifier of the task to get comment last read time for.
_ResourceID
[in] The unique identifier of the resource to get comment last read time for.
_pData
[out] Pointer to a variable that will receive the time comments was last read for the task and resource. Expressed as number of micro seconds since 1970 UTC.
Return Value
Returns an error code. See EHPMError.
See Also
TaskSetAttachedDocuments
Sets the attached documents on a task.
HPMError TaskSetAttachedDocuments (
    void * _pSession,
    HPMUniqueID _TaskID,
    const HPMTaskAttachedDocuments * _pData
    );
Parameters
_pSession
[in] A connected session. See SessionOpen.
_TaskID
[in] The unique identifier of the task to set attached documents on.
_pData
[in] Pointer to a HPMTaskAttachedDocuments specifying the documents to attach to the task.
Return Value
Returns an error code. See EHPMError.
Comments
To attach a document, the document must first be created it in the version control system. Every task that has an attachment will have its own directory where the actual files are stored. The path is different if the task is created in the backlog, the main schedule or in QA. The ID of a task is retrieved with TaskGetID: Backlog dir path: Project/[Project Name]/Attachments/Backlog_[ID] Main schedule dir path: Project/[Project Name]/Attachments/General_[ID] QA dir path: Project/[Project Name]/Attachments/Bug_[ID] To get the correct attachment path, use TaskGetAttachmentPath. The sequence to attach a document is as follows: Initialize version control with VersionControlInit. Create the attachment directory (see above) for the task that documents should be attached to with VersionControlCreateDirectories. Add the file(s) that are going to be attached with VersionControlAddFiles. Get the file IDs of the files that were added in step 3. with VersionControlUtilPathToFileID. Attach the file(s) with TaskSetAttachedDocuments.
See Also
HPMSdkFunctions, HPMTaskAttachedDocuments, VersionControlInit, VersionControlCreateDirectories, VersionControlAddFiles, VersionControlUtilPathToFileID
TaskGetAttachedDocuments
Gets the attached documents on a task.
HPMError TaskGetAttachedDocuments (
    void * _pSession,
    HPMUniqueID _TaskID,
    const HPMTaskAttachedDocuments * * _pData
    );
Parameters
_pSession
[in] A connected session. See SessionOpen.
_TaskID
[in] The unique identifier of the task to get attached documents of.
_pData
[out] Pointer to a pointer of a HPMTaskAttachedDocuments object, representing the returned data.
Return Value
Returns an error code. See EHPMError.
Comments
The returned object must be freed with ObjectFree or a memory leak will result.
See Also
HPMSdkFunctions, ObjectFree, HPMTaskAttachedDocuments
TaskSetDelegateTo
Sets the resources a task is delegated to.
HPMError TaskSetDelegateTo (
    void * _pSession,
    HPMUniqueID _TaskID,
    const HPMResourceDefinitionList * _pResourceList
    );
Parameters
_pSession
[in] A connected session. See SessionOpen.
_TaskID
[in] The unique identifier of the task to set delegated resources on.
_pResourceList
[out] Pointer to a HPMResourceDefinitionList object specifying the resources to delegate the task to.
Return Value
Returns an error code. See EHPMError.
Comments
The task and its parent tasks will be delegated.
See Also
TaskGetDelegateTo
Gets the resources a task is delegated to.
HPMError TaskGetDelegateTo (
    void * _pSession,
    HPMUniqueID _TaskID,
    const HPMResourceDefinitionList * * _pResourceList
    );
Parameters
_pSession
[in] A connected session. See SessionOpen.
_TaskID
[in] The unique identifier of the task to get delegated resources of.
_pResourceList
[out] Pointer to a pointer of a HPMResourceDefinitionList object, representing the returned data.
Return Value
Returns an error code. See EHPMError.
Comments
The returned object must be freed with ObjectFree or a memory leak will result.
See Also
HPMSdkFunctions, ObjectFree, HPMResourceDefinitionList
TaskSetResourceAllocation
Sets the resource allocation of a task.
HPMError TaskSetResourceAllocation (
    void * _pSession,
    HPMUniqueID _TaskID,
    const HPMTaskResourceAllocation * _pData,
    HPMInt32 _bGotoWorkflowStatusWhenAssigned,
    HPMInt32 _SetStatusFlags
    );
Parameters
_pSession
[in] A connected session. See SessionOpen.
_TaskID
[in] The unique identifier of the task to set resource allocation on.
_pData
[in] Pointer to a HPMTaskResourceAllocation object specifying the resource allocation to set on the task.
_bGotoWorkflowStatusWhenAssigned
[in] If set to 1 and HPMProjectWorkflowObject::m_WorkflowStatus_GoToWorkflowStatusWhenAssigned is set the status will progress. This function will block even in non-blocking mode if this parameter is 1.
_SetStatusFlags
[in] The flags to use for workflow status changes if _bGotoWorkflowStatusWhenAssigned is 1.
Return Value
Returns an error code. See EHPMError.
See Also
HPMSdkFunctions, HPMTaskResourceAllocation
TaskGetResourceAllocation
Gets the resource allocation of a task.
HPMError TaskGetResourceAllocation (
    void * _pSession,
    HPMUniqueID _TaskID,
    const HPMTaskResourceAllocation * * _pData
    );
Parameters
_pSession
[in] A connected session. See SessionOpen.
_TaskID
[in] The unique identifier of the task to get resource allocation of.
_pData
[out] Pointer to a pointer of a HPMTaskResourceAllocation object, representing the returned data.
Return Value
Returns an error code. See EHPMError.
Comments
The returned object must be freed with ObjectFree or a memory leak will result.
See Also
HPMSdkFunctions, ObjectFree, HPMTaskResourceAllocation
TaskSetSprintAllocatedResources
Sets the resources allocated to a sprint.
HPMError TaskSetSprintAllocatedResources (
    void * _pSession,
    HPMUniqueID _TaskID,
    const HPMTaskSprintAllocatedResources * _pData
    );
Parameters
_pSession
[in] A connected session. See SessionOpen.
_TaskID
[in] The unique identifier of the sprint task to set allocated resources on.
_pData
[in] Pointer to a HPMTaskSprintAllocatedResources specifying the resources to allocate to the sprint task.
Return Value
Returns an error code. See EHPMError.
See Also
HPMSdkFunctions, HPMTaskSprintAllocatedResources
TaskGetSprintAllocatedResources
Gets the resources allocated to a sprint.
HPMError TaskGetSprintAllocatedResources (
    void * _pSession,
    HPMUniqueID _TaskID,
    const HPMTaskSprintAllocatedResources * * _pData
    );
Parameters
_pSession
[in] A connected session. See SessionOpen.
_TaskID
[in] The unique identifier of the sprint task to get the allocated resources of.
_pData
[out] Pointer to a pointer of a HPMTaskSprintAllocatedResources object, representing the returned data.
Return Value
Returns an error code. See EHPMError.
Comments
The returned object must be freed with ObjectFree or a memory leak will result.
See Also
HPMSdkFunctions, ObjectFree, HPMTaskSprintAllocatedResources
TaskSetSprintResourceAllocation
Sets resource allocation of individual resources on a sprint.
HPMError TaskSetSprintResourceAllocation (
    void * _pSession,
    HPMUniqueID _TaskID,
    const HPMTaskSprintResourceAllocation * _pData
    );
Parameters
_pSession
[in] A connected session. See SessionOpen.
_TaskID
[in] The unique identifier of the sprint task to set individual resource allocation on.
_pData
[in] Pointer to a HPMTaskSprintResourceAllocation object specifying the individual resource allocation for the sprint task.
Return Value
Returns an error code. See EHPMError.
See Also
HPMSdkFunctions, HPMTaskSprintResourceAllocation
TaskGetSprintResourceAllocation
Gets resource allocation of individual resources on a sprint.
HPMError TaskGetSprintResourceAllocation (
    void * _pSession,
    HPMUniqueID _TaskID,
    const HPMTaskSprintResourceAllocation * * _pData
    );
Parameters
_pSession
[in] A connected session. See SessionOpen.
_TaskID
[in] The unique identifier of the sprint task to get individual resource allocation of.
_pData
[out] Pointer to a pointer of a HPMTaskSprintResourceAllocation object, representing the returned data.
Return Value
Returns an error code. See EHPMError.
Comments
The returned object must be freed with ObjectFree or a memory leak will result.
See Also
HPMSdkFunctions, ObjectFree, HPMTaskSprintResourceAllocation
TaskSetCompleted
Sets the completed flag on a task.
HPMError TaskSetCompleted (
    void * _pSession,
    HPMUniqueID _TaskID,
    HPMInt32 _bCompleted,
    HPMInt32 _bSendCompletedMessage
    );
Parameters
_pSession
[in] A connected session. See SessionOpen.
_TaskID
[in] The unique identifier of the task to set the completed flag on.
_bCompleted
[in] The state of the completed flag.
_bSendCompletedMessage
[in] If set to 1 a completed notification will be sent to those registered to receive notifications about this task.
Return Value
Returns an error code. See EHPMError.
See Also
TaskGetCompleted
Gets the completed flag of a task.
HPMError TaskGetCompleted (
    void * _pSession,
    HPMUniqueID _TaskID,
    HPMInt32 * _pCompleted
    );
Parameters
_pSession
[in] A connected session. See SessionOpen.
_TaskID
[in] The unique identifier of the task to get the completed flag of.
_pCompleted
[out] Pointer to a variable that will receive the completed flag.
Return Value
Returns an error code. See EHPMError.
See Also
TaskSetTimeZones
Sets the time zones of a task.
HPMError TaskSetTimeZones (
    void * _pSession,
    HPMUniqueID _TaskID,
    const HPMTaskTimeZones * _pData,
    HPMInt32 _bSendChangeNotifications
    );
Parameters
_pSession
[in] A connected session. See SessionOpen.
_TaskID
[in] The unique identifier of the task to set the time zones on.
_pData
[in] Pointer to a HPMTaskTimeZones object specifying the time zones to set on the task.
_bSendChangeNotifications
[in] Set to 1 to send email notifications that the task changed.
Return Value
Returns an error code. See EHPMError.
See Also
HPMSdkFunctions, HPMTaskTimeZones
TaskGetTimeZones
Gets the time zones of a task.
HPMError TaskGetTimeZones (
    void * _pSession,
    HPMUniqueID _TaskID,
    const HPMTaskTimeZones * * _pData
    );
Parameters
_pSession
[in] A connected session. See SessionOpen.
_TaskID
[in] The unique identifier of the task to get the time zones of.
_pData
[out] Pointer to a pointer of a HPMTaskTimeZones object, representing the returned data.
Return Value
Returns an error code. See EHPMError.
Comments
The returned object must be freed with ObjectFree or a memory leak will result.
See Also
HPMSdkFunctions, ObjectFree, HPMTaskTimeZones
TaskGetTotalDuration
Gets the total duration of a task.
HPMError TaskGetTotalDuration (
    void * _pSession,
    HPMUniqueID _TaskID,
    HPMUInt32 * _pData
    );
Parameters
_pSession
[in] A connected session. See SessionOpen.
_TaskID
[in] The unique identifier of the task to get the total duration of.
_pData
[out] Pointer to a variable that will receive the total duration of the task. Calculated from time zones.
Return Value
Returns an error code. See EHPMError.
See Also
TaskSetVisibleTo
Sets the resources a task is visible to.
HPMError TaskSetVisibleTo (
    void * _pSession,
    HPMUniqueID _TaskID,
    const HPMResourceDefinitionList * _pData
    );
Parameters
_pSession
[in] A connected session. See SessionOpen.
_TaskID
[in] The unique identifier of the task to set the resources it is visible to.
_pData
[in] Pointer to HPMResourceDefinitionList object specifying the resources and resource groups the task is visible to.
Return Value
Returns an error code. See EHPMError.
Comments
The visibility will be effective on the task and its children.
See Also
HPMSdkFunctions, HPMResourceDefinitionList
TaskGetVisibleTo
Gets the resources a task is visible to.
HPMError TaskGetVisibleTo (
    void * _pSession,
    HPMUniqueID _TaskID,
    const HPMResourceDefinitionList * * _pData
    );
Parameters
_pSession
[in] A connected session. See SessionOpen.
_TaskID
[in] The unique identifier of the task to get the resources it is visible to.
_pData
[out] Pointer to a pointer of a HPMResourceDefinitionList object, representing the returned data.
Return Value
Returns an error code. See EHPMError.
Comments
The returned object must be freed with ObjectFree or a memory leak will result.
See Also
HPMSdkFunctions, ObjectFree, HPMResourceDefinitionList
TaskSetSeverity
Sets the severity of a task.
HPMError TaskSetSeverity (
    void * _pSession,
    HPMUniqueID _TaskID,
    HPMInt32 _Data
    );
Parameters
_pSession
[in] A connected session. See SessionOpen.
_TaskID
[in] The unique identifier of the task to set the severity of.
_Data
[in] The severity to set on the task. Can be one of EHPMTaskSeverity.
Return Value
Returns an error code. See EHPMError.
See Also
HPMSdkFunctions, EHPMTaskSeverity
TaskGetSeverity
Gets the severity of a task.
HPMError TaskGetSeverity (
    void * _pSession,
    HPMUniqueID _TaskID,
    HPMInt32 * _pData
    );
Parameters
_pSession
[in] A connected session. See SessionOpen.
_TaskID
[in] The unique identifier of the task to get the severity of.
_pData
[out] Pointer to a variable that will receive the severity. Will be one of EHPMTaskSeverity.
Return Value
Returns an error code. See EHPMError.
See Also
HPMSdkFunctions, EHPMTaskSeverity
TaskSetWorkflowStatus
Sets the workflow status of a task.
HPMError TaskSetWorkflowStatus (
    void * _pSession,
    HPMUniqueID _TaskID,
    HPMInt32 _Data,
    HPMInt32 _Flags
    );
Parameters
_pSession
[in] A connected session. See SessionOpen.
_TaskID
[in] The unique identifier of the task to set the workflow status for.
_Data
[in] The status workflow status to set for the task. This value identifies a status in the HPMProjectWorkflowSettings for the project. The value should point to a HPMProjectWorkflowObject::m_ObjectID that has m_ObjectType set to EHPMProjectWorkflowObjectType_WorkflowStatus.
_Flags
[in] Controls if the auto assignents that are controlled by the flags in HPMProjectWorkflowObject::m_Flags will be done. This function will block even in non-blocking mode if this parameter is not EHPMTaskSetStatusFlag_None.
Return Value
Returns an error code. See EHPMError.
See Also
TaskGetWorkflowStatus
Gets the workflow status of a task.
HPMError TaskGetWorkflowStatus (
    void * _pSession,
    HPMUniqueID _TaskID,
    HPMInt32 * _pData
    );
Parameters
_pSession
[in] A connected session. See SessionOpen.
_TaskID
[in] The unique identifier of the task to get the workflow status of.
_pData
[out] Pointer to a variable that will receive the workflow status. This value identifies a status in the HPMProjectWorkflowSettings for the project. The value should point to a HPMProjectWorkflowObject::m_ObjectID that has m_ObjectType set to EHPMProjectWorkflowObjectType_WorkflowStatus.
Return Value
Returns an error code. See EHPMError.
See Also
TaskSetUserStoryFlag
Sets the user story flag of a task.
HPMError TaskSetUserStoryFlag (
    void * _pSession,
    HPMUniqueID _TaskID,
    HPMInt32 _bData
    );
Parameters
_pSession
[in] A connected session. See SessionOpen.
_TaskID
[in] The unique identifier of the task to set the user story flag of.
_bData
[in] The value of the user story flag to set. Can be 0 or 1.
Return Value
Returns an error code. See EHPMError.
See Also
TaskGetUserStoryFlag
Gets the user story flag of a task.
HPMError TaskGetUserStoryFlag (
    void * _pSession,
    HPMUniqueID _TaskID,
    HPMInt32 * _pData
    );
Parameters
_pSession
[in] A connected session. See SessionOpen.
_TaskID
[in] The unique identifier of the task to get the user story flag of.
_pData
[out] Pointer to a variable that will receive the user story flag. Can be 0 or 1.
Return Value
Returns an error code. See EHPMError.
See Also
TaskSetEpicFlag
Sets the epic flag of a task.
HPMError TaskSetEpicFlag (
    void * _pSession,
    HPMUniqueID _TaskID,
    HPMInt32 _bData
    );
Parameters
_pSession
[in] A connected session. See SessionOpen.
_TaskID
[in] The unique identifier of the task to set the epic flag of.
_bData
[in] The value of the epic flag to set. Can be 0 or 1.
Return Value
Returns an error code. See EHPMError.
See Also
TaskGetEpicFlag
Gets the epic flag of a task.
HPMError TaskGetEpicFlag (
    void * _pSession,
    HPMUniqueID _TaskID,
    HPMInt32 * _pData
    );
Parameters
_pSession
[in] A connected session. See SessionOpen.
_TaskID
[in] The unique identifier of the task to get the epic flag of.
_pData
[out] Pointer to a variable that will receive the epic flag. Can be 0 or 1.
Return Value
Returns an error code. See EHPMError.
See Also
TaskSetLastUpdatedTime
Sets the last updated time of a task.
HPMError TaskSetLastUpdatedTime (
    void * _pSession,
    HPMUniqueID _TaskID,
    HPMUInt64 _Data
    );
Parameters
_pSession
[in] A connected session. See SessionOpen.
_TaskID
[in] The unique identifier of the task to set the last updated time of.
_Data
[in] The last updated time to set. Expressed as the number of micro seconds since 1970 UTC.
Return Value
Returns an error code. See EHPMError.
Comments
The last updated time of a task is automatically handled by the server. This function exists if you need to override the automatically set last updated time of a task.
See Also
TaskGetLastUpdatedTime
Gets the last updated time of a task.
HPMError TaskGetLastUpdatedTime (
    void * _pSession,
    HPMUniqueID _TaskID,
    HPMUInt64 * _pData
    );
Parameters
_pSession
[in] A connected session. See SessionOpen.
_TaskID
[in] The unique identifier of the task to get the last updated time of.
_pData
[out] Pointer to a variable that will receive the last updated time. Expressed as the number of micro seconds since 1970 UTC.
Return Value
Returns an error code. See EHPMError.
See Also
TaskSetSprintResourcesHaveFullRights
Sets the full rights flag for resources of a sprint.
HPMError TaskSetSprintResourcesHaveFullRights (
    void * _pSession,
    HPMUniqueID _TaskID,
    HPMInt32 _bData
    );
Parameters
_pSession
[in] A connected session. See SessionOpen.
_TaskID
[in] The unique identifier of the task to set the full rights flag on. This identifier should point to a sprint task.
_bData
[in] The flag to set. If 1 all resources in a sprint will be able to create and delete tasks freely irrespective of being main project managers.
Return Value
Returns an error code. See EHPMError.
See Also
TaskGetSprintResourcesHaveFullRights
Gets the full rights flag for resources of a sprint.
HPMError TaskGetSprintResourcesHaveFullRights (
    void * _pSession,
    HPMUniqueID _TaskID,
    HPMInt32 * _pData
    );
Parameters
_pSession
[in] A connected session. See SessionOpen.
_TaskID
[in] The unique identifier of the task to get the full rights flag on. This identifier should point to a sprint task.
_pData
[out] Pointer to a variable that will receive the full rights flag.
Return Value
Returns an error code. See EHPMError.
See Also
TaskSetDetailedDescription
Sets the detailed description of a task.
HPMError TaskSetDetailedDescription (
    void * _pSession,
    HPMUniqueID _TaskID,
    const HPMChar * _Data
    );
Parameters
_pSession
[in] A connected session. See SessionOpen.
_TaskID
[in] The unique identifier of the task to set the detailed description of.
_Data
[in] Pointer to the HPMChar to set as detailed description/user story.
Comments
In the main project and backlog this function sets the user story text.
Return Value
Returns an error code. See EHPMError.
See Also
TaskGetDetailedDescription
Gets the detailed description of a task.
HPMError TaskGetDetailedDescription (
    void * _pSession,
    HPMUniqueID _TaskID,
    const HPMString * * _pData
    );
Parameters
_pSession
[in] A connected session. See SessionOpen.
_TaskID
[in] The unique identifier of the task to get the detailed description/user story of.
_pData
[out] Pointer to a pointer of a HPMString object, representing the returned data.
Return Value
Returns an error code. See EHPMError.
Comments
In the main project and backlog this function gets the user story text. The returned object must be freed with ObjectFree or a memory leak will result.
See Also
HPMSdkFunctions, ObjectFree, HPMString
TaskSetStepsToReproduce
Sets the steps to reproduce of a task.
HPMError TaskSetStepsToReproduce (
    void * _pSession,
    HPMUniqueID _TaskID,
    const HPMChar * _Data
    );
Parameters
_pSession
[in] A connected session. See SessionOpen.
_TaskID
[in] The unique identifier of the task to set the steps to reproduce on.
_Data
[in] Pointer to the HPMChar to set as steps to reproduce.
Return Value
Returns an error code. See EHPMError.
See Also
TaskGetStepsToReproduce
Gets the steps to reproduce of a task.
HPMError TaskGetStepsToReproduce (
    void * _pSession,
    HPMUniqueID _TaskID,
    const HPMString * * _pData
    );
Parameters
_pSession
[in] A connected session. See SessionOpen.
_TaskID
[in] The unique identifier of the task to get the steps to reproduce of.
_pData
[out] Pointer to a pointer of a HPMString object, representing the returned data.
Return Value
Returns an error code. See EHPMError.
Comments
The returned object must be freed with ObjectFree or a memory leak will result.
See Also
HPMSdkFunctions, ObjectFree, HPMString
TaskGetAttachmentPath
Gets the attachment path for task.
HPMError TaskGetAttachmentPath (
    void * _pSession,
    HPMUniqueID _TaskID,
    const HPMString * * _pData
    );
Parameters
_pSession
[in] A connected session. See SessionOpen.
_TaskID
[in] The unique identifier of the task to get the attachment path for.
_pData
[out] Pointer to a pointer of a HPMString object, representing the returned data.
Return Value
Returns an error code. See EHPMError.
Comments
The attachment path for a task is where documents that are attached to a task should be put. The returned object must be freed with ObjectFree or a memory leak will result.
See Also
HPMSdkFunctions, ObjectFree, HPMString
TaskGetID
Gets the task or bug id.
HPMError TaskGetID (
    void * _pSession,
    HPMUniqueID _TaskID,
    HPMInt32 * _pData
    );
Parameters
_pSession
[in] A connected session. See SessionOpen.
_TaskID
[in] The unique identifier of the task/bug to get the id of.
_pData
[out] Pointer to a variable that will receive the user id.
Return Value
Returns an error code. See EHPMError.
See Also
Comments
The id of a task can uniquely identify a task in a project. This identifier is the identifier presented in the UI. This identifier can only be set when creating tasks and should not be set unless you want a copy operation to preserve the id. If you specify an id that already exists it will be ignored and an automatic id will be used. The identifier only uniquely identifies a task in a project. Within the same project however the backlog, main schedule and QA projects can have tasks with the same identifier.
TaskSetWorkRemaining
Sets the work remaining on a task.
HPMError TaskSetWorkRemaining (
    void * _pSession,
    HPMUniqueID _TaskID,
    HPMFP32 _nHoursRemaining
    );
Parameters
_pSession
[in] A connected session. See SessionOpen.
_TaskID
[in] The unique identifier of the task to set work remaining on.
_nHoursRemaining
[in] The number of hours work that remains on the task. Set this value to infinity to indicate that the number of hours remaining is not set.
Return Value
Returns an error code. See EHPMError.
See Also
TaskGetWorkRemaining
Gets the work remaining of a task.
HPMError TaskGetWorkRemaining (
    void * _pSession,
    HPMUniqueID _TaskID,
    HPMFP32 * _pHoursRemaining
    );
Parameters
_pSession
[in] A connected session. See SessionOpen.
_TaskID
[in] The unique identifier of the task to get the remaining work on.
_pHoursRemaining
[out] Pointer to a variable that will receive the number of hours remaining work for the task. The value will be infinity to indicate that the number of hours remaining is not set.
Return Value
Returns an error code. See EHPMError.
See Also
TaskSetWorkRemainingHistory
Sets the work remaining history of a task on a specific day in the sprint.
HPMError TaskSetWorkRemainingHistory (
    void * _pSession,
    HPMUniqueID _TaskID,
    HPMUInt32 _DayInSprint,
    const HPMTaskWorkRemainingHistory * _pData
    );
Parameters
_pSession
[in] A connected session. See SessionOpen.
_TaskID
[in] The unique identifier of task to set the work remaining history on.
_DayInSprint
[in] The day in the sprint to set the work remaining history for.
_pData
[in] Pointer to a HPMTaskWorkRemainingHistory object specifying the work remaining history.
Return Value
Returns an error code. See EHPMError.
See Also
HPMSdkFunctions, HPMTaskWorkRemainingHistory
TaskGetWorkRemainingHistory
Gets the work remaining history of a task on a specific day in the sprint.
HPMError TaskGetWorkRemainingHistory (
    void * _pSession,
    HPMUniqueID _TaskID,
    HPMUInt32 _DayInSprint,
    const HPMTaskWorkRemainingHistory * * _pData
    );
Parameters
_pSession
[in] A connected session. See SessionOpen.
_TaskID
[in] The unique identifier of the task to get the work remaining history for.
_DayInSprint
[in] The day in the sprint to get the work remaining history for.
_pData
[out] Pointer to a pointer of a HPMTaskWorkRemainingHistory object, representing the returned data.
Return Value
Returns an error code. See EHPMError.
Comments
The returned object must be freed with ObjectFree or a memory leak will result.
See Also
HPMSdkFunctions, ObjectFree, HPMTaskWorkRemainingHistory
TaskEnumWorkRemainingHistoryDays
Enumerates the days in a sprint that has work remaining history on them.
HPMError TaskEnumWorkRemainingHistoryDays (
    void * _pSession,
    HPMUniqueID _TaskID,
    const HPMTaskWorkRemainingHistoryDaysEnum * * _pData
    );
Parameters
_pSession
[in] A connected session. See SessionOpen.
_TaskID
[in] The unique identifier of the task to enumerate work remaining history days for.
_pData
[out] Pointer to a pointer of a HPMTaskWorkRemainingHistoryDaysEnum object, representing the returned data.
Return Value
Returns an error code. See EHPMError.
Comments
The returned object must be freed with ObjectFree or a memory leak will result.
See Also
HPMSdkFunctions, ObjectFree, HPMTaskWorkRemainingHistoryDaysEnum
TaskSetIdealDaysHistory
Sets the ideal history of a task on a specific day in the sprint.
HPMError TaskSetIdealDaysHistory (
    void * _pSession,
    HPMUniqueID _TaskID,
    HPMUInt32 _DayInSprint,
    const HPMTaskIdealDaysHistory * _pData
    );
Parameters
_pSession
[in] A connected session. See SessionOpen.
_TaskID
[in] The unique identifier of task to set the ideal days history on.
_DayInSprint
[in] The day in the sprint to set the ideal days history for.
_pData
[in] Pointer to a HPMTaskIdealDaysHistory object specifying the ideal days history.
Return Value
Returns an error code. See EHPMError.
See Also
HPMSdkFunctions, HPMTaskIdealDaysHistory
TaskGetIdealDaysHistory
Gets ideal days history of a task on a specific day in the sprint.
HPMError TaskGetIdealDaysHistory (
    void * _pSession,
    HPMUniqueID _TaskID,
    HPMUInt32 _DayInSprint,
    const HPMTaskIdealDaysHistory * * _pData
    );
Parameters
_pSession
[in] A connected session. See SessionOpen.
_TaskID
[in] The unique identifier of the task to get the ideal days history for.
_DayInSprint
[in] The day in the sprint to get the ideal days history for.
_pData
[out] Pointer to a pointer of a HPMTaskIdealDaysHistory object, representing the returned data.
Return Value
Returns an error code. See EHPMError.
Comments
The returned object must be freed with ObjectFree or a memory leak will result.
See Also
HPMSdkFunctions, ObjectFree, HPMTaskIdealDaysHistory
TaskEnumIdealDaysHistoryDays
Enumerates the days in a sprint that has ideal days history on them.
HPMError TaskEnumIdealDaysHistoryDays (
    void * _pSession,
    HPMUniqueID _TaskID,
    const HPMTaskHistoryDaysEnum * * _pData
    );
Parameters
_pSession
[in] A connected session. See SessionOpen.
_TaskID
[in] The unique identifier of the task to enumerate points history days for.
_pData
[out] Pointer to a pointer of a HPMTaskHistoryDaysEnum object, representing the returned data.
Return Value
Returns an error code. See EHPMError.
Comments
The returned object must be freed with ObjectFree or a memory leak will result.
See Also
HPMSdkFunctions, ObjectFree, HPMTaskHistoryDaysEnum
TaskSetPointsHistory
Sets the points history of a task on a specific day in the sprint.
HPMError TaskSetPointsHistory (
    void * _pSession,
    HPMUniqueID _TaskID,
    HPMUInt32 _DayInSprint,
    const HPMTaskPointsHistory * _pData
    );
Parameters
_pSession
[in] A connected session. See SessionOpen.
_TaskID
[in] The unique identifier of task to set the points history on.
_DayInSprint
[in] The day in the sprint to set the points history for.
_pData
[in] Pointer to a HPMTaskPointsHistory object specifying the points history.
Return Value
Returns an error code. See EHPMError.
See Also
HPMSdkFunctions, HPMTaskPointsHistory
TaskGetPointsHistory
Gets the points history of a task on a specific day in the sprint.
HPMError TaskGetPointsHistory (
    void * _pSession,
    HPMUniqueID _TaskID,
    HPMUInt32 _DayInSprint,
    const HPMTaskPointsHistory * * _pData
    );
Parameters
_pSession
[in] A connected session. See SessionOpen.
_TaskID
[in] The unique identifier of the task to get the points history for.
_DayInSprint
[in] The day in the sprint to get the points history for.
_pData
[out] Pointer to a pointer of a HPMTaskPointsHistory object, representing the returned data.
Return Value
Returns an error code. See EHPMError.
Comments
The returned object must be freed with ObjectFree or a memory leak will result.
See Also
HPMSdkFunctions, ObjectFree, HPMTaskPointsHistory
TaskEnumPointsHistoryDays
Enumerates the days in a sprint that has points history on them.
HPMError TaskEnumPointsHistoryDays (
    void * _pSession,
    HPMUniqueID _TaskID,
    const HPMTaskHistoryDaysEnum * * _pData
    );
Parameters
_pSession
[in] A connected session. See SessionOpen.
_TaskID
[in] The unique identifier of the task to enumerate points history days for.
_pData
[out] Pointer to a pointer of a HPMTaskHistoryDaysEnum object, representing the returned data.
Return Value
Returns an error code. See EHPMError.
Comments
The returned object must be freed with ObjectFree or a memory leak will result.
See Also
HPMSdkFunctions, ObjectFree, HPMTaskHistoryDaysEnum
TaskSetVacationOptions
Sets the vacation options of a task.
HPMError TaskSetVacationOptions (
    void * _pSession,
    HPMUniqueID _TaskID,
    const HPMTaskVacationOptions * _pData
    );
Parameters
_pSession
[in] A connected session. See SessionOpen.
_TaskID
[in] The unique identifier of the task to set vacation options on.
_pData
[in] Pointer to a HPMTaskVacationOptions object specifying the vacation options.
Return Value
Returns an error code. See EHPMError.
See Also
HPMSdkFunctions, HPMTaskVacationOptions
TaskGetVacationOptions
Gets the vacation options of a task.
HPMError TaskGetVacationOptions (
    void * _pSession,
    HPMUniqueID _TaskID,
    const HPMTaskVacationOptions * * _pData
    );
Parameters
_pSession
[in] A connected session. See SessionOpen.
_TaskID
[in] The unique identifier to get vacation options for.
_pData
[out] Pointer to a pointer of a HPMTaskVacationOptions object, representing the returned data.
Return Value
Returns an error code. See EHPMError.
Comments
The returned object must be freed with ObjectFree or a memory leak will result.
See Also
HPMSdkFunctions, ObjectFree, HPMTaskVacationOptions
TaskSetLinkedToMilestones
Sets the milestones a task is linked to.
HPMError TaskSetLinkedToMilestones (
    void * _pSession,
    HPMUniqueID _TaskID,
    const HPMTaskLinkedToMilestones * _pData
    );
Parameters
_pSession
[in] A connected session. See SessionOpen.
_TaskID
[in] The unique identifier of the task to set linked milestones on.
_pData
[in] Pointer to a HPMTaskLinkedToMilestones object specifying the milestones the task should be linked to.
Return Value
Returns an error code. See EHPMError.
See Also
HPMSdkFunctions, HPMTaskLinkedToMilestones
TaskGetLinkedToMilestones
Gets the milestones a task is linked to.
HPMError TaskGetLinkedToMilestones (
    void * _pSession,
    HPMUniqueID _TaskID,
    const HPMTaskLinkedToMilestones * * _pData
    );
Parameters
_pSession
[in] A connected session. See SessionOpen.
_TaskID
[in] The unique identifier of the task to get linked milestones for.
_pData
[out] Pointer to a pointer of a HPMTaskLinkedToMilestones object, representing the returned data.
Return Value
Returns an error code. See EHPMError.
Comments
The returned object must be freed with ObjectFree or a memory leak will result.
See Also
HPMSdkFunctions, ObjectFree, HPMTaskLinkedToMilestones
TaskSetLinkedTo
Sets the objects a task is linked to.
HPMError TaskSetLinkedTo (
    void * _pSession,
    HPMUniqueID _TaskID,
    const HPMTaskLinkedTo * _pData
    );
Parameters
_pSession
[in] A connected session. See SessionOpen.
_TaskID
[in] The unique identifier of the task to set linked objects on.
_pData
[in] Pointer to a HPMTaskLinkedTo object specifying the objects the task should be linked to.
Return Value
Returns an error code. See EHPMError.
See Also
HPMSdkFunctions, HPMTaskLinkedTo
TaskGetLinkedTo
Gets the objects a task is linked to.
HPMError TaskGetLinkedTo (
    void * _pSession,
    HPMUniqueID _TaskID,
    const HPMTaskLinkedTo * * _pData
    );
Parameters
_pSession
[in] A connected session. See SessionOpen.
_TaskID
[in] The unique identifier of the task to get linked objects for.
_pData
[out] Pointer to a pointer of a HPMTaskLinkedTo object, representing the returned data.
Return Value
Returns an error code. See EHPMError.
Comments
The returned object must be freed with ObjectFree or a memory leak will result.
See Also
HPMSdkFunctions, ObjectFree, HPMTaskLinkedTo
TaskSetCommentsOptions
Sets the comment options of a task.
HPMError TaskSetCommentsOptions (
    void * _pSession,
    HPMUniqueID _TaskID,
    const HPMTaskCommentsOptions * _pData
    );
Parameters
_pSession
[in] A connected session. See SessionOpen.
_TaskID
[in] The unique identifier of the task to set comments options on.
_pData
[in] Pointer to a HPMTaskCommentsOptions object specifying the comment options to set.
Return Value
Returns an error code. See EHPMError.
See Also
HPMSdkFunctions, HPMTaskCommentsOptions
TaskGetCommentsOptions
Gets the comment options of a task.
HPMError TaskGetCommentsOptions (
    void * _pSession,
    HPMUniqueID _TaskID,
    const HPMTaskCommentsOptions * * _pData
    );
Parameters
_pSession
[in] A connected session. See SessionOpen.
_TaskID
[in] The unique identifier of the task to get comments options for.
_pData
[out] Pointer to a pointer of a HPMTaskCommentsOptions object, representing the returned data.
Return Value
Returns an error code. See EHPMError.
Comments
The returned object must be freed with ObjectFree or a memory leak will result.
See Also
HPMSdkFunctions, ObjectFree, HPMTaskCommentsOptions
TaskCreateComment
Creates a comment post on a task.
HPMError TaskCreateComment (
    void * _pSession,
    HPMUniqueID _TaskID,
    HPMTaskComment const * _pComment,
    HPMInt32 * _pReturnedPostID
    );
Parameters
_pSession
[in] A connected session. See SessionOpen.
_TaskID
[in] The unique identifier of the task to create a comment post on.
_pComment
[in] The comment to create. See HPMTaskComment. Leave m_PostDate at 0 to use the servers current time
_pReturnedPostID
[out] The post identifier of the create task. This function will block even in non-blocking mode if this parameter is not NULL.
Return Value
Returns an error code. See EHPMError.
Comments
Set _ParentpostID to -1 for the first post.
See Also
TaskDeleteComment
Deletes a comment post on a task.
HPMError TaskDeleteComment (
    void * _pSession,
    HPMUniqueID _TaskID,
    HPMInt32 _PostID
    );
Parameters
_pSession
[in] A connected session. See SessionOpen.
_TaskID
[in] The unique identifier of the task to delete a comment post on.
_PostID
[in] The post identifier of the post to delete.
Return Value
Returns an error code. See EHPMError.
See Also
TaskSetComment
Sets a comment post on a task.
HPMError TaskSetComment (
    void * _pSession,
    HPMUniqueID _TaskID,
    HPMInt32 _PostID,
    const HPMTaskComment * _pData
    );
Parameters
_pSession
[in] A connected session. See SessionOpen.
_TaskID
[in] The unique identifier of the task to set comment data on.
_PostID
[in] The post identifier of the post to set comment data on.
_pData
[in] Pointer to a HPMTaskComment object specifying the comment data.
Return Value
Returns an error code. See EHPMError.
See Also
HPMSdkFunctions, HPMTaskComment
TaskGetComment
Gets a comment post on a task.
HPMError TaskGetComment (
    void * _pSession,
    HPMUniqueID _TaskID,
    HPMInt32 _PostID,
    const HPMTaskComment * * _pData
    );
Parameters
_pSession
[in] A connected session. See SessionOpen.
_TaskID
[in] The unique identifier of the task to get comment data for.
_PostID
[in] The post identifier of the post to get comment data for.
_pData
[out] Pointer to a pointer of a HPMTaskComment object, representing the returned data.
Return Value
Returns an error code. See EHPMError.
Comments
The returned object must be freed with ObjectFree or a memory leak will result.
See Also
HPMSdkFunctions, ObjectFree, HPMTaskComment
TaskEnumComments
Enumerates comment posts on a task.
HPMError TaskEnumComments (
    void * _pSession,
    HPMUniqueID _TaskID,
    const HPMTaskCommentEnum * * _pComments
    );
Parameters
_pSession
[in] A connected session. See SessionOpen.
_TaskID
[in] The unique identifier of the task to enumerate comment posts for.
_pComments
[out] Pointer to a pointer of a HPMTaskCommentEnum object, representing the returned data.
Return Value
Returns an error code. See EHPMError.
Comments
The returned object must be freed with ObjectFree or a memory leak will result.
See Also
HPMSdkFunctions, ObjectFree, HPMTaskCommentEnum
TaskNotifyCommentPosted
Notifies resources set to receive notifications when a post is posted.
HPMError TaskNotifyCommentPosted (
    void * _pSession,
    HPMUniqueID _TaskID,
    HPMInt32 _PostID,
    HPMInt32 _bEdit,
    HPMResourceEnum const * _pMentionedResources
    );
Parameters
_pSession
[in] A connected session. See SessionOpen.
_TaskID
[in] The unique identifier of the task to notify about a posted comment.
_PostID
[in] The post identifier of the posted comment.
_bEdit
[in] Set to 1 to indicate that a comment post was edited and not posted.
_pMentionedResources
[in] List of resources to notify about mention in the posted comment.
Return Value
Returns an error code. See EHPMError.
See Also
TaskSetWallPositions
Sets the wall positions for a task.
HPMError TaskSetWallPositions (
    void * _pSession,
    HPMUniqueID _TaskID,
    const HPMTaskWallPositions * _pData
    );
Parameters
_pSession
[in] A connected session. See SessionOpen.
_TaskID
[in] The unique identifier of the task to set the wall positions for.
_pData
[in] Pointer to a HPMTaskWallPositions object specifying the wall positions for the task.
Return Value
Returns an error code. See EHPMError.
See Also
HPMSdkFunctions, HPMTaskWallPositions
TaskGetWallPositions
Gets the wall positions for a task.
HPMError TaskGetWallPositions (
    void * _pSession,
    HPMUniqueID _TaskID,
    const HPMTaskWallPositions * * _pData
    );
Parameters
_pSession
[in] A connected session. See SessionOpen.
_TaskID
[in] The unique identifier of the task to set the wall positions for.
_pData
[out] Pointer to a pointer of a HPMTaskWallPositions object, representing the returned data.
Return Value
Returns an error code. See EHPMError.
Comments
The returned object must be freed with ObjectFree or a memory leak will result.
See Also
HPMSdkFunctions, ObjectFree, HPMTaskWallPositions
TaskGetSDKInternalData
Gets task SDK internal data.
HPMError TaskGetSDKInternalData (
    void * _pSession,
    HPMUniqueID _TaskID,
    const HPMChar * _pIdentifier,
    const HPMSDKInternalData * * _pData
    );
Parameters
_pSession
[in] A connected session. See SessionOpen.
_TaskID
[in] The unique identifier of the task to get SDK internal data for.
_pIdentifier
[in] The identifier of SDK internal data. This value is used to isolate the SDK internal data of different integrations.
_pData
[out] Pointer to a pointer of a HPMSDKInternalData object, representing the returned data.
Return Value
Returns an error code. See EHPMError.
Comments
The returned object must be freed with ObjectFree or a memory leak will result.
See Also
HPMSdkFunctions, ObjectFree, HPMSDKInternalData, TaskSetSDKInternalData
TaskSetSDKInternalData
Sets task SDK internal data.
HPMError TaskSetSDKInternalData (
    void * _pSession,
    HPMUniqueID _TaskID,
    const HPMChar * _pIdentifier,
    const HPMSDKInternalData * _pData
    );
Parameters
_pSession
[in] A connected session. See SessionOpen.
_TaskID
[in] The unique identifier of the task to set SDK internal data for.
_pIdentifier
[in] The identifier of SDK internal data. This value is used to isolate the SDK internal data of different integrations.
_pData
[in] The SDK internal data to set. See HPMSDKInternalData.
Return Value
Returns an error code. See EHPMError.
See Also
HPMSdkFunctions, ObjectFree, HPMSDKInternalData TaskGetSDKInternalData
TaskGetCommentSDKInternalData
Gets task comment SDK internal data.
HPMError TaskGetCommentSDKInternalData (
    void * _pSession,
    HPMUniqueID _TaskID,
    HPMInt32 _PostID,
    const HPMChar * _pIdentifier,
    const HPMSDKInternalData * * _pData
    );
Parameters
_pSession
[in] A connected session. See SessionOpen.
_TaskID
[in] The unique identifier of the task to get commment SDK internal data for.
_PostID
[in] The post id of the comment to get comment SDK internal data for.
_pIdentifier
[in] The identifier of SDK internal data. This value is used to isolate the SDK internal data of different integrations.
_pData
[out] Pointer to a pointer of a HPMSDKInternalData object, representing the returned data.
Return Value
Returns an error code. See EHPMError.
Comments
The returned object must be freed with ObjectFree or a memory leak will result.
See Also
HPMSdkFunctions, ObjectFree, HPMSDKInternalData, TaskSetCommentSDKInternalData
TaskSetCommentSDKInternalData
Sets task comment SDK internal data.
HPMError TaskSetCommentSDKInternalData (
    void * _pSession,
    HPMUniqueID _TaskID,
    HPMInt32 _PostID,
    const HPMChar * _pIdentifier,
    const HPMSDKInternalData * _pData
    );
Parameters
_pSession
[in] A connected session. See SessionOpen.
_TaskID
[in] The unique identifier of the task to set comment SDK internal data for.
_PostID
[in] The post id of the comment to set comment SDK internal data for.
_pIdentifier
[in] The identifier of SDK internal data. This value is used to isolate the SDK internal data of different integrations.
_pData
[in] The SDK internal data to set. See HPMSDKInternalData.
Return Value
Returns an error code. See EHPMError.
See Also
HPMSdkFunctions, ObjectFree, HPMSDKInternalData TaskGetCommentSDKInternalData
TaskSetWorkflow
Sets the workflow on a task.
HPMError TaskSetWorkflow (
    void * _pSession,
    HPMUniqueID _TaskID,
    HPMUInt32 _Data
    );
Parameters
_pSession
[in] A connected session. See SessionOpen.
_TaskID
[in] The unique identifier of the task to set the workflow on.
_Data
[in] The identifier of the workflow to set on the task.
Return Value
Returns an error code. See EHPMError.
See Also
HPMSdkFunctions, TaskUpdatePipelineWorkflowToNewestVersion
TaskGetWorkflow
Gets the workflow set on a task.
HPMError TaskGetWorkflow (
    void * _pSession,
    HPMUniqueID _TaskID,
    HPMUInt32 * _pData
    );
Parameters
_pSession
[in] A connected session. See SessionOpen.
_TaskID
[in] The unique identifier of the task to get the linked sprint of.
_pData
[out] Pointer to a variable that will receive the identifier of the workflow that is set on this task. Is 0xffffffff if no workflow is set.
Return Value
Returns an error code. See EHPMError.
See Also
TaskSetDefaultWorkflow
Sets the default workflow or pipeline on a task.
HPMError TaskSetDefaultWorkflow (
    void * _pSession,
    HPMUniqueID _TaskID,
    HPMUInt32 _Data
    );
Parameters
_pSession
[in] A connected session. See SessionOpen.
_TaskID
[in] The unique identifier of the task. The sub items created under this task will have the default workflow or pipeline set.
_Data
[in] The identifier of the default workflow or pipeline to set on the task.
Return Value
Returns an error code. See EHPMError.
See Also
TaskGetDefaultWorkflow
Gets the default workflow or pipeline set on a task.
HPMError TaskGetDefaultWorkflow (
    void * _pSession,
    HPMUniqueID _TaskID,
    HPMUInt32 * _pData
    );
Parameters
_pSession
[in] A connected session. See SessionOpen.
_TaskID
[in] The unique identifier of the task. The sub items created under this task will have the default workflow or pipeline set.
_pData
[out] Pointer to a variable that will receive the identifier of the default workflow or pipeline that is set on this task.
Return Value
Returns an error code. See EHPMError.
See Also
TaskSetArchived
Sets the archived status of on a sub project.
HPMError TaskSetArchived (
    void * _pSession,
    HPMUniqueID _TaskID,
    HPMInt32 _bArchived
    );
Parameters
_pSession
[in] A connected session. See SessionOpen.
_TaskID
[in] The unique identifier of the sub project.
_bArchived
[in] The archived status to set on the sub project. Set to 1 if the sub project should be archived, 0 otherwise.
Return Value
Returns an error code. See EHPMError.
See Also
TaskGetArchived
Gets the archived status of a sub project.
HPMError TaskGetArchived (
    void * _pSession,
    HPMUniqueID _TaskID,
    HPMInt32 * _pArchived
    );
Parameters
_pSession
[in] A connected session. See SessionOpen.
_TaskID
[in] The unique identifier of the sub project.
_pArchived
[out] Pointer to a variable that will receive the archived status of the sub project. 1 if the sub project is archived, 0 otherwise.
Return Value
Returns an error code. See EHPMError.
See Also
TaskPipelineGetTaskRef
Gets the pipeline task reference of a task.
HPMError TaskPipelineGetTaskRef (
    void * _pSession,
    HPMUniqueID _TaskID,
    HPMUniqueID * _pData
    );
Parameters
_pSession
[in] A connected session. See SessionOpen.
_TaskID
[in] The unique identifier of the task to get the pipeline reference of.
_pData
[out] Pointer to a variable that will receive the unique identifier of the task reference.
Return Value
Returns an error code. See EHPMError.
See Also
TaskRefGetColumnText
Gets the text representation of a column for a task reference.
HPMError TaskRefGetColumnText (
    void * _pSession,
    HPMUniqueID _TaskRefID,
    const HPMColumn * _pColumn,
    const HPMColumnTextOptions * _pColumnTextOptions,
    const HPMString * * _pData
    );
Parameters
_pSession
[in] A connected session. See SessionOpen.
_TaskRefID
[in] The unique identifier of the task reference to get column text for.
_pColumn
[in] The column to get text for.
_pColumnTextOptions
[in] The text column options.
_pData
[out] Pointer to a pointer of a HPMString object, representing the returned data.
Return Value
Returns an error code. See EHPMError.
Comments
The returned object must be freed with ObjectFree or a memory leak will result.
See Also
HPMSdkFunctions, ObjectFree, HPMColumn, HPMColumnTextOptions
TaskGetLastAssignedInWorkflowStatus
Gets a list of resources that were last assigned to a specific status in a workflow.
HPMError TaskGetLastAssignedInWorkflowStatus (
    void * _pSession,
    HPMUniqueID _TaskID,
    HPMUInt32 _WorkflowID,
    HPMUInt32 _StatusID,
    const HPMResourceDefinitionList * * _pResourceList
    );
Parameters
_pSession
[in] A connected session. See SessionOpen.
_TaskID
[in] The unique identifier of the task the workflow is set on.
_WorkflowID
[in] The identifier of the workflow containing the status.
_StatusID
[in] The identifier of the workflow status where the resources were last assigned.
_pResourceList
[out] Pointer to a pointer of a HPMResourceDefinitionList object, representing the returned data.
Return Value
Returns an error code. See EHPMError.
Comments
The returned object must be freed with ObjectFree or a memory leak will result.
See Also
HPMSdkFunctions, ObjectFree, HPMResourceDefinitionList
TaskGetLastAssignedInWorkflowStatuses
Gets a list of resources that are assigned for all workflows and statuses for a task
HPMError TaskGetLastAssignedInWorkflowStatuses (
    void * _pSession,
    HPMUniqueID _TaskID,
    const HPMLastAssignedInWorkflowStatuses * * _pLastAssignedList
    );
Parameters
_pSession
[in] A connected session. See SessionOpen.
_TaskID
[in] The unique identifier of the task the workflows are set on.
_pLastAssignedList
[out] Pointer to a pointer of a HPMLastAssignedInWorkflowStatuses object, representing the returned data.
Return Value
Returns an error code. See EHPMError.
Comments
The returned object must be freed with ObjectFree or a memory leak will result.
See Also
HPMSdkFunctions, ObjectFree, HPMLastAssignedInWorkflowStatuses
TaskGetLastEnterWorkflowStatus
Gets last entered info for a specific status in a workflow.
HPMError TaskGetLastEnterWorkflowStatus (
    void * _pSession,
    HPMUniqueID _TaskID,
    HPMUInt32 _WorkflowID,
    HPMUInt32 _StatusID,
    const HPMWorkflowStatusTransitInfo * * _pLastEnterInfo
    );
Parameters
_pSession
[in] A connected session. See SessionOpen.
_TaskID
[in] The unique identifier of the task the workflow is set on.
_WorkflowID
[in] The identifier of the workflow containing the status.
_StatusID
[in] The identifier of the workflow status we want last enter info for.
_pLastEnterInfo
[out] Pointer to a pointer of a HPMWorkflowStatusTransitInfo object, representing the returned data.
Return Value
Returns an error code. See EHPMError.
Comments
The returned object must be freed with ObjectFree or a memory leak will result.
See Also
HPMSdkFunctions, ObjectFree, HPMWorkflowStatusTransitInfo
TaskGetLastExitWorkflowStatus
Gets last exit info for a specific status in a workflow.
HPMError TaskGetLastExitWorkflowStatus (
    void * _pSession,
    HPMUniqueID _TaskID,
    HPMUInt32 _WorkflowID,
    HPMUInt32 _StatusID,
    const HPMWorkflowStatusTransitInfo * * _pLastExitInfo
    );
Parameters
_pSession
[in] A connected session. See SessionOpen.
_TaskID
[in] The unique identifier of the task the workflow is set on.
_WorkflowID
[in] The identifier of the workflow containing the status.
_StatusID
[in] The identifier of the workflow status we want last exit info for.
_pLastExitInfo
[out] Pointer to a pointer of a HPMWorkflowStatusTransitInfo object, representing the returned data.
Return Value
Returns an error code. See EHPMError.
Comments
The returned object must be freed with ObjectFree or a memory leak will result.
See Also
HPMSdkFunctions, ObjectFree, HPMWorkflowStatusTransitInfo
TaskGetLinkedToPipelineTask
Gets the pipeline task that automatically created this task.
HPMError TaskGetLinkedToPipelineTask (
    void * _pSession,
    HPMUniqueID _TaskID,
    HPMUniqueID * _pData
    );
Parameters
_pSession
[in] A connected session. See SessionOpen.
_TaskID
[in] The unique identifier of the task to get the created by pipeline task on.
_pData
[out] Pointer to a variable that will receive the unique identifier of the pipeline task that created this task.
Return Value
Returns an error code. See EHPMError.
See Also
TaskSetCreatedPipelineTasks
Sets the tasks that have been automatically created by this task as part of a pipeline.
HPMError TaskSetCreatedPipelineTasks (
    void * _pSession,
    HPMUniqueID _TaskID,
    const HPMTaskEnum * _pData
    );
Parameters
_pSession
[in] A connected session. See SessionOpen.
_TaskID
[in] The unique identifier of the task to set the tasks it has created on.
_pData
[in] Pointer to a HPMTaskEnum object specifying the tasks that were created by this task.
Return Value
Returns an error code. See EHPMError.
See Also
TaskGetCreatedPipelineTasks
Gets the tasks that have been automatically created by this task as part of a pipeline.
HPMError TaskGetCreatedPipelineTasks (
    void * _pSession,
    HPMUniqueID _TaskID,
    const HPMTaskEnum * * _pData
    );
Parameters
_pSession
[in] A connected session. See SessionOpen.
_TaskID
[in] The unique identifier of the task to get the tasks it has created.
_pData
[out] Pointer to a pointer of a HPMTaskEnum object, representing the returned data.
Return Value
Returns an error code. See EHPMError.
Comments
The returned object must be freed with ObjectFree or a memory leak will result.
See Also
HPMSdkFunctions, ObjectFree, HPMTaskEnum
TaskSetCreatedFromWorkflowObject
Sets the workflow object identifier that this task was created from as part of an automatically created workflow.
HPMError TaskSetCreatedFromWorkflowObject (
    void * _pSession,
    HPMUniqueID _TaskID,
    const HPMWorkflowObjectIdentifier * _pData
    );
Parameters
_pSession
[in] A connected session. See SessionOpen.
_TaskID
[in] The unique identifier of the task to set the workflow identifier of.
_pData
[in] Pointer to a HPMWorkflowObjectIdentifier object specifying the workflow object the task was created from.
Return Value
Returns an error code. See EHPMError.
See Also
HPMSdkFunctions, HPMWorkflowObjectIdentifier
TaskGetCreatedFromWorkflowObject
Gets the workflow object identifier that this task was created from as part of an automatically created workflow.
HPMError TaskGetCreatedFromWorkflowObject (
    void * _pSession,
    HPMUniqueID _TaskID,
    const HPMWorkflowObjectIdentifier * * _pData
    );
Parameters
_pSession
[in] A connected session. See SessionOpen.
_TaskID
[in] The unique identifier of the task to get the workflow identifier of.
_pData
[out] Pointer to a pointer of a HPMWorkflowObjectIdentifier object, representing the returned data.
Return Value
Returns an error code. See EHPMError.
Comments
The returned object must be freed with ObjectFree or a memory leak will result.
See Also
HPMSdkFunctions, ObjectFree, HPMWorkflowObjectIdentifier
TaskUtilGetWorkflowProgression
Generates list of possible progression states
HPMError TaskUtilGetWorkflowProgression (
    void * _pSession,
    HPMUniqueID _TaskID,
    HPMUniqueID _ResourceID,
    const HPMWorkflowProgressionStructure * * _pWorkflowProgressionStructure
    );
Parameters
_pSession
[in] A connected session. See SessionOpen.
_TaskID
[in] The unique identifier of the task to get the workflow progression for.
_ResourceID
[in] The unique identifier of the resource to get progression for.
_pWorkflowProgressionStructure
[out] Pointer to a pointer of a HPMWorkflowProgressionStructure object, representing the returned data.
Return Value
Returns an error code. See EHPMError.
Comments
The returned object must be freed with ObjectFree or a memory leak will result. Note that only the required fields in HPMWorkflowProgressionStructure::m_pProgressionStates that need to be filled to reach that state are included. That means that if HPMWorkflowProgressionStructure::m_nProgressionStates is greater than zero, this state cannot be reached without filling in the listed fields. The function will only traverse one level of transitions, i.e. no stacked transitions.
See Also
HPMSdkFunctions, ObjectFree, HPMProjectWorkflows, |
TaskUtilGetWorkflowProgressionFromTaskStatusChange
Gets workflow progression status for task in the workflow specified according to a task status.
HPMError TaskUtilGetWorkflowProgressionFromTaskStatusChange (
    void * _pSession,
    HPMUniqueID _ProjectID,
    HPMInt32 _WorkflowID,
    HPMInt32 _OldWorkflowStatus,
    HPMInt32 _TaskStatus,
    HPMInt32 * _pNewStatus
    );
Parameters
_pSession
[in] A connected session. See SessionOpen.
_ProjectID
[in] The unique identifier of the project to get workflow progress for.
_WorkflowID
[in] The workflow id to use for getting workflow progression.
_OldWorkflowStatus
[in] The old workflow status.
_TaskStatus
[in] The task status that the task was changed to.
_pNewStatus
[out] The new status resulting from the workflow progression. If -1 no progression resulted.
Return Value
Returns an error code. See EHPMError.
Comments
The workflow status will progress only if the workflow for the supplied workflow id has HPMProjectWorkflowObject::m_WorkflowStatus_WorkflowStatusOnItemStatusChange set for the status specified.
See Also
TaskRefGetSDKInternalData
Gets task reference SDK internal data.
HPMError TaskRefGetSDKInternalData (
    void * _pSession,
    HPMUniqueID _TaskRefID,
    const HPMChar * _pIdentifier,
    const HPMSDKInternalData * * _pData
    );
Parameters
_pSession
[in] A connected session. See SessionOpen.
_TaskRefID
[in] The unique identifier of the task reference to get SDK internal data for.
_pIdentifier
[in] The identifier of SDK internal data. This value is used to isolate the SDK internal data of different integrations.
_pData
[out] Pointer to a pointer of a HPMSDKInternalData object, representing the returned data.
Return Value
Returns an error code. See EHPMError.
Comments
The returned object must be freed with ObjectFree or a memory leak will result.
See Also
HPMSdkFunctions, ObjectFree, HPMSDKInternalData, TaskRefSetSDKInternalData
TaskRefSetSDKInternalData
Sets resource SDK internal data.
HPMError TaskRefSetSDKInternalData (
    void * _pSession,
    HPMUniqueID _TaskRefID,
    const HPMChar * _pIdentifier,
    const HPMSDKInternalData * _pData
    );
Parameters
_pSession
[in] A connected session. See SessionOpen.
_TaskRefID
[in] The unique identifier of the task reference to set SDK internal data for.
_pIdentifier
[in] The identifier of SDK internal data. This value is used to isolate the SDK internal data of different integrations.
_pData
[in] The SDK internal data to set. See HPMSDKInternalData.
Return Value
Returns an error code. See EHPMError.
See Also
HPMSdkFunctions, ObjectFree, HPMSDKInternalData TaskRefGetSDKInternalData
TaskRefUtilGetSubProjectPath
Gets the sub project path.
HPMError TaskRefUtilGetSubProjectPath (
    void * _pSession,
    HPMUniqueID _TaskRefID,
    HPMInt32 _bIncludeProxyPath,
    const HPMString * * _pData
    );
Parameters
_pSession
[in] A connected session. See SessionOpen.
_TaskRefID
[in] The unique identifier of the task reference to get the sub project path for.
_bIncludeProxyPath
[in] If set to 1 if the subproject path will contain the proxy path, otherwise set to 0.
_pData
[out] Pointer to a pointer of a HPMString object, representing the returned sub project path.
Return Value
Returns an error code. See EHPMError.
Comments
The returned object must be freed with ObjectFree or a memory leak will result.
See Also
HPMSdkFunctions, ObjectFree, HPMString
TaskRefUtilEnumChildren
Enumerates children task references of a parent task reference.
HPMError TaskRefUtilEnumChildren (
    void * _pSession,
    HPMUniqueID _TaskRefID,
    HPMInt32 _bIncludeAllChildren,
    const HPMTaskEnum * * _pEnum
    );
Parameters
_pSession
[in] A connected session. See SessionOpen.
_TaskRefID
[in] The unique identifier of the task reference to get children task references for. If the project id is used you will get a correct list of sorted task references in the root of the project.
_bIncludeAllChildren
[in] If set to 1 if the children on all levels below parent will be returned and if set to 0 just the children on the level below will be returned.
_pEnum
[out] Pointer to a pointer of a HPMTaskEnum object, representing the returned data.
Return Value
Returns an error code. See EHPMError.
Comments
The returned object must be freed with ObjectFree or a memory leak will result.
See Also
HPMSdkFunctions, ObjectFree, HPMTaskEnum
TaskRefUtilEnumPipelineProgression
Enumerates not completed pipeline task references of a parent task id.
HPMError TaskRefUtilEnumPipelineProgression (
    void * _pSession,
    HPMUniqueID _TaskID,
    const HPMTaskEnum * * _pEnum
    );
Parameters
_pSession
[in] A connected session. See SessionOpen.
_TaskID
[in] The unique identifier of the task to get progression task references for.
_pEnum
[out] Pointer to a pointer of a HPMTaskEnum object, representing the returned data.
Return Value
Returns an error code. See EHPMError.
Comments
The returned object must be freed with ObjectFree or a memory leak will result.
See Also
HPMSdkFunctions, ObjectFree, HPMTaskEnum
TaskRefUtilGetParent
Gets the parent task reference of a task reference id.
HPMError TaskRefUtilGetParent (
    void * _pSession,
    HPMUniqueID _TaskRefID,
    HPMUniqueID * _pTaskRefID
    );
Parameters
_pSession
[in] A connected session. See SessionOpen.
_TaskRefID
[in] The unique identifier of the task reference to get parent for.
_pTaskRefID
[out] Pointer to a variable that will receive the unique identifier of the parent task reference. Returns the project id if the reference id is root.
Return Value
Returns an error code. See EHPMError.
See Also
TaskRefUtilGetNext
Gets the successor task reference of a task reference id.
HPMError TaskRefUtilGetNext (
    void * _pSession,
    HPMUniqueID _TaskRefID,
    HPMUniqueID * _pTaskRefID
    );
Parameters
_pSession
[in] A connected session. See SessionOpen.
_TaskRefID
[in] The unique identifier of the task reference to get successor for.
_pTaskRefID
[out] Pointer to a variable that will receive the unique identifier of the successor task reference.
Return Value
Returns an error code. See EHPMError.
See Also
TaskRefUtilGetNextSibling
Gets the successor sibling task reference of a task reference id.
HPMError TaskRefUtilGetNextSibling (
    void * _pSession,
    HPMUniqueID _TaskRefID,
    HPMUniqueID * _pTaskRefID
    );
Parameters
_pSession
[in] A connected session. See SessionOpen.
_TaskRefID
[in] The unique identifier of the task reference to get successor for.
_pTaskRefID
[out] Pointer to a variable that will receive the unique identifier of the successor task reference.
Return Value
Returns an error code. See EHPMError.
See Also
TaskRefUtilGetPrevSibling
Gets the predecessor sibling task reference of a task reference id.
HPMError TaskRefUtilGetPrevSibling (
    void * _pSession,
    HPMUniqueID _TaskRefID,
    HPMUniqueID * _pTaskRefID
    );
Parameters
_pSession
[in] A connected session. See SessionOpen.
_TaskRefID
[in] The unique identifier of the task reference to get successor for.
_pTaskRefID
[out] Pointer to a variable that will receive the unique identifier of the predecessor task reference.
Return Value
Returns an error code. See EHPMError.
See Also
TaskRefUtilGetNextAtSameOrLowerLevel
Gets the successor task reference at the same or lower level as a task reference id.
HPMError TaskRefUtilGetNextAtSameOrLowerLevel (
    void * _pSession,
    HPMUniqueID _TaskRefID,
    HPMUniqueID * _pTaskRefID
    );
Parameters
_pSession
[in] A connected session. See SessionOpen.
_TaskRefID
[in] The unique identifier of the task reference to get successor for.
_pTaskRefID
[out] Pointer to a variable that will receive the unique identifier of the successor task reference.
Return Value
Returns an error code. See EHPMError.
See Also
TaskRefUtilGetPrevAtSameOrLowerLevel
Gets the predecessor task reference at the same or lower level as a task reference id.
HPMError TaskRefUtilGetPrevAtSameOrLowerLevel (
    void * _pSession,
    HPMUniqueID _TaskRefID,
    HPMUniqueID * _pTaskRefID
    );
Parameters
_pSession
[in] A connected session. See SessionOpen.
_TaskRefID
[in] The unique identifier of the task reference to get predecessor for.
_pTaskRefID
[out] Pointer to a variable that will receive the unique identifier of the successor task reference.
Return Value
Returns an error code. See EHPMError.
See Also
TaskRefUtilMoveInTree
Moves a task in a task tree.
HPMError TaskRefUtilMoveInTree (
    void * _pSession,
    HPMUniqueID _TaskRefID,
    HPMUniqueID _ParentTaskRefID,
    HPMUniqueID _InsertAfterTaskRefID,
    const HPMChangeCallbackData_TaskChangeDisposition * * _pReturn
    );
Parameters
_pSession
[in] A connected session. See SessionOpen.
_TaskRefID
[in] The unique identifier of the task reference to move.
_ParentTaskRefID
[in] The unique identifier of the parent task reference to insert after.
_InsertAfterTaskRefID
[in] The unique identifier of the task reference to insert after. If set to -1 the task ref to insert will be inserted as the last child of the parent task ref.
_pReturn
[out] Pointer to a pointer of a HPMChangeCallbackData_TaskChangeDisposition object, representing the returned data. If this parameter is not NULL, the function will block.
Return Value
Returns an error code. See EHPMError.
See Also
TaskRefUtilTraceTree
Traces the task tree.
HPMError TaskRefUtilTraceTree (
    void * _pSession,
    HPMUniqueID _RootTaskRefID
    );
Parameters
_pSession
[in] A connected session. See SessionOpen.
_RootTaskRefID
[in] The unique identifier of the task reference that is root of the tree that will be traced.
Return Value
Returns an error code. See EHPMError.
Comments
Tracing is only available when debugging is enabled. |
See Also
TaskRefUtilIsCompleted
Gets the completion of a task by calculating the completion from its children. If a leaf item is sent in the completion of the task is used.
HPMError TaskRefUtilIsCompleted (
    void * _pSession,
    HPMUniqueID _TaskRefID,
    HPMInt32 * _pReturn
    );
Parameters
_pSession
[in] A connected session. See SessionOpen.
_TaskRefID
[in] The unique identifier of the task reference to check for completion on.
_pReturn
[out] Returns 1 if complete 0 otherwise.
Return Value
Returns an error code. See EHPMError.
See Also
TaskRefUtilHasChildren
Checks if a task ref has children.
HPMError TaskRefUtilHasChildren (
    void * _pSession,
    HPMUniqueID _TaskRefID,
    HPMInt32 * _pReturn
    );
Parameters
_pSession
[in] A connected session. See SessionOpen.
_TaskRefID
[in] The unique identifier of the task reference to do children check for.
_pReturn
[out] Returns 1 if task has children 0 otherwise.
Return Value
Returns an error code. See EHPMError.
See Also
TaskRefUtilCanStartNow
Checks if work can be started on a task ref.
HPMError TaskRefUtilCanStartNow (
    void * _pSession,
    HPMUniqueID _TaskRefID,
    HPMInt32 * _pReturn
    );
Parameters
_pSession
[in] A connected session. See SessionOpen.
_TaskRefID
[in] The unique identifier of the task reference to check if work can be started on.
_pReturn
[out] Returns 1 if work can be started, 0 otherwise.
Return Value
Returns an error code. See EHPMError.
See Also
TaskUtilOneTaskRefHasChildren
Checks if any of the task refs of a task has children.
HPMError TaskUtilOneTaskRefHasChildren (
    void * _pSession,
    HPMUniqueID _TaskID,
    HPMInt32 * _pReturn
    );
Parameters
_pSession
[in] A connected session. See SessionOpen.
_TaskID
[in] The unique identifier of the task whose task references are checked for children.
_pReturn
[out] Returns 1 if one of the task refs of a task has children 0 otherwise.
Return Value
Returns an error code. See EHPMError.
See Also
TaskRefGetTask
Gets the task a task reference points to.
HPMError TaskRefGetTask (
    void * _pSession,
    HPMUniqueID _TaskRefID,
    HPMUniqueID * _pTaskID
    );
Parameters
_pSession
[in] A connected session. See SessionOpen.
_TaskRefID
[in] The unique identifier of the task reference to get the task unique identifier for.
_pTaskID
[out] Pointer to a variable that will receive the unique identifier of the task a task reference points to.
Return Value
Returns an error code. See EHPMError.
See Also
TaskRefGetContainer
Gets the container a task reference points to.
HPMError TaskRefGetContainer (
    void * _pSession,
    HPMUniqueID _TaskRefID,
    HPMUniqueID * _pTaskID
    );
Parameters
_pSession
[in] A connected session. See SessionOpen.
_TaskRefID
[in] The unique identifier of the task reference to get the container for.
_pTaskID
[out] Pointer to a variable that will receive the unique identifier of the container. Can be a project, resource, backlog project or a QA project.
Return Value
Returns an error code. See EHPMError.
See Also
TaskRefEnum
Enumerates task references in a container.
HPMError TaskRefEnum (
    void * _pSession,
    HPMUniqueID _ContainerID,
    const HPMTaskEnum * * _pEnum
    );
Parameters
_pSession
[in] A connected session. See SessionOpen.
_ContainerID
[in] A unique identifier of a container. Can be a project, resource, backlog project or a QA project.
_pEnum
[out] Pointer to a pointer of a HPMTaskEnum object, representing the returned data.
Return Value
Returns an error code. See EHPMError.
Comments
The returned object must be freed with ObjectFree or a memory leak will result.
See Also
HPMSdkFunctions, ObjectFree, HPMTaskEnum
TaskRefConnect
Connects two task references.
HPMError TaskRefConnect (
    void * _pSession,
    HPMUniqueID _TaskRefIDFrom,
    HPMUniqueID _TaskRefIDTo,
    HPMUniqueID * _pConnectionID
    );
Parameters
_pSession
[in] A connected session. See SessionOpen.
_TaskRefIDFrom
[in] The unique identifier of the task reference to create a connection from.
_TaskRefIDTo
[in] The unique identifier of the task reference to create a connection to.
_pConnectionID
[out] Pointer to a variable that will receive the unique identifier of the created connection. In non-blocking mode the unique identifier will be a temporary value that you can match against the HPMChangeCallbackData_TaskRefConnect::m_LocalTempConnectionID.
Return Value
Returns an error code. See EHPMError.
See Also
TaskRefGetTreeLevel
Gets the tree level of a task.
HPMError TaskRefGetTreeLevel (
    void * _pSession,
    HPMUniqueID _TaskRefID,
    HPMInt32 * _pData
    );
Parameters
_pSession
[in] A connected session. See SessionOpen.
_TaskRefID
[in] The unique identifier of the task reference to get the tree level for.
_pData
[out] Pointer to a variable that will receive the tree level.
Return Value
Returns an error code. See EHPMError.
See Also
TaskRefGetPreviousID
Deprecated, use TaskChangeDisposition instead. Gets the previous task reference of a task reference.
HPMError TaskRefGetPreviousID (
    void * _pSession,
    HPMUniqueID _TaskRefID,
    HPMUniqueID * _pData
    );
Parameters
_pSession
[in] A connected session. See SessionOpen.
_TaskRefID
[in] The unique identifier of the task reference to get the previous task reference for.
_pData
[out] Pointer to a variable that will receive the unique identifier of the task reference set as previous.
Return Value
Returns an error code. See EHPMError.
See Also
TaskRefGetPreviousWorkPriorityID
Gets the previous task reference of a task reference in the work priority | list.
HPMError TaskRefGetPreviousWorkPriorityID (
    void * _pSession,
    HPMUniqueID _TaskRefID,
    HPMUniqueID * _pData
    );
Parameters
_pSession
[in] A connected session. See SessionOpen.
_TaskRefID
[in] The unique identifier of the task reference to get the previous task reference for.
_pData
[out] Pointer to a variable that will receive the unique identifier of the task reference set as previous.
Return Value
Returns an error code. See EHPMError.
See Also
TaskRefClearNewlyCreated
Clears the newly created flag of a task reference.
HPMError TaskRefClearNewlyCreated (
    void * _pSession,
    HPMUniqueID _TaskRefID
    );
Parameters
_pSession
[in] A connected session. See SessionOpen.
_TaskRefID
[in] The unique identifier of the task reference to clear the newly created flag on.
Return Value
Returns an error code. See EHPMError.
See Also
TaskRefGetNewlyCreated
Gets the newly created flag of a task reference.
HPMError TaskRefGetNewlyCreated (
    void * _pSession,
    HPMUniqueID _TaskRefID,
    HPMInt32 * _pData
    );
Parameters
_pSession
[in] A connected session. See SessionOpen.
_TaskRefID
[in] The unique identifier of the task reference to get the newly create flag for.
_pData
[out] Pointer to a variable that will receive the state of the newly create flag.
Return Value
Returns an error code. See EHPMError.
See Also
TaskRefSetUIDHistory
Sets the unique identification history of a task reference.
HPMError TaskRefSetUIDHistory (
    void * _pSession,
    HPMUniqueID _TaskRefID,
    const HPMTaskUIDHistory * _pData
    );
Parameters
_pSession
[in] A connected session. See SessionOpen.
_TaskRefID
[in] The unique identifier of the task reference to set the unique identifier history for.
_pData
[in] Pointer to a HPMTaskUIDHistory object specifying the unique identifier history.
Return Value
Returns an error code. See EHPMError.
See Also
HPMSdkFunctions, HPMTaskUIDHistory
TaskRefGetUIDHistory
Gets the unique identification history of a task reference.
HPMError TaskRefGetUIDHistory (
    void * _pSession,
    HPMUniqueID _TaskRefID,
    const HPMTaskUIDHistory * * _pData
    );
Parameters
_pSession
[in] A connected session. See SessionOpen.
_TaskRefID
[in] The unique identifier of the task reference to get the unique identifier history for.
_pData
[out] Pointer to a pointer of a HPMTaskUIDHistory object, representing the returned data.
Return Value
Returns an error code. See EHPMError.
Comments
The returned object must be freed with ObjectFree or a memory leak will result.
See Also
HPMSdkFunctions, ObjectFree, HPMTaskUIDHistory
TaskConnectionDelete
Deletes a task connection.
HPMError TaskConnectionDelete (
    void * _pSession,
    HPMUniqueID _ConnectionID
    );
Parameters
_pSession
[in] A connected session. See SessionOpen.
_ConnectionID
[in] The unique identifier of the connection to delete.
Return Value
Returns an error code. See EHPMError.
See Also
TaskConnectionSetConnectionType
Sets the type of a task connection.
HPMError TaskConnectionSetConnectionType (
    void * _pSession,
    HPMUniqueID _ConnectionID,
    HPMInt32 _Type
    );
Parameters
_pSession
[in] A connected session. See SessionOpen.
_ConnectionID
[in] The unique identifier of the connection to set the type of.
_Type
[in] The type to set. Can be one of EHPMTaskConnectionType.
Return Value
Returns an error code. See EHPMError.
See Also
HPMSdkFunctions, EHPMTaskConnectionType
TaskConnectionGetConnectionType
Gets the type of a task connection.
HPMError TaskConnectionGetConnectionType (
    void * _pSession,
    HPMUniqueID _ConnectionID,
    HPMInt32 * _pType
    );
Parameters
_pSession
[in] A connected session. See SessionOpen.
_ConnectionID
[in] The unique identifier of the task to get the type of.
_pType
[out] Pointer to a variable that will receive the type. Will be one of EHPMTaskConnectionType.
Return Value
Returns an error code. See EHPMError.
See Also
HPMSdkFunctions, EHPMTaskConnectionType
TaskConnectionSetLeadLagTime
Sets the lead/lag time of a task connection.
HPMError TaskConnectionSetLeadLagTime (
    void * _pSession,
    HPMUniqueID _ConnectionID,
    HPMInt32 _Time
    );
Parameters
_pSession
[in] A connected session. See SessionOpen.
_ConnectionID
[in] The unique identifier of the connection to set the lead/lag time on.
_Time
[in] The number of days lead/lag time to set.
Return Value
Returns an error code. See EHPMError.
See Also
TaskConnectionGetLeadLagTime
Gets the lead lag time of a task connection.
HPMError TaskConnectionGetLeadLagTime (
    void * _pSession,
    HPMUniqueID _ConnectionID,
    HPMInt32 * _pTime
    );
Parameters
_pSession
[in] A connected session. See SessionOpen.
_ConnectionID
[in] The unique identifier of the connection to get the lead/lag time for.
_pTime
[out] Pointer to a variable that will receive the number of days of lead/lag time.
Return Value
Returns an error code. See EHPMError.
See Also
TaskConnectionGetConnectFrom
Gets the task reference a task connection is connected from.
HPMError TaskConnectionGetConnectFrom (
    void * _pSession,
    HPMUniqueID _ConnectionID,
    HPMUniqueID * _pRefID
    );
Parameters
_pSession
[in] A connected session. See SessionOpen.
_ConnectionID
[in] The unique identifier of the connection to get the the connected from task reference on.
_pRefID
[out] Pointer to a variable that will receive the unique identifier of the task reference the connection is connected from.
Return Value
Returns an error code. See EHPMError.
See Also
HPMSdkFunctions, TaskConnectionGetConnectTo
TaskConnectionGetConnectTo
Gets the task reference a task connection is connected to.
HPMError TaskConnectionGetConnectTo (
    void * _pSession,
    HPMUniqueID _ConnectionID,
    HPMUniqueID * _pRefID
    );
Parameters
_pSession
[in] A connected session. See SessionOpen.
_ConnectionID
[in] The unique identifier of the connection to get the connected to task reference on.
_pRefID
[out] Pointer to a variable that will receive the unique identifier of the task reference the connection is connected to.
Return Value
Returns an error code. See EHPMError.
See Also
HPMSdkFunctions, TaskConnectionGetConnectFrom
TaskUpdatePipelineWorkflowToNewestVersion
Updates all tasks to the newest version of the workflow.
HPMError TaskUpdatePipelineWorkflowToNewestVersion (
    void * _pSession,
    const HPMTaskEnum * _pData
    );
Parameters
_pSession
[in] A connected session. See SessionOpen.
_pData
[in] Pointer to a HPMTaskEnum object specifying the tasks that will be updated with the newest version of the workflow.
Return Value
Returns an error code. See EHPMError.
Comments
Call this function on the task ID of a main pipeline task to create, delete, or update the properties of the subtasks that makes up the tasks of a pipeline workflow. This function takes care of all that is needed to either create the sub-pipeline tasks the first time a pipeline workflow is set on a task, or when you want to upgrade the task to the latest version of the pipeline. The update deletes previously autocreated sub-pipeline tasks if they have been removed from the workflow, creates new sub-pipeline tasks and updates the properties such as name and the position in the task tree on already existing tasks. If the user has created tasks within the pipeline those tasks will be moved outside of the pipeline in the event of the sub-pipeline task they were created under is deleted as the result of being deleted in the workflow. The same thing happens if the flag in the workflow to allow creation of sub tasks is removed.
See Also
TaskFind
Gets a list of task ids given a prepared find context.
HPMError TaskFind (
    void * _pSession,
    const HPMFindContextData * _pFindContext,
    HPMUInt32 _Flags,
    const HPMTaskEnum * * _pEnum
    );
Parameters
_pSession
[in] A connected session. See SessionOpen.
_pFindContext
[in] The prepared find context to use for the find.
_Flags
[in] Flags specifying find options. Can be any combination of EHPMTaskFindFlag.
_pEnum
[out] Pointer to a pointer of a HPMTaskEnum object, representing the returned data.
Return Value
Returns an error code. See EHPMError.
Comments
The returned object must be freed with ObjectFree or a memory leak will result.
See Also
HPMSdkFunctions, ObjectFree, HPMTaskEnum, HPMFindContextData
TaskRefUtilIsInFindContext
Checks if a task ref is included in a prepared find context.
HPMError TaskRefUtilIsInFindContext (
    void * _pSession,
    HPMUniqueID _TaskRefID,
    const HPMFindContextData * _pFindContext,
    HPMInt32 * _pPasses
    );
Parameters
_pSession
[in] A connected session. See SessionOpen.
_TaskRefID
[in] The unique identifier of the task ref to check if it passes through a find context.
_pFindContext
[in] The find context to check the task ref in.
_pPasses
[out] Set to 1 if task ref is in the find context, 0 otherwise.
Return Value
Returns 1 if the task reference is included in the find context 0 otherwise.
See Also
HPMSdkFunctions, HPMFindContextData
TaskRefGetSummary
Gets the computed sums for a parent task.
HPMError TaskRefGetSummary (
    void * _pSession,
    HPMUniqueID _TaskRefID,
    const HPMTaskSummary * * _pTaskSummary
    );
Parameters
_pSession
[in] A connected session. See SessionOpen.
_TaskRefID
[in] The unique identifier of the task reference to get summation for.
_pTaskSummary
[out] Pointer to a pointer of a HPMTaskSummary object, representing the returned data.
Return Value
Returns an error code. See EHPMError.
Comments
The returned object must be freed with ObjectFree or a memory leak will result.
See Also
HPMSdkFunctions, HPMTaskSummary
TaskGetBacklogPriority
Gets the backlog priority of a task.
HPMError TaskGetBacklogPriority (
    void * _pSession,
    HPMUniqueID _TaskID,
    HPMInt32 * _pData
    );
Parameters
_pSession
[in] A connected session. See SessionOpen.
_TaskID
[in] The unique identifier of the task to get the priority for.
_pData
[out] Pointer to a variable that will receive the priority. Will be one of EHPMTaskAgilePriorityCategory.
Return Value
Returns an error code. See EHPMError.
See Also
HPMSdkFunctions, EHPMTaskAgilePriorityCategory
TaskSetBacklogPriority
Sets the backlog priority of a task.
HPMError TaskSetBacklogPriority (
    void * _pSession,
    HPMUniqueID _TaskID,
    HPMInt32 _Data
    );
Parameters
_pSession
[in] A connected session. See SessionOpen.
_TaskID
[in] The unique identifier of the task to set the priority for.
_Data
[in] The priority to set. Can be one of EHPMTaskAgilePriorityCategory.
Return Value
Returns an error code. See EHPMError.
See Also
HPMSdkFunctions, EHPMTaskAgilePriorityCategory
TaskGetSprintPriority
Gets the sprint priority of a task.
HPMError TaskGetSprintPriority (
    void * _pSession,
    HPMUniqueID _TaskID,
    HPMInt32 * _pData
    );
Parameters
_pSession
[in] A connected session. See SessionOpen.
_TaskID
[in] The unique identifier of the task to get the priority for.
_pData
[out] Pointer to a variable that will receive the priority. Will be one of EHPMTaskAgilePriorityCategory.
Return Value
Returns an error code. See EHPMError.
See Also
HPMSdkFunctions, EHPMTaskAgilePriorityCategory
TaskSetSprintPriority
Sets the sprint priority of a task.
HPMError TaskSetSprintPriority (
    void * _pSession,
    HPMUniqueID _TaskID,
    HPMInt32 _Data
    );
Parameters
_pSession
[in] A connected session. See SessionOpen.
_TaskID
[in] The unique identifier of the task to set the priority for.
_Data
[in] The priority to set. Can be one of EHPMTaskAgilePriorityCategory.
Return Value
Returns an error code. See EHPMError.
See Also
HPMSdkFunctions, EHPMTaskAgilePriorityCategory
TaskGetBugPriority
Gets the bug priority of a task.
HPMError TaskGetBugPriority (
    void * _pSession,
    HPMUniqueID _TaskID,
    HPMInt32 * _pData
    );
Parameters
_pSession
[in] A connected session. See SessionOpen.
_TaskID
[in] The unique identifier of the task to get the priority for.
_pData
[out] Pointer to a variable that will receive the priority. Will be one of EHPMTaskAgilePriorityCategory.
Return Value
Returns an error code. See EHPMError.
See Also
HPMSdkFunctions, EHPMTaskAgilePriorityCategory
TaskSetBugPriority
Sets the bug priority of a task.
HPMError TaskSetBugPriority (
    void * _pSession,
    HPMUniqueID _TaskID,
    HPMInt32 _Data
    );
Parameters
_pSession
[in] A connected session. See SessionOpen.
_TaskID
[in] The unique identifier of the task to set the priority for.
_Data
[in] The priority to set. Can be one of EHPMTaskAgilePriorityCategory.
Return Value
Returns an error code. See EHPMError.
See Also
HPMSdkFunctions, EHPMTaskAgilePriorityCategory
TaskGetAgilePriorityCategory
Gets the agile priority of a task.
HPMError TaskGetAgilePriorityCategory (
    void * _pSession,
    HPMUniqueID _TaskID,
    HPMInt32 * _pData
    );
Parameters
_pSession
[in] A connected session. See SessionOpen.
_TaskID
[in] The unique identifier of the task to get the priority for.
_pData
[out] Pointer to a variable that will receive the priority. Will be one of EHPMTaskAgilePriorityCategory.
Return Value
Returns an error code. See EHPMError.
Comments
Gets priority based on the task's container, so it does not work for committed tasks. Use TaskGetBacklogPriority, TaskGetSprintPriority or TaskGetBugPriority instead.
See Also
HPMSdkFunctions, EHPMTaskAgilePriorityCategory
TaskSetAgilePriorityCategory
Sets the agile priority of a task.
HPMError TaskSetAgilePriorityCategory (
    void * _pSession,
    HPMUniqueID _TaskID,
    HPMInt32 _Data
    );
Parameters
_pSession
[in] A connected session. See SessionOpen.
_TaskID
[in] The unique identifier of the task to set the priority for.
_Data
[in] The priority to set. Can be one of EHPMTaskAgilePriorityCategory.
Return Value
Returns an error code. See EHPMError.
Comments
Sets priority based on the task's container, so it does not work for committed tasks. Use TaskSetBacklogPriority, TaskSetSprintPriority or TaskSetBugPriority instead.
See Also
HPMSdkFunctions, EHPMTaskAgilePriorityCategory
TaskUtilUpdateAgilePriority
Updates the priority order in a project according to the agile priority status.
HPMError TaskUtilUpdateAgilePriority (
    void * _pSession,
    HPMUniqueID _ProjectID
    );
Parameters
_pSession
[in] A connected session. See SessionOpen.
_ProjectID
[in] The unique identifier of the project to update the priority order in.
Return Value
Returns an error code. See EHPMError.
See Also
HPMSdkFunctions, EHPMTaskAgilePriorityCategory
TaskRefGetMilestoneSummary
Gets the computed sums for a milestone.
HPMError TaskRefGetMilestoneSummary (
    void * _pSession,
    HPMUniqueID _TaskRefID,
    const HPMMilestoneSummary * * _pMilestoneSummary
    );
Parameters
_pSession
[in] A connected session. See SessionOpen.
_TaskRefID
[in] The unique identifier of the milestone task reference to get summation for.
_pMilestoneSummary
[out] Pointer to a pointer of a HPMMilestoneSummary object, representing the returned data.
Return Value
Returns an error code. See EHPMError.
Comments
The returned object must be freed with ObjectFree or a memory leak will result.
See Also
HPMSdkFunctions, HPMMilestoneSummary
TaskRefConnectionsEnum
Gets all connections to/from a task reference.
HPMError TaskRefConnectionsEnum (
    void * _pSession,
    HPMUniqueID _TaskRefID,
    HPMUInt32 _Flags,
    const HPMTaskConnectionEnum * * _pEnum
    );
Parameters
_pSession
[in] A connected session. See SessionOpen.
_TaskRefID
[in] The unique identifier of the task reference to get connections for.
_Flags
[in] Flags specifying which type of connections to return. Can be any combination of EHPMTaskConnectionFlag.
_pEnum
[out] Pointer to a pointer of a HPMTaskConnectionEnum object, representing the returned data.
Return Value
Returns an error code. See EHPMError.
Comments
The returned object must be freed with ObjectFree or a memory leak will result.
See Also
HPMSdkFunctions, HPMTaskConnectionEnum, EHPMTaskConnectionFlag
TaskUtilSprintTaskRefEnum
Enumerates all task references, including QA bugs that are committed to a sprint.
HPMError TaskUtilSprintTaskRefEnum (
    void * _pSession,
    HPMUniqueID _TaskID,
    const HPMTaskEnum * * _pEnum
    );
Parameters
_pSession
[in] A connected session. See SessionOpen.
_TaskID
[in] The unique identifier of the sprint to get committed tasks for.
_pEnum
[out] Pointer to a pointer of a HPMTaskEnum object, representing the returned task ref enum data.
Return Value
Returns an error code. See EHPMError.
Comments
The returned object must be freed with ObjectFree or a memory leak will result.
See Also
TaskUtilGetEffectiveLinkedToMilestones
Returns the effective release tags for the task.
HPMError TaskUtilGetEffectiveLinkedToMilestones (
    void * _pSession,
    HPMUniqueID _TaskID,
    HPMInt32 _bForceInherited,
    HPMInt32 _bReturnNoMilestoneID,
    const HPMTaskEffectiveLinkedToMilestones * * _pData
    );
Parameters
_pSession
[in] A connected session. See SessionOpen.
_TaskID
[in] The unique identifier of the task to get the effective release tags for.
_bForceInherited
[in] Forces the calculation to disregard any explicitly set milestones on _TaskID. Useful for getting the list of milestones a task would inherit from if the task was set to inherit.
_bReturnNoMilestoneID
[in] If set, the special no milestone id value will be returned, see UtilGetNoMilestoneID.
_pData
[out] Pointer to a pointer of a HPMTaskEffectiveLinkedToMilestones object, representing the returned data.
Return Value
Returns an error code. See EHPMError.
Comments
The returned object must be freed with ObjectFree or a memory leak will result.
See Also
HPMSdkFunctions, HPMTaskEffectiveLinkedToMilestones
TaskGetOriginallyCreatedOnTime
Returns the time the task was created on.
HPMError TaskGetOriginallyCreatedOnTime (
    void * _pSession,
    HPMUniqueID _TaskID,
    HPMUInt64 * _pData
    );
Parameters
_pSession
[in] A connected session. See SessionOpen.
_TaskID
[in] The unique identifier of the task to get the creation time for.
_pData
[out] Pointer to a variable that will receive the time the task was created on. Expressed as number of micro seconds since 1970 UTC.
Return Value
Returns an error code. See EHPMError.
Comments
The returned object must be freed with ObjectFree or a memory leak will result.
See Also
TaskSetLastUpdatedBy
Sets the last updated user of a task.
HPMError TaskSetLastUpdatedBy (
    void * _pSession,
    HPMUniqueID _TaskID,
    HPMUniqueID _Data
    );
Parameters
_pSession
[in] A connected session. See SessionOpen.
_TaskID
[in] The unique identifier of the task to set the last updated time of.
_Data
[in] The last user Id that updated a task to set.
Return Value
Returns an error code. See EHPMError.
See Also
TaskGetLastUpdatedBy
Gets the last updated user of a task.
HPMError TaskGetLastUpdatedBy (
    void * _pSession,
    HPMUniqueID _TaskID,
    HPMUniqueID * _pData
    );
Parameters
_pSession
[in] A connected session. See SessionOpen.
_TaskID
[in] The unique identifier of the task to get the last updated time of.
_pData
[out] Pointer to a variable that will receive the last user Id that updated a task.
Return Value
Returns an error code. See EHPMError.
See Also
TaskCheckWorkflowTransitionRequirements
Checks that the requirements of a workflow status transition are met.
HPMError TaskCheckWorkflowTransitionRequirements (
    void * _pSession,
    HPMUniqueID _TaskID,
    HPMUniqueID _ResourceID,
    HPMInt32 _Data,
    const HPMTaskWorkflowTransitionRequirementsNotMet * * _pData
    );
Parameters
_pSession
[in] A connected session. See SessionOpen.
_TaskID
[in] The unique identifier of the task to check transition requirements for.
_ResourceID
[in] The unique identifier of the resource the change is being made on behalf of.
_Data
[in] The target workflow status to check transition requirements to. This value identifies a status in the HPMProjectWorkflowSettings for the project. The value should point to a HPMProjectWorkflowObject::m_ObjectID that has m_ObjectType set to EHPMProjectWorkflowObjectType_WorkflowStatus.
_pData
[out] Pointer to a pointer of a HPMTaskWorkflowTransitionRequirementsNotMet, representing the transition requirements that have not been met.
Return Value
Returns an error code. See EHPMError.
See Also
TaskGetOldPercentResourceAllocation
Gets all previous partial allocations of a task.
HPMError TaskGetOldPercentResourceAllocation (
    void * _pSession,
    HPMUniqueID _TaskID,
    HPMTaskOldAllocation const * * _pData
    );
Parameters
_pSession
[in] A connected session. See SessionOpen.
_TaskID
[in] The unique identifier of the sprint task to get individual resource allocation of.
_pData
[out] Pointer to a pointer of a HPMTaskOldAllocation object, representing the returned data.
Return Value
Returns an error code. See EHPMError.
Comments
The returned object must be freed with ObjectFree or a memory leak will result.
See Also
HPMSdkFunctions, ObjectFree, HPMTaskOldAllocation
TaskRefGetWBSPath
Gets WBS path of a task reference.
HPMError TaskRefGetWBSPath (
    void * _pSession,
    HPMUniqueID _TaskRefID,
    HPMString const * * _pData
    );
Parameters
_pSession
[in] A connected session. See SessionOpen.
_TaskRefID
[in] The unique identifier of task reference to get WBS Path for.
_pData
[out] Pointer to a pointer of a HPMString object, representing the returned data.
Return Value
Returns an error code. See EHPMError.
Comments
The returned object must be freed with ObjectFree or a memory leak will result.
TaskRefUtilHasLimitedVisibility
Checks if a task ref has limited visibility for a resource in a project. Also checks the task's parents for limited visibility.
HPMError TaskRefUtilHasLimitedVisibility (
    void * _pSession,
    HPMUniqueID _TaskRefID,
    HPMUniqueID _ResourceID,
    HPMUniqueID _ProjectID,
    HPMInt32 * _pHasLimitedVisibility
    );
Parameters
_pSession
[in] A connected session. See SessionOpen.
_TaskRefID
[in] The unique identifier of the task ref to check for limited visibility.
_ResourceID
[in] The unique id of the resource to check for visibility.
_ProjectID
[in] The unique id of the project to check for visibility in.
_pHasLimitedVisibility
[out] Set to 1 if the task reference has limited visibility, 0 otherwise.
Return Value
Returns 1 if the task reference has limited visibility, 0 otherwise.
See Also
TaskRefUtilIsDelegatedTo
Checks if a task ref is delegated to a resource in a project. Also checks the task's parents for delegation.
HPMError TaskRefUtilIsDelegatedTo (
    void * _pSession,
    HPMUniqueID _TaskRefID,
    HPMUniqueID _ResourceID,
    HPMUniqueID _ProjectID,
    HPMInt32 * _pIsDelegatedTo
    );
Parameters
_pSession
[in] A connected session. See SessionOpen.
_TaskRefID
[in] The unique identifier of the task ref to check for delegation.
_ResourceID
[in] The unique id of the resource to check for delegation.
_ProjectID
[in] The unique id of the project to check for delegation in.
_pIsDelegatedTo
[out] Set to if the task reference is delegated to the resource, 0 otherwise.
Return Value
Returns 1 if the task reference is delegated to the resource, 0 otherwise.
See Also
TaskLinkToMilestones
Links a group of tasks to different milestones within one DB command.
HPMError TaskLinkToMilestones (
    void * _pSession,
    HPMUniqueID _ProjectID,
    HPMTaskMilestonesList const * _pTaskMilestonesList
    );
Parameters
_pSession
[in] A connected session. See SessionOpen.
_ProjectID
[in] The unique id of the project to perform linking in.
_pTaskMilestonesList
[in] List of tasks and appropriate milestone references to link tasks to. If you link task to 'No Release', no other milestone references should be specified for this task.
Return Value
Returns an error code. See EHPMError.
See Also
UtilGetNoMilestoneID
Returns unique id of 'No release' option. Use this function to get the right id if you want to set linked milestone to 'No Release' for some task.
HPMError UtilGetNoMilestoneID (
    void * _pSession,
    HPMInt32 * _pID
    );
Parameters
_pSession
[in] A connected session. See SessionOpen.
_pID
[out] Set to the 'No Release' identifier.
Return Value
Returns an error code. See EHPMError.
See Also
HPMSdkFunctions, TaskLinkToMilestones
TaskGetLastUpdatedByResourceName
Gets the user name of the last resource that updated a task
HPMError TaskGetLastUpdatedByResourceName (
    void * _pSession,
    HPMUniqueID _TaskID,
    HPMResourceNameInformation const * * _pData
    );
Parameters
_pSession
[in] A connected session. See SessionOpen.
_TaskID
[in] The unique identifier of the task to get the last updated resource name of.
_pData
[out] Pointer to a pointer of a HPMResourceNameInformation object, representing the returned data.
Comments
The returned object must be freed with ObjectFree or a memory leak will result.
See Also
TaskRefReportFind
Gets a list of task references filtered and grouped by a report.
HPMError TaskRefReportFind (
    void * _pSession,
    HPMReport const * _pReport,
    HPMUniqueID _ProjectID,
    HPMReportFind const * * _pData
    );
Parameters
_pSession
[in] A connected session. See SessionOpen.
_pReport
[in] The report for the find.
_ProjectID
[in] If the report is a project report this must be set to the project id of the project, otherwise if the report is global set to -1.
_pData
[out] Pointer to a pointer of a HPMReportFind object, representing the returned data.
Return Value
Returns an error code. See EHPMError.
Comments
The returned object must be freed with ObjectFree or a memory leak will result.
See Also
HPMSdkFunctions, ObjectFree, HPMReportFind, HPMReport
EHPMVersionControlCallbackOperation
Callback operation value used in HPMVersionControlCallbackInfo::m_Operation.
enum EHPMVersionControlCallbackOperation {
EHPMVersionControlCallbackOperation_NewVersionOfSDKRequired = 0,
EHPMVersionControlCallbackOperation_None = 1,
EHPMVersionControlCallbackOperation_Add = 2,
EHPMVersionControlCallbackOperation_Update = 3,
EHPMVersionControlCallbackOperation_Delete = 4,
EHPMVersionControlCallbackOperation_Rename = 5,
EHPMVersionControlCallbackOperation_ReAdd = 6,
EHPMVersionControlCallbackOperation_Rollback = 7,
EHPMVersionControlCallbackOperation_Undelete = 8,
};
Values
EHPMVersionControlCallbackOperation_NewVersionOfSDKRequired
The version control operation did not exist when this SDK was created. Upgrade to a newer version of the SDK to be able to use this format.
EHPMVersionControlCallbackOperation_None
No operation. Should not occur.
EHPMVersionControlCallbackOperation_Add
A file were added to the database.
EHPMVersionControlCallbackOperation_Update
A file was updated.
EHPMVersionControlCallbackOperation_Delete
A file was deleted.
EHPMVersionControlCallbackOperation_Rename
A file was renamed.
EHPMVersionControlCallbackOperation_ReAdd
A file was added with the same name as a deleted file.
EHPMVersionControlCallbackOperation_Rollback
A file was rolled back.
EHPMVersionControlCallbackOperation_Undelete
A file was undeleted.
See Also
EHPMVersionControlFileAttributesFlag
Callback file attribute flags used in HPMVersionControlCallbackInfo::m_FileAttributes.
enum EHPMVersionControlFileAttributesFlag {
EHPMVersionControlFileAttributesFlag_None = 0,
EHPMVersionControlFileAttributesFlag_Directory = 1,
};
Values
EHPMVersionControlFileAttributesFlag_None
TBD
EHPMVersionControlFileAttributesFlag_Directory
The file is a directory.
See Also
HPMVersionControlCallbackInfo}
EHPMVersionControlMetaDataType
Meta data type used in HPMVersionControlMetaDataEntry::m_Type.
enum EHPMVersionControlMetaDataType {
EHPMVersionControlMetaDataType_NewVersionOfSDKRequired = 0,
EHPMVersionControlMetaDataType_Unknown = 1,
EHPMVersionControlMetaDataType_String = 2,
EHPMVersionControlMetaDataType_Int = 3,
EHPMVersionControlMetaDataType_Float = 4,
};
Values
EHPMVersionControlMetaDataType_NewVersionOfSDKRequired
The meta data type did not exist when this SDK was created. Upgrade to a newer version of the SDK to be able to use this format.
EHPMVersionControlMetaDataType_Unknown
Unknown meta data type. Should not occur.
EHPMVersionControlMetaDataType_String
String meta data type.
EHPMVersionControlMetaDataType_Int
Integer meta data type.
EHPMVersionControlMetaDataType_Float
Float meta data type.
See Also
HPMVersionControlMetaDataEntry
EHPMVersionControlCallbackChanged
Change flags used to specify what was changed when calling HPMVersionControlChangeDataCallback
enum EHPMVersionControlCallbackChanged {
EHPMVersionControlCallbackChanged_None = 0,
EHPMVersionControlCallbackChanged_FileContents = 1,
EHPMVersionControlCallbackChanged_Resource = 2,
EHPMVersionControlCallbackChanged_Comment = 4,
EHPMVersionControlCallbackChanged_Date = 8,
EHPMVersionControlCallbackChanged_MetaData = 16,
};
Values
EHPMVersionControlCallbackChanged_None
TBD
EHPMVersionControlCallbackChanged_FileContents
The contents of the file was changed.
EHPMVersionControlCallbackChanged_Resource
The resource name was changed.
EHPMVersionControlCallbackChanged_Comment
The resource comment was changed.
EHPMVersionControlCallbackChanged_Date
The date was changed.
EHPMVersionControlCallbackChanged_MetaData
The meta data entries was changed.
See Also
HPMVersionControlChangeDataCallback
EHPMVersionControlFileInfoFlag
File info flags used to HPMVersionControlFile::m_Flags
enum EHPMVersionControlFileInfoFlag {
EHPMVersionControlFileInfoFlag_None = 0,
EHPMVersionControlFileInfoFlag_CheckedOutByYou = 1,
EHPMVersionControlFileInfoFlag_CheckedOutByOther = 2,
EHPMVersionControlFileInfoFlag_ExistsLocally = 4,
EHPMVersionControlFileInfoFlag_ChildrenExistsLocallySome = 16,
EHPMVersionControlFileInfoFlag_ChildrenExistsLocallyAll = 32,
EHPMVersionControlFileInfoFlag_FileUpToDate = 64,
};
Values
EHPMVersionControlFileInfoFlag_None
TBD
EHPMVersionControlFileInfoFlag_CheckedOutByYou
The file is checked out be the current client (the SDK user).
EHPMVersionControlFileInfoFlag_CheckedOutByOther
The file is checked out by another client.
EHPMVersionControlFileInfoFlag_ExistsLocally
The file or directory exists locally.
EHPMVersionControlFileInfoFlag_ChildrenExistsLocallySome
Some of the files or directories of in the directory exists locally.
EHPMVersionControlFileInfoFlag_ChildrenExistsLocallyAll
All files and directories in the directory exists locally.
EHPMVersionControlFileInfoFlag_FileUpToDate
The file is up to date. Only compared with change time of file.
See Also
EHPMVersionControlAccessRightFlag
Used to define access rights in the version control system.
enum EHPMVersionControlAccessRightFlag {
EHPMVersionControlAccessRightFlag_None = 0,
EHPMVersionControlAccessRightFlag_List = 1,
EHPMVersionControlAccessRightFlag_Read = 2,
EHPMVersionControlAccessRightFlag_Write = 4,
EHPMVersionControlAccessRightFlag_Rename = 8,
EHPMVersionControlAccessRightFlag_Create = 16,
EHPMVersionControlAccessRightFlag_Delete = 32,
EHPMVersionControlAccessRightFlag_PermanentDelete = 64,
EHPMVersionControlAccessRightFlag_Restore = 128,
EHPMVersionControlAccessRightFlag_WritePermissions = 256,
EHPMVersionControlAccessRightFlag_ReadPermissions = 512,
};
Values
EHPMVersionControlAccessRightFlag_None
TBD
EHPMVersionControlAccessRightFlag_List
Access rights to list files and directories.
EHPMVersionControlAccessRightFlag_Read
Access rights to read files.
EHPMVersionControlAccessRightFlag_Write
Access rights to change files.
EHPMVersionControlAccessRightFlag_Rename
Access rights to rename files and directories.
EHPMVersionControlAccessRightFlag_Create
Access rights to create files and directories.
EHPMVersionControlAccessRightFlag_Delete
Access rights to delete files and directories.
EHPMVersionControlAccessRightFlag_PermanentDelete
Access rights to permanently delete files and directories.
EHPMVersionControlAccessRightFlag_Restore
Access rights to restore files and directories.
EHPMVersionControlAccessRightFlag_WritePermissions
Access rights to change permissions on files and directories.
EHPMVersionControlAccessRightFlag_ReadPermissions
Access rights to read permissions on files and directories.
See Also
HPMVersionControlAccessRight, HPMVersionControlFile
EHPMVersionControlSpecialAccessRightObject
Used to special access users in for granting access rights.
enum EHPMVersionControlSpecialAccessRightObject {
EHPMVersionControlSpecialAccessRightObject_NewVersionOfSDKRequired = -65536,
EHPMVersionControlSpecialAccessRightObject_Everyone = -2,
EHPMVersionControlSpecialAccessRightObject_Administartors = -3,
};
Values
EHPMVersionControlSpecialAccessRightObject_NewVersionOfSDKRequired
The action type did not exist when this SDK was created. Upgrade to a newer version of the SDK to be able to use this action type.
EHPMVersionControlSpecialAccessRightObject_Everyone
Everyone object.
EHPMVersionControlSpecialAccessRightObject_Administartors
Project administrators object.
See Also
EHPMVersionControlVersionAction
Used to define actions in the version control system.
enum EHPMVersionControlVersionAction {
EHPMVersionControlVersionAction_NewVersionOfSDKRequired = 0,
EHPMVersionControlVersionAction_None = 1,
EHPMVersionControlVersionAction_Add = 2,
EHPMVersionControlVersionAction_Update = 3,
EHPMVersionControlVersionAction_Delete = 4,
EHPMVersionControlVersionAction_Rename = 5,
EHPMVersionControlVersionAction_ReAdd = 6,
EHPMVersionControlVersionAction_Rollback = 7,
EHPMVersionControlVersionAction_Restore = 8,
};
Values
EHPMVersionControlVersionAction_NewVersionOfSDKRequired
The action type did not exist when this SDK was created. Upgrade to a newer version of the SDK to be able to use this action type.
EHPMVersionControlVersionAction_None
No action specified.
EHPMVersionControlVersionAction_Add
A file or directory was added.
EHPMVersionControlVersionAction_Update
A file or directory was updated.
EHPMVersionControlVersionAction_Delete
A file or directory was deleted.
EHPMVersionControlVersionAction_Rename
A file or directory was renamed.
EHPMVersionControlVersionAction_ReAdd
A file or directory was re-added.
EHPMVersionControlVersionAction_Rollback
A file or directory was rolled back.
EHPMVersionControlVersionAction_Restore
A file or directory was restored.
See Also
HPMVersionControlFileHistoryEntry, HPMVersionControlFile
EHPMVersionControlVersionActionInfo
Used to give information about actions in the version control system.
enum EHPMVersionControlVersionActionInfo {
EHPMVersionControlVersionActionInfo_NewVersionOfSDKRequired = 0,
EHPMVersionControlVersionActionInfo_None = 1,
EHPMVersionControlVersionActionInfo_Legacy = 2,
EHPMVersionControlVersionActionInfo_Add = 3,
EHPMVersionControlVersionActionInfo_DirAdd = 4,
EHPMVersionControlVersionActionInfo_FileAdd = 5,
EHPMVersionControlVersionActionInfo_Update = 6,
EHPMVersionControlVersionActionInfo_Delete = 7,
EHPMVersionControlVersionActionInfo_Rename = 8,
EHPMVersionControlVersionActionInfo_Move = 9,
EHPMVersionControlVersionActionInfo_ReAdd = 10,
EHPMVersionControlVersionActionInfo_FileReAdd = 11,
EHPMVersionControlVersionActionInfo_Rollback = 12,
EHPMVersionControlVersionActionInfo_Undelete = 13,
EHPMVersionControlVersionActionInfo_Create = 14,
EHPMVersionControlVersionActionInfo_SdkAdd = 15,
EHPMVersionControlVersionActionInfo_TransCreate = 16,
EHPMVersionControlVersionActionInfo_ProjectCreate = 17,
EHPMVersionControlVersionActionInfo_GlobalCreate = 18,
EHPMVersionControlVersionActionInfo_ProjectUpdate = 19,
};
Values
EHPMVersionControlVersionActionInfo_NewVersionOfSDKRequired
The action info did not exist when this SDK was created. Upgrade to a newer version of the SDK to be able to use this action info.
EHPMVersionControlVersionActionInfo_None
No action info specified
EHPMVersionControlVersionActionInfo_Legacy
Legacy action
EHPMVersionControlVersionActionInfo_Add
Default deleted projects directory created
EHPMVersionControlVersionActionInfo_DirAdd
Directory created
EHPMVersionControlVersionActionInfo_FileAdd
File created
EHPMVersionControlVersionActionInfo_Update
File checked in
EHPMVersionControlVersionActionInfo_Delete
File deleted
EHPMVersionControlVersionActionInfo_Rename
Renamed/moved file
EHPMVersionControlVersionActionInfo_Move
Moved to deleted projects
EHPMVersionControlVersionActionInfo_ReAdd
Directory re-added
EHPMVersionControlVersionActionInfo_FileReAdd
File re-added
EHPMVersionControlVersionActionInfo_Rollback
Rolled back to old version
EHPMVersionControlVersionActionInfo_Undelete
File restored
EHPMVersionControlVersionActionInfo_Create
Default global directory created
EHPMVersionControlVersionActionInfo_SdkAdd
Default SDK directory created
EHPMVersionControlVersionActionInfo_TransCreate
Default translations directory created
EHPMVersionControlVersionActionInfo_ProjectCreate
Default projects directory created
EHPMVersionControlVersionActionInfo_GlobalCreate
Default global directory created
EHPMVersionControlVersionActionInfo_ProjectUpdate
Default project folder updated
See Also
HPMVersionControlFileHistoryEntry
EHPMVersionControlError
Used to define errors in the version control system.
enum EHPMVersionControlError {
EHPMVersionControlError_NewVersionOfSDKRequired = 0,
EHPMVersionControlError_Success = 1,
EHPMVersionControlError_Other = 2,
EHPMVersionControlError_InternalError = 3,
EHPMVersionControlError_FileAlreadyExists = 4,
EHPMVersionControlError_Checksum = 5,
EHPMVersionControlError_DiskFull = 6,
EHPMVersionControlError_FileDoesNotExist = 7,
EHPMVersionControlError_InvalidVersion = 8,
EHPMVersionControlError_FileAlreadyCheckedOut = 9,
EHPMVersionControlError_AccessDenied = 10,
EHPMVersionControlError_FileDoesNotExistLocal = 11,
EHPMVersionControlError_FileAlreadyCheckedOutByYou = 12,
EHPMVersionControlError_CouldNotWriteFileLocal = 13,
EHPMVersionControlError_FileDeleted = 14,
EHPMVersionControlError_FileNotDeleted = 15,
EHPMVersionControlError_CheckedOutSkipped = 16,
EHPMVersionControlError_VersionDoesNotExtist = 17,
EHPMVersionControlError_NoVersionsWouldRemain = 18,
EHPMVersionControlError_FileIsAlreadyVersion = 19,
EHPMVersionControlError_CouldNotReadFileLocal = 20,
EHPMVersionControlError_Success_FileUnchanged = 21,
EHPMVersionControlError_FileAreadyDeleted = 22,
};
Values
EHPMVersionControlError_NewVersionOfSDKRequired
The meta data type did not exist when this SDK was created. Upgrade to a newer version of the SDK to be able to use this format.
EHPMVersionControlError_Success
The operation completed successfully.
EHPMVersionControlError_Other
An unspecified error occurred.
EHPMVersionControlError_InternalError
An internal error occurred.
EHPMVersionControlError_FileAlreadyExists
The file already exists.
EHPMVersionControlError_Checksum
The file failed checksum check.
EHPMVersionControlError_DiskFull
The disk is full.
EHPMVersionControlError_FileDoesNotExist
The file does not exist.
EHPMVersionControlError_InvalidVersion
The version specified was invalid.
EHPMVersionControlError_FileAlreadyCheckedOut
The file was already checked out.
EHPMVersionControlError_AccessDenied
Access to the file was denied.
EHPMVersionControlError_FileDoesNotExistLocal
The file does not exist locally.
EHPMVersionControlError_FileAlreadyCheckedOutByYou
The file is already checked out by you.
EHPMVersionControlError_CouldNotWriteFileLocal
The file could not be written locally.
EHPMVersionControlError_FileDeleted
The file is deleted.
EHPMVersionControlError_FileNotDeleted
The file is not deleted.
EHPMVersionControlError_CheckedOutSkipped
The checkout of the file was skipped.
EHPMVersionControlError_VersionDoesNotExtist
The version does not exist.
EHPMVersionControlError_NoVersionsWouldRemain
No version would remain if the current was deleted.
EHPMVersionControlError_FileIsAlreadyVersion
The file is already the version specified.
EHPMVersionControlError_CouldNotReadFileLocal
The file could not be read locally.
EHPMVersionControlError_Success_FileUnchanged
The operation completed successfully, but the file was unchanged and no operation was performed.
EHPMVersionControlError_FileAreadyDeleted
The file was already deleted.
See Also
HPMChangeCallbackData_VersionControlErrorResponse, VersionControlErrorToStr
HPMVersionControlMetaDataEntry
Specifies a meta data entry used in HPMVersionControlCallbackInfo::m_pMetaDataEntries.
struct HPMVersionControlMetaDataEntry {
HPMUInt32 m_Type;
const HPMChar * m_pName;
const HPMChar * m_pData;
} HPMVersionControlMetaDataEntry;
Members
m_Type
The type of meta data entry. Can be one of EHPMVersionControlMetaDataType.
m_pName
The name of the meta data entry.
m_pData
The data of the meta data entry. All data is expressed as a string even if the data type is integer of float.
See Also
HPMVersionControlFileList
Used to specify a list of files.
struct HPMVersionControlFileList {
HPMUInt32 m_nFiles;
const HPMString * m_pFiles;
} HPMVersionControlFileList;
Members
m_nFiles
The number of files.
m_pFiles
Pointer to a list of strings that specify the files.
See Also
VersionControlSyncFiles, VersionControlCheckOutFiles, VersionControlGetAccessRights, VersionControlSetAccessRights
HPMVersionControlFileHistoryEntry
Used to specify a history entry for a file or directory.
struct HPMVersionControlFileHistoryEntry {
HPMUInt64 m_FileAttributes;
HPMUInt64 m_Version;
HPMUInt64 m_Revision;
HPMUInt32 m_Action;
HPMUInt32 m_ActionInfoID;
HPMUInt64 m_Date;
HPMMD5Checksum m_Checksum;
const HPMChar * m_pFileName;
const HPMChar * m_pComment;
const HPMChar * m_pUser;
const HPMChar * m_pActionInfo;
const HPMChar * m_pActionInfoArg;
HPMUInt32 m_nMetaDataEntries;
const HPMVersionControlMetaDataEntry * m_pMetaDataEntries;
} HPMVersionControlFileHistoryEntry;
Members
m_FileAttributes
File attributes for the file history entry. Can be any combination of EHPMVersionControlFileAttributesFlag.
m_Version
The version for the file history entry.
m_Revision
The revision for the file history entry.
m_Action
The action for the file history entry. Can be one of EHPMVersionControlVersionAction.
m_ActionInfoID
The ID of action information for this file history entry. Can be one of EHPMVersionControlVersionActionInfo.
m_Date
The date of the change for the file history entry. Expressed as the number of microseconds since 1970 UTC.
m_Checksum
The checksum for the file history entry.
m_pFileName
The file name specified for the file history entry.
m_pComment
The comment specified for the file history entry.
m_pUser
The user that changed the file.
m_pActionInfo
A string describing the action for this history entry.
m_pActionInfoArg
If HPMVersionControlFileHistoryEntry::m_ActionInfoID is set to EHPMVersionControlVersionActionInfo_Rollback // this is the version number of the rollback. If HPMVersionControlFileHistoryEntry::m_ActionInfoID is set to EHPMVersionControlVersionActionInfo_Legacy // this is set to the legacy action info string.
m_nMetaDataEntries
The number of meta data entries associated with this file.
m_pMetaDataEntries
Pointer to a list of meta data entries associated with this file. See HPMVersionControlMetaDataEntry.
See Also
HPMVersionControlFileHistory, EHPMVersionControlVersionAction, HPMVersionControlMetaDataEntry, EHPMVersionControlFileAttributesFlag
HPMVersionControlFileHistory
Used to specify history for a file or directory.
struct HPMVersionControlFileHistory {
HPMUInt32 m_nHistoryEntries;
const HPMVersionControlFileHistoryEntry * m_pHistoryEntries;
} HPMVersionControlFileHistory;
Members
m_nHistoryEntries
The number of history entries for the file.
m_pHistoryEntries
Pointer to a list of HPMVersionControlFileHistoryEntry specifying the history entries for the file.
See Also
VersionControlGetFileHistory, HPMVersionControlFileHistoryEntry
HPMVersionControlAccessRight
Used to specify a access right in a list of access rights.
struct HPMVersionControlAccessRight {
HPMUniqueID m_Object;
HPMUInt32 m_Type;
HPMUInt32 m_GrantFlags;
HPMUInt32 m_RejectFlags;
} HPMVersionControlAccessRight;
Members
m_Object
Specifies a unique identifier pointing to a resource or a project that are to have rights granted or rejected. This obejct can also be one or EHPMVersionControlSpecialAccessRightObject to specify access for special groups of users.
m_Type
The type of resource to have rights granted or rejected. Can be one of EHPMResourceGroupingType.
m_GrantFlags
The access rights to grant to the object. Can be any combination of EHPMVersionControlAccessRightFlag.
m_RejectFlags
The access rights to reject to the object. Can be any combination of EHPMVersionControlAccessRightFlag.
Comments
The access flags are granted and then rejected, so if an object have their right both granted and rejected then it's the rejected rights that are applied.
See Also
EHPMVersionControlAccessRightFlag, EHPMVersionControlSpecialAccessRightObject
HPMVersionControlAccessRights
Used to specify a access rights for a file or directory.
struct HPMVersionControlAccessRights {
HPMInt32 m_bInherit;
HPMInt32 m_bUseInheritedRights;
HPMUInt32 m_nAccessRights;
const HPMVersionControlAccessRight * m_pAccessRights;
HPMUInt32 m_nInheritedAccessRights;
const HPMVersionControlAccessRight * m_pInheritedAccessRights;
} HPMVersionControlAccessRights;
Members
m_bInherit
Set to 1 if access rights should be inherited from the previous folder.
m_bUseInheritedRights
Set to 1 if the inherited access rights should be used.
m_nAccessRights
The number of access rights to set on the file.
m_pAccessRights
Pointer to a list of HPMVersionControlAccessRight specifying the access rights for the file.
m_nInheritedAccessRights
The number of inherited access rights to set on the file.
m_pInheritedAccessRights
Pointer to a list of HPMVersionControlAccessRight specifying the inherited access rights for the file.
Comments
The access flags are granted and then rejected, so if an object have their right both granted and rejected then it's the rejected rights that are applied.
See Also
VersionControlGetAccessRights, VersionControlGetAccessRights, HPMVersionControlAccessRight
HPMVersionControlFile
Information about a file used in HPMVersionControlFilesEnum and VersionControlEnumFiles.
struct HPMVersionControlFile {
HPMUInt64 m_FileAttributes;
HPMUInt64 m_FileID;
HPMUInt64 m_Version;
HPMUInt64 m_Revision;
HPMInt64 m_Size;
HPMUInt32 m_Action;
HPMUInt32 m_Flags;
HPMUInt32 m_EffectiveAccessRights;
HPMUInt64 m_Date;
HPMMD5Checksum m_Checksum;
const HPMChar * m_pFileName;
const HPMChar * m_pCheckedOutBy;
const HPMChar * m_pComment;
const HPMChar * m_pUser;
HPMUniqueID m_OriginalCreator;
HPMUInt32 m_nMetaDataEntries;
const HPMVersionControlMetaDataEntry * m_pMetaDataEntries;
} HPMVersionControlFile;
Members
m_FileAttributes
The attributes of the file. Will be any combination of EHPMVersionControlFileAttributesFlag.
m_FileID
The unique identifier of the file.
m_Version
The version of the file.
m_Revision
The revision of the file. Can be used to group operations. For example all files in one add operation will have the same revision.
m_Size
The size of the file. If the file is a directory this is the size of all files contained in the directory and its subdirectories.
m_Action
The latest action performed on the file. Can be one of EHPMVersionControlVersionAction.
m_Flags
Flags for the file. Can be combination any of EHPMVersionControlFileInfoFlag.
m_EffectiveAccessRights
Effective access rights for the file. Can be any combination of EHPMVersionControlAccessRightFlag.
m_Date
The date the file was last changed. Expressed as the number of micro seconds since 1970 UTC.
m_Checksum
The MD5 checksum of the data in the file.
m_pFileName
String specifying the name of the file. Not the full path.
m_pCheckedOutBy
String specifying the resource that has the file checked out.
m_pComment
String specifying the comment the user specified when doing the latest operation on the file.
m_pUser
String specifying the client that last changed the file.
m_OriginalCreator
The unique ID of the resource that created the file.
m_nMetaDataEntries
The number of meta data entries associated with this file.
m_pMetaDataEntries
Pointer to a list of meta data entries associated with this file. See HPMVersionControlMetaDataEntry.
See Also
HPMVersionControlFilesEnum, EHPMVersionControlFileAttributesFlag, EHPMVersionControlVersionAction, EHPMVersionControlFileInfoFlag, EHPMVersionControlAccessRightFlag, HPMVersionControlMetaDataEntry, VersionControlEnumFiles
HPMVersionControlFilesEnum
Used to return files enumerated with VersionControlEnumFiles.
struct HPMVersionControlFilesEnum {
HPMUInt32 m_nFiles;
const HPMVersionControlFile * m_pFiles;
} HPMVersionControlFilesEnum;
Members
m_nFiles
The number of files enumerated
m_pFiles
Pointer to a list of files enumerated. See HPMVersionControlFile.
See Also
VersionControlEnumFiles, HPMVersionControlFile
HPMVersionControlFileSpec
Used to specify a file specification with a path and meta data.
struct HPMVersionControlFileSpec {
const HPMChar * m_pPath;
HPMUInt32 m_nMetaDataEntries;
const HPMVersionControlMetaDataEntry * m_pMetaDataEntries;
} HPMVersionControlFileSpec;
Members
m_pPath
The path of the file on the server. Directories are specified with '/' rather than '\'.
m_nMetaDataEntries
The number of meta data entries associated with this file.
m_pMetaDataEntries
Pointer to a list of meta data entries associated with this file. See HPMVersionControlMetaDataEntry.
Comments
Normally when a file specification is specified to a function that change a file the metadata is merged with the old metadata. New entries are added, entries with the same name are updated, and entries with the same name with empty data are deleted.
See Also
HPMVersionControlLocalFilePair, HPMVersionControlCheckInFiles, HPMVersionControlRenameFiles, HPMVersionControlRevertFiles, HPMVersionControlDeleteFiles, HPMVersionControlRestoreDeletedFiles HPMVersionControlMetaDataEntry
HPMVersionControlLocalFilePair
Used to specify a file to be added to version control.
struct HPMVersionControlLocalFilePair {
HPMVersionControlFileSpec m_FileSpec;
const HPMChar * m_pLocalPath;
HPMUInt32 m_nFileData;
const HPMUInt8 * m_pFileData;
} HPMVersionControlLocalFilePair;
Members
m_FileSpec
The file spec specifying the file on the server and the metadata to be associated with the file. See HPMVersionControlFileSpec.
m_pLocalPath
The local path to the file to add.
m_nFileData
You can use this member together with m_pFileData to specify the file data directly from memory if you don't want to point to a file in the file system. m_pLocalPath will be ignored.
m_pFileData
You can use this member together with m_nFileData to specify the file data directly from memory if you don't want to point to a file in the file system. m_pLocalPath will be ignored.
See Also
HPMVersionControlAddFiles, HPMVersionControlFileSpec
HPMVersionControlAddFiles
Used to specify parameters to VersionControlAddFiles.
struct HPMVersionControlAddFiles {
HPMUInt32 m_nFilesToAdd;
const HPMVersionControlLocalFilePair * m_pFilesToAdd;
const HPMChar * m_pComment;
HPMInt32 m_bDeleteSourceFiles;
HPMUInt32 m_nExtraData;
const HPMUInt8 * m_pExtraData;
} HPMVersionControlAddFiles;
Members
m_nFilesToAdd
The number of files to add.
m_pFilesToAdd
Pointer to a list of file pairs to add. See HPMVersionControlLocalFilePair.
m_pComment
Pointer to a string specifying the comment for the operation.
m_bDeleteSourceFiles
Set to 1 to delete the local files after the operation has finished, 0 otherwise.
m_nExtraData
The number of extra bytes to send with the operation. See comments section.
m_pExtraData
Pointer to a buffer of extra bytes to send with the operation. See comments section.
Comments
This function lets you send a number of extra bytes that can be anything you like. These bytes are later received in the change callback data HPMChangeCallbackData_VersionControlAddFilesResponse.
See Also
VersionControlAddFiles, HPMVersionControlLocalFilePair, HPMChangeCallbackData_VersionControlAddFilesResponse
HPMVersionControlCreateDirectories
Used to specify parameters to VersionControlCreateDirectories.
struct HPMVersionControlCreateDirectories {
HPMUInt32 m_nFiles;
const HPMVersionControlFileSpec * m_pFiles;
const HPMChar * m_pComment;
HPMUInt32 m_nExtraData;
const HPMUInt8 * m_pExtraData;
} HPMVersionControlCreateDirectories;
Members
m_nFiles
The number of directories to create.
m_pFiles
Pointer to a list of directories to create.
m_pComment
Pointer to a string specifying the comment for the operation.
m_nExtraData
The number of extra bytes to send with the operation. See comments section.
m_pExtraData
Pointer to a buffer of extra bytes to send with the operation. See comments section.
Comments
This function lets you send a number of extra bytes that can be anything you like. These bytes are later received in the change callback data HPMChangeCallbackData_VersionControlAddFilesResponse.
See Also
VersionControlCreateDirectories, HPMVersionControlFileSpec, HPMChangeCallbackData_VersionControlAddFilesResponse
HPMVersionControlCheckInFiles
Used to specify parameters to VersionControlCheckInFiles.
struct HPMVersionControlCheckInFiles {
HPMUInt32 m_nFiles;
const HPMVersionControlFileSpec * m_pFiles;
const HPMChar * m_pComment;
HPMInt32 m_bRecursive;
HPMInt32 m_bKeepCheckedOut;
HPMInt32 m_bKeepUnchangedCheckedOut;
HPMInt32 m_bDeleteSourceFiles;
HPMUInt32 m_nExtraData;
const HPMUInt8 * m_pExtraData;
} HPMVersionControlCheckInFiles;
Members
m_nFiles
The number of files to check in.
m_pFiles
Pointer to a list of files to check in.
m_pComment
Pointer to a string specifying the comment for the operation.
m_bRecursive
Set to 1 if the files should be checked in recursively, 0 otherwise.
m_bKeepCheckedOut
Set to 1 if the files should be kept checked out, 0 otherwise.
m_bKeepUnchangedCheckedOut
Set to 1 if files that are unchanged should be kept checked out, 0 otherwise.
m_bDeleteSourceFiles
Set to 1 to delete the local files after the operation has finished, 0 otherwise.
m_nExtraData
The number of extra bytes to send with the operation. See comments section.
m_pExtraData
Pointer to a buffer of extra bytes to send with the operation. See comments section.
Comments
This function lets you send a number of extra bytes that can be anything you like. These bytes are later received in the change callback data HPMChangeCallbackData_VersionControlCheckInFilesResponse.
See Also
VersionControlCheckInFiles, HPMVersionControlFileSpec, HPMChangeCallbackData_VersionControlCheckInFilesResponse
HPMVersionControlRenameFiles
Used to specify parameters to VersionControlRenameFiles.
struct HPMVersionControlRenameFiles {
HPMUInt32 m_nFiles;
const HPMVersionControlFileSpec * m_pFiles;
const HPMChar * m_pComment;
const HPMChar * m_pRenameTo;
} HPMVersionControlRenameFiles;
Members
m_nFiles
The number of files to rename.
m_pFiles
Pointer to a list of HPMVersionControlFileSpec, specifying the files to rename.
m_pComment
Pointer to a string specifying the comment for the operation.
m_pRenameTo
Pointer to a string specifying the path to rename the files to. See comments section.
Comments
This operation is able to rename and move files and directories. If several files are specified the operation will move the files to a new location. The m_pRenameTo parameter will specify a directory to move the files into. If only one file is specified this operation will rename or move this single file and the m_pRenameTo parameter will specify a full path.
See Also
VersionControlRenameFiles, HPMVersionControlFileSpec
HPMVersionControlRevertFiles
Used to specify parameters to VersionControlRevertFiles.
struct HPMVersionControlRevertFiles {
HPMUInt32 m_nFiles;
const HPMString * m_pFiles;
HPMInt32 m_bRecursive;
HPMInt32 m_bReplaceLocally;
HPMInt32 m_bForceRevert;
} HPMVersionControlRevertFiles;
Members
m_nFiles
The number of files to revert.
m_pFiles
Pointer to a list of strings specifying the files to revert.
m_bRecursive
Set to 1 to revert files recursively, 0 otherwise.
m_bReplaceLocally
Set to 1 to replace files locally when reverting, 0 otherwise.
m_bForceRevert
Set to 1 to force revert files locally when reverting, 0 otherwise.
See Also
VersionControlRevertFiles, HPMString
HPMVersionControlDeleteFiles
Used to specify parameters to VersionControlDeleteFiles.
struct HPMVersionControlDeleteFiles {
HPMUInt32 m_nFiles;
const HPMVersionControlFileSpec * m_pFiles;
const HPMChar * m_pComment;
HPMInt32 m_bPermanent;
HPMInt32 m_bDeleteLocally;
} HPMVersionControlDeleteFiles;
Members
m_nFiles
The number of files to delete.
m_pFiles
Pointer to a list of files to delete.
m_pComment
Pointer to a string specifying the comment for the operation.
m_bPermanent
Set to 1 to permanently delete the files, 0 otherwise. When files are deleted permanently you are not able to later revert them.
m_bDeleteLocally
Set to 1 to delete the files locally, 0 otherwise.
See Also
VersionControlDeleteFiles, HPMVersionControlFileSpec
HPMVersionControlRestoreDeletedFiles
Used to specify parameters to VersionControlRestoreDeletedFiles.
struct HPMVersionControlRestoreDeletedFiles {
HPMUInt32 m_nFiles;
const HPMVersionControlFileSpec * m_pFiles;
const HPMChar * m_pComment;
} HPMVersionControlRestoreDeletedFiles;
Members
m_nFiles
The number of files to restore.
m_pFiles
Pointer to a list of HPMVersionControlFileSpec specifying the files to restore.
m_pComment
Pointer to a string specifying the comment for the operation.
See Also
VersionControlRestoreDeletedFiles, HPMVersionControlFileSpec
HPMVersionControlDeleteVersions
Used to specify parameters to VersionControlDeleteVersions.
struct HPMVersionControlDeleteVersions {
const HPMChar * m_pPath;
HPMUInt32 m_nVersionsToDelete;
const HPMUInt64 * m_pVersionsToDelete;
} HPMVersionControlDeleteVersions;
Members
m_pPath
Pointer to a string specifying the path of the file to delete versions on.
m_nVersionsToDelete
The number of versions to delete.
m_pVersionsToDelete
Pointer to a list of versions to delete.
See Also
HPMVersionControlRollbackFile
Used to specify parameters to VersionControlRollbackFile.
struct HPMVersionControlRollbackFile {
const HPMChar * m_pPath;
const HPMChar * m_pComment;
HPMUInt64 m_FromVersion;
} HPMVersionControlRollbackFile;
Members
m_pPath
Pointer to a string specifying the path of the file to roll back.
m_pComment
Pointer to a string specifying the comment for the operation.
m_FromVersion
Specifies the version that the file should be reverted to.
See Also
HPMVersionControlCallbackInfo
Information sent to the version control callback.
struct HPMVersionControlCallbackInfo {
HPMUInt32 m_Operation;
HPMUInt32 m_FileAttributes;
HPMUInt64 m_Date;
const HPMChar * m_pFileName;
const HPMChar * m_pResource;
const HPMChar * m_pResourceComment;
const HPMChar * m_pLocalTemporaryFileName;
HPMUInt32 m_nMetaDataEntries;
const HPMVersionControlMetaDataEntry * m_pMetaDataEntries;
} HPMVersionControlCallbackInfo;
Members
m_Operation
The operation performed that prompted the callback. Can by one of EHPMVersionControlCallbackOperation.
m_FileAttributes
The file attributes of the file in the callback. Can be any combination of EHPMVersionControlFileAttributesFlag.
m_Date
The date of the file in the callback. Expressed as micro seconds since 1970 UTC.
m_pFileName
The file name of the file in the callback.
m_pResource
The resource that performed the operation that prompted the callback.
m_pResourceComment
The comment specified by the resource that performed the operation that prompted the callback.
m_pLocalTemporaryFileName
A filename on the local hard drive where the file data of the file in the callback can be found. When calling m_pChangeDataCallback this file name specifies where the modified file can be found if EHPMVersionControlCallbackChanged_FileContents was specified.
m_nMetaDataEntries
The number of meta data entries associated with this file.
m_pMetaDataEntries
Pointer to a list of meta data entries associated with this file. See HPMVersionControlMetaDataEntry.
See Also
EHPMVersionControlCallbackOperation, EHPMVersionControlFileAttributesFlag, HPMVersionControlMetaDataEntry, HPMVersionControlChangeDataCallback HPMVersionControlCallback
HPMVersionControlFileInfo
Info returned from VersionControlUtilFileIDToFileInfo.
struct HPMVersionControlFileInfo {
HPMString m_Path;
HPMInt64 m_Size;
HPMInt64 m_Version;
HPMInt32 m_ImageWidth;
HPMInt32 m_ImageHeight;
} HPMVersionControlFileInfo;
Members
m_Path
The path to the version control file.
m_Size
The size of the file in bytes. If the file is a directory this is the size of all files contained in the directory and its subdirectories.
m_Version
The version of the file.
m_ImageWidth
If the file is an image, set to the width of the image.
m_ImageHeight
If the file is an image, set to the height of the image.
See Also
VersionControlUtilFileIDToFileInfo
HPMVersionControlChangeDataCallback
Callback used to notify the SDK about what was changed from a version control callback.
HPMError HPMVersionControlChangeDataCallback (
    const HPMVersionControlCallbackInfo * _pOldData,
    const HPMVersionControlCallbackInfo * _pNewData,
    HPMUInt32 _ChangedProperties
    );
Parameters
_pOldData
[in] The old callback info sent to the change callback function.
_pNewData
[in] The new callback info to set on the changed file.
_ChangedProperties
[in] The properties that was changed. Can be any of EHPMVersionControlCallbackChanged.
Return Value
Returns an error code. See EHPMError.
See Also
HPMVersionControlCallbackInfo, EHPMVersionControlCallbackChanged
HPMVersionControlCallback
Definition of the callback function called when a file operation in the version control is performed on the server.
HPMInt32 HPMVersionControlCallback (
    void * _pContext,
    const HPMVersionControlCallbackInfo * _pCallback,
    HPMVersionControlChangeDataCallback _pChangeDataCallback
    );
Parameters
_pContext
[in] The user context specified when registering the callback.
_pCallback
[in] Information about this callback.
_pChangeDataCallback
[in] A pointer to a function that can be called from the callback to change any of the data associated with the file.
Return Value
Currently ignored. You should return 0.
See Also
HPMVersionControlCallbackInfo, VersionControlRegisterCallback, VersionControlUnregisterCallback
VersionControlRegisterCallback
Registers a version control callback.
HPMError VersionControlRegisterCallback (
    void * _pSession,
    HPMVersionControlCallback _pCallback,
    void * _pContext
    );
Parameters
_pSession
[in] A connected session. See SessionOpen.
_pCallback
[in] The callback to call when a version control operation is performed on the server.
_pContext
[in] The user context sent to HPMVersionControlCallbackInfo::m_pContext when the callback is called.
Return Value
Returns an error code. See EHPMError.
Comments
A callback is uniquely identified by the callback function and user context, thus you cannot specify the same callback and user context or the function will fail and EHPMError_CallbackAlreadyExists will be returned. Currently not all operations defined in EHPMVersionControlCallbackOperation is supported. Only operations that add files or change the contents of files will be sent to the callback. The callback is called from the SessionProcess function. Before closing the session you must make sure to call VersionControlUnregisterCallback for all callbacks.
See Also
HPMSdkFunctions, HPMVersionControlCallback VersionControlUnregisterCallback, HPMVersionControlCallbackInfo
VersionControlUnregisterCallback
Unregisters a version control callback.
HPMError VersionControlUnregisterCallback (
    void * _pSession,
    HPMVersionControlCallback _pCallback,
    void * _pContext
    );
Parameters
_pSession
[in] A connected session. See SessionOpen.
_pCallback
[in] The callback specified to VersionControlRegisterCallback.
_pContext
[in] The user context specified to VersionControlRegisterCallback.
Return Value
Returns an error code. See EHPMError.
See Also
HPMSdkFunctions, VersionControlRegisterCallback
VersionControlInit
Initializes the version control portion of the SDK.
HPMError VersionControlInit (
    void * _pSession,
    const HPMChar * _pLocalPath,
    HPMInt32 _bBlocking
    );
Parameters
_pSession
[in] A connected session. See SessionOpen.
_pLocalPath
[in] The local path where version control files should be stored. This directory will be used to store temporary files as well as the files in the repository.
_bBlocking
[in] Set to true if you want the function to block until a version of the file tree has been retrieved from the server.
Return Value
Returns an error code. See EHPMError.
Comments
You must call this function before using any of the version control functions that specify it's needed.
See Also
VersionControlErrorToStr
Converts a version control error to a string.
HPMError VersionControlErrorToStr (
    void * _pSession,
    HPMInt32 _ErrorCode,
    const HPMString * * _pRetError
    );
Parameters
_pSession
[in] A connected session. See SessionOpen.
_ErrorCode
[in] The error to get the description for. Must be one of EHPMVersionControlError.
_pRetError
[out] Pointer to a HPMString structure describing the error.
Return Value
Returns a null terminated string describing the error.
See Also
VersionControlEnumFiles
Enumerates files in the version control system.
HPMError VersionControlEnumFiles (
    void * _pSession,
    const HPMChar * _pPath,
    HPMInt32 _bBlock,
    const HPMVersionControlFilesEnum * * _pEnum
    );
Parameters
_pSession
[in] A connected session. See SessionOpen.
_pPath
[in] The path in the repository where you want to enum files.
_bBlock
[in] Set to true if you want the function to block until a version of the file tree has been retrieved from the server. See comments section.
_pEnum
[out] Pointer to a HPMVersionControlFilesEnum structure describing the enumerated files.
Return Value
Returns an error code. See EHPMError. If you don't specify that the function should block it might return EHPMError_DataNotYetAvailable and you should wait until the EHPMChangeCallbackOperation_VersionControlFileInfoChanged callback is returned before calling the function again.
Comments
You must call VersionControlInit before using this function or the function will fail and return EHPMError_FunctionalityNotInitialized.
See Also
HPMSdkFunctions, VersionControlInit, HPMVersionControlFilesEnum
VersionControlFileExists
Checks if a file exists in the version control system.
HPMError VersionControlFileExists (
    void * _pSession,
    const HPMChar * _pPath,
    HPMInt32 _bBlock,
    HPMInt32 * _pExists
    );
Parameters
_pSession
[in] A connected session. See SessionOpen.
_pPath
[in] The path in the repository that you want to check if it exists.
_bBlock
[in] Set to true if you want the function to block until a version of the file tree has been retrieved from the server. See comments section.
_pExists
[out] On return is set to 1 if file exists.
Return Value
Returns an error code. See EHPMError. If you don't specify that the function should block it might return EHPMError_DataNotYetAvailable and you should wait until the EHPMChangeCallbackOperation_VersionControlFileInfoChanged callback is returned before calling the function again.
Comments
You must call VersionControlInit before using this function or the function will fail and return EHPMError_FunctionalityNotInitialized.
See Also
HPMSdkFunctions, VersionControlInit
VersionControlOperationPending
Checks if there is a pending command in the version control system.
HPMError VersionControlOperationPending (
    void * _pSession,
    HPMInt32 * _pPending
    );
Parameters
_pSession
[in] A connected session. See SessionOpen.
_pPending
[out] On return is set to 1 if there is a pending.
Return Value
Returns an error code. See EHPMError.
Comments
You must call VersionControlInit before using this function or the function will fail and return EHPMError_FunctionalityNotInitialized.
See Also
HPMSdkFunctions, VersionControlInit
VersionControlGetFileInfo
Get information about a file in the version control system.
HPMError VersionControlGetFileInfo (
    void * _pSession,
    const HPMChar * _pPath,
    HPMInt32 _bBlock,
    const HPMVersionControlFile * * _pFileInfo
    );
Parameters
_pSession
[in] A connected session. See SessionOpen.
_pPath
[in] The path in the repository to the file or directory to get information about.
_bBlock
[in] Set to true if you want the function to block until a version of the file tree has been retrieved from the server. See comments section.
_pFileInfo
[out] Pointer to a HPMVersionControlFile structure describing the file information.
Return Value
Returns an error code. See EHPMError. If you don't specify that the function should block it might return EHPMError_DataNotYetAvailable and you should wait until the EHPMChangeCallbackOperation_VersionControlFileInfoChanged callback is returned before calling the function again.
Comments
You must call VersionControlInit before using this function or the function will fail and return EHPMError_FunctionalityNotInitialized.
See Also
HPMSdkFunctions, VersionControlInit, HPMVersionControlFile
VersionControlGetFileHistory
Gets file history for a file in the version control system.
HPMError VersionControlGetFileHistory (
    void * _pSession,
    const HPMChar * _pPath,
    HPMInt32 _bBlock,
    const HPMVersionControlFileHistory * * _pFileHistory
    );
Parameters
_pSession
[in] A connected session. See SessionOpen.
_pPath
[in] The path of the file to get file history for.
_bBlock
[in] Set to 1 to block until the file history has been received from the server. See Return Value section.
_pFileHistory
[out] Pointer to a pointer of a HPMVersionControlFileHistory object, representing the returned data.
Return Value
Returns an error code. See EHPMError. If you don't specify that the function should block it might return EHPMError_DataNotYetAvailable and you should wait until the EHPMChangeCallbackOperation_VersionControlGetFileHistoryResponse callback is called before calling the function again. If the server denied access to reading the file history the function will return EHPMError_AccessDenied.
Comments
The returned object must be freed with ObjectFree or a memory leak will result. You must call VersionControlInit before using this function or the function will fail and return EHPMError_FunctionalityNotInitialized.
See Also
HPMSdkFunctions, VersionControlInit, HPMVersionControlFileHistory
VersionControlGetAccessRights
Gets access rights for files in the version control system.
HPMError VersionControlGetAccessRights (
    void * _pSession,
    const HPMChar * _pPath,
    HPMInt32 _bBlock,
    const HPMVersionControlAccessRights * * _pAccessRights
    );
Parameters
_pSession
[in] A connected session. See SessionOpen.
_pPath
[in] The path of the file to get access rights for.
_bBlock
[in] Set to 1 to block until the access rights has been received from the server. See Return Value section.
_pAccessRights
[out] Pointer to a pointer of a HPMVersionControlAccessRights object, representing the returned data.
Return Value
Returns an error code. See EHPMError. If you don't specify that the function should block it might return EHPMError_DataNotYetAvailable and you should wait until the EHPMChangeCallbackOperation_VersionControlGetAccessRightsResponse callback is called before calling the function again. If the server denied access to reading the access rights the function will return EHPMError_AccessDenied.
Comments
The returned object must be freed with ObjectFree or a memory leak will result. You must call VersionControlInit before using this function or the function will fail and return EHPMError_FunctionalityNotInitialized.
See Also
HPMSdkFunctions, VersionControlInit, HPMVersionControlFileList HPMVersionControlAccessRights, VersionControlSetAccessRights
VersionControlCreateDirectories
Creates directories in the version control system.
HPMError VersionControlCreateDirectories (
    void * _pSession,
    const HPMVersionControlCreateDirectories * _pFiles,
    const HPMChangeCallbackData_VersionControlAddFilesResponse * * _pResult
    );
Parameters
_pSession
[in] A connected session. See SessionOpen.
_pFiles
[in] Pointer to a HPMVersionControlCreateDirectories structure specifying the parameters for the add files operation.
_pResult
[out] Pointer to a pointer of a HPMChangeCallbackData_VersionControlAddFilesResponse object specifying the result of this operation. See comments section.
Return Value
Returns an error code. See EHPMError.
Comments
You must call VersionControlInit before using this function or the function will fail and return EHPMError_FunctionalityNotInitialized. If you specify a non-NULL pointer to the _pResult parameter this function will block and the result of the operation will be returned. The returned result must be freed with ObjectFree or a memory leak will result. If you specify a NULL pointer to the _pResult parameter this function will not block and when the operation is finished you will receive a EHPMChangeCallbackOperation_VersionControlAddFilesResponse callback. Only one operation can be in flight at the same time on the same client and you should wait until other operations are finished before calling this function. If another operation is in progress this function will return EHPMError_OperationAlreadyInProgress. The directories are automatically committed after creation.
See Also
ObjectFree, HPMSdkFunctions, VersionControlInit, HPMVersionControlCreateDirectories, HPMChangeCallbackData_VersionControlAddFilesResponse
VersionControlAddFiles
Adds files to the version control system.
HPMError VersionControlAddFiles (
    void * _pSession,
    const HPMVersionControlAddFiles * _pFiles,
    const HPMChangeCallbackData_VersionControlAddFilesResponse * * _pResult
    );
Parameters
_pSession
[in] A connected session. See SessionOpen.
_pFiles
[in] Pointer to a HPMVersionControlAddFiles structure specifying the parameters for the add files operation.
_pResult
[out] Pointer to a pointer of a HPMChangeCallbackData_VersionControlAddFilesResponse object specifying the result of this operation. See comments section.
Return Value
Returns an error code. See EHPMError.
Comments
You must call VersionControlInit before using this function or the function will fail and return EHPMError_FunctionalityNotInitialized. If you specify a non-NULL pointer to the _pResult parameter this function will block and the result of the operation will be returned. The returned result must be freed with ObjectFree or a memory leak will result. If you specify a NULL pointer to the _pResult parameter this function will not block and when the operation is finished you will receive a EHPMChangeCallbackOperation_VersionControlAddFilesResponse callback. Only one operation can be in flight at the same time on the same client and you should wait until other operations are finished before calling this function. If another operation is in progress this function will return EHPMError_OperationAlreadyInProgress. The files are automatically committed after creation.
See Also
ObjectFree, HPMSdkFunctions, VersionControlInit, HPMVersionControlAddFiles, HPMChangeCallbackData_VersionControlAddFilesResponse
VersionControlSyncFiles
Syncronizes files in the version control system to the local file system path specified in VersionControlInit.
HPMError VersionControlSyncFiles (
    void * _pSession,
    const HPMVersionControlFileList * _pFiles,
    HPMInt32 _Version,
    const HPMChangeCallbackData_VersionControlSyncFilesResponse * * _pResult
    );
Parameters
_pSession
[in] A connected session. See SessionOpen.
_pFiles
[in] Pointer to a HPMVersionControlFileList structure specifying the parameters for the sync files operation.
_Version
[in] The version of the file to download. If you want the latest version set this parameter to -1. If this parameter is not -1 the file will be downloaded to the temp directory.
_pResult
[out] Pointer to a pointer of a HPMChangeCallbackData_VersionControlSyncFilesResponse object specifying the result of this operation. See comments section.
Return Value
Returns an error code. See EHPMError.
Comments
You must call VersionControlInit before using this function or the function will fail and return EHPMError_FunctionalityNotInitialized. If you specify a non-NULL pointer to the _pResult parameter this function will block and the result of the operation will be returned. The returned result must be freed with ObjectFree or a memory leak will result. If you specify a NULL pointer to the _pResult parameter this function will not block and when the operation is finished you will receive a EHPMChangeCallbackOperation_VersionControlSyncFilesResponse callback. Only one operation can be in flight at the same time on the same client and you should wait until other operations are finished before calling this function. If another operation is in progress this function will return EHPMError_OperationAlreadyInProgress.
See Also
ObjectFree, HPMSdkFunctions, VersionControlInit, HPMVersionControlFileList, HPMChangeCallbackData_VersionControlSyncFilesResponse
VersionControlCheckOutFiles
Checks out files in the version control system.
HPMError VersionControlCheckOutFiles (
    void * _pSession,
    const HPMVersionControlFileList * _pFiles,
    HPMInt32 _bRecursive,
    HPMInt32 _bAlwaysAskOverwrite,
    const HPMChangeCallbackData_VersionControlCheckOutFilesResponse * * _pResult
    );
Parameters
_pSession
[in] A connected session. See SessionOpen.
_pFiles
[in] Pointer to a HPMVersionControlFileList structure specifying the files to check out.
_bRecursive
[in] Set to 1 to specify that the check out operation should be recursive, 0 otherwise.
_bAlwaysAskOverwrite
[in] Set to 1 to get a HPMChangeCallbackData_VersionControlWarnCheckOutShouldSync notification even if the file is exactly the same as another file in the file history.
_pResult
[out] Pointer to a pointer of a HPMChangeCallbackData_VersionControlCheckOutFilesResponse object specifying the result of this operation. See comments section.
Return Value
Returns an error code. See EHPMError.
Comments
You must call VersionControlInit before using this function or the function will fail and return EHPMError_FunctionalityNotInitialized. If you specify a non-NULL pointer to the _pResult parameter this function will block and the result of the operation will be returned. The returned result must be freed with ObjectFree or a memory leak will result. If you specify a NULL pointer to the _pResult parameter this function will not block and when the operation is finished you will receive a EHPMChangeCallbackOperation_VersionControlCheckOutFilesResponse callback. Only one operation can be in flight at the same time on the same client and you should wait until other operations are finished before calling this function. If another operation is in progress this function will return EHPMError_OperationAlreadyInProgress.
See Also
ObjectFree, HPMSdkFunctions, VersionControlInit, HPMVersionControlFileList, HPMChangeCallbackData_VersionControlCheckOutFilesResponse
VersionControlCheckInFiles
Checks in files to the version control system.
HPMError VersionControlCheckInFiles (
    void * _pSession,
    const HPMVersionControlCheckInFiles * _pFiles,
    const HPMChangeCallbackData_VersionControlCheckInFilesResponse * * _pResult
    );
Parameters
_pSession
[in] A connected session. See SessionOpen.
_pFiles
[in] Pointer to a HPMVersionControlCheckInFiles structure specifying the parameters for the check in files operation.
_pResult
[out] Pointer to a pointer of a HPMChangeCallbackData_VersionControlCheckInFilesResponse object specifying the result of this operation. See comments section.
Return Value
Returns an error code. See EHPMError.
Comments
You must call VersionControlInit before using this function or the function will fail and return EHPMError_FunctionalityNotInitialized. If you specify a non-NULL pointer to the _pResult parameter this function will block and the result of the operation will be returned. The returned result must be freed with ObjectFree or a memory leak will result. If you specify a NULL pointer to the _pResult parameter this function will not block and when the operation is finished you will receive a EHPMChangeCallbackOperation_VersionControlCheckInFilesResponse callback. Only one operation can be in flight at the same time on the same client and you should wait until other operations are finished before calling this function. If another operation is in progress this function will return EHPMError_OperationAlreadyInProgress.
See Also
ObjectFree, HPMSdkFunctions, VersionControlInit, HPMVersionControlCheckInFiles, HPMChangeCallbackData_VersionControlCheckInFilesResponse
VersionControlRenameFiles
Renames files in the version control system.
HPMError VersionControlRenameFiles (
    void * _pSession,
    const HPMVersionControlRenameFiles * _pFiles,
    const HPMChangeCallbackData_VersionControlRenameResponse * * _pResult
    );
Parameters
_pSession
[in] A connected session. See SessionOpen.
_pFiles
[in] Pointer to a HPMVersionControlRenameFiles structure specifying the parameters for the rename files operation.
_pResult
[out] Pointer to a pointer of a HPMChangeCallbackData_VersionControlRenameResponse object specifying the result of this operation. See comments section.
Return Value
Returns an error code. See EHPMError.
Comments
You must call VersionControlInit before using this function or the function will fail and return EHPMError_FunctionalityNotInitialized. If you specify a non-NULL pointer to the _pResult parameter this function will block and the result of the operation will be returned. The returned result must be freed with ObjectFree or a memory leak will result. If you specify a NULL pointer to the _pResult parameter this function will not block and when the operation is finished you will receive a EHPMChangeCallbackOperation_VersionControlRenameResponse callback. Only one operation can be in flight at the same time on the same client and you should wait until other operations are finished before calling this function. If another operation is in progress this function will return EHPMError_OperationAlreadyInProgress.
See Also
ObjectFree, HPMSdkFunctions, VersionControlInit, HPMVersionControlRenameFiles, HPMChangeCallbackData_VersionControlRenameResponse
VersionControlRevertFiles
Reverts checked out files in the version control system.
HPMError VersionControlRevertFiles (
    void * _pSession,
    const HPMVersionControlRevertFiles * _pFiles,
    const HPMChangeCallbackData_VersionControlCheckInFilesResponse * * _pResult
    );
Parameters
_pSession
[in] A connected session. See SessionOpen.
_pFiles
[in] Pointer to a HPMVersionControlRevertFiles structure specifying the parameters for the revert files operation.
_pResult
[out] Pointer to a pointer of a HPMChangeCallbackData_VersionControlCheckInFilesResponse object specifying the result of this operation. See comments section.
Return Value
Returns an error code. See EHPMError.
Comments
You must call VersionControlInit before using this function or the function will fail and return EHPMError_FunctionalityNotInitialized. If you specify a non-NULL pointer to the _pResult parameter this function will block and the result of the operation will be returned. The returned result must be freed with ObjectFree or a memory leak will result. If you specify a NULL pointer to the _pResult parameter this function will not block and when the operation is finished you will receive a EHPMChangeCallbackOperation_VersionControlCheckInFilesResponse callback. Only one operation can be in flight at the same time on the same client and you should wait until other operations are finished before calling this function. If another operation is in progress this function will return EHPMError_OperationAlreadyInProgress.
See Also
ObjectFree, HPMSdkFunctions, VersionControlInit, HPMVersionControlRevertFiles, HPMChangeCallbackData_VersionControlCheckInFilesResponse
VersionControlDeleteFiles
Deletes files in the version control system.
HPMError VersionControlDeleteFiles (
    void * _pSession,
    const HPMVersionControlDeleteFiles * _pFiles,
    const HPMChangeCallbackData_VersionControlDeleteFilesResponse * * _pResult
    );
Parameters
_pSession
[in] A connected session. See SessionOpen.
_pFiles
[in] Pointer to a HPMVersionControlDeleteFiles structure specifying the parameters for the delete files operation.
_pResult
[out] Pointer to a pointer of a HPMChangeCallbackData_VersionControlDeleteFilesResponse object specifying the result of this operation. See comments section.
Return Value
Returns an error code. See EHPMError.
Comments
You must call VersionControlInit before using this function or the function will fail and return EHPMError_FunctionalityNotInitialized. If you specify a non-NULL pointer to the _pResult parameter this function will block and the result of the operation will be returned. The returned result must be freed with ObjectFree or a memory leak will result. If you specify a NULL pointer to the _pResult parameter this function will not block and when the operation is finished you will receive a EHPMChangeCallbackOperation_VersionControlDeleteFilesResponse callback. Only one operation can be in flight at the same time on the same client and you should wait until other operations are finished before calling this function. If another operation is in progress this function will return EHPMError_OperationAlreadyInProgress.
See Also
ObjectFree, HPMSdkFunctions, VersionControlInit, HPMVersionControlDeleteFiles, HPMChangeCallbackData_VersionControlDeleteFilesResponse
VersionControlRestoreDeletedFiles
Restores deleted files in the version control system.
HPMError VersionControlRestoreDeletedFiles (
    void * _pSession,
    const HPMVersionControlRestoreDeletedFiles * _pFiles,
    const HPMChangeCallbackData_VersionControlRestoreDeletedFilesResponse * * _pResult
    );
Parameters
_pSession
[in] A connected session. See SessionOpen.
_pFiles
[in] Pointer to a HPMVersionControlRestoreDeletedFiles structure specifying the parameters for the restore deleted files operation.
_pResult
[out] Pointer to a pointer of a HPMChangeCallbackData_VersionControlRestoreDeletedFilesResponse object specifying the result of this operation. See comments section.
Return Value
Returns an error code. See EHPMError.
Comments
You must call VersionControlInit before using this function or the function will fail and return EHPMError_FunctionalityNotInitialized. If you specify a non-NULL pointer to the _pResult parameter this function will block and the result of the operation will be returned. The returned result must be freed with ObjectFree or a memory leak will result. If you specify a NULL pointer to the _pResult parameter this function will not block and when the operation is finished you will receive a EHPMChangeCallbackOperation_VersionControlRestoreDeletedFilesResponse callback. Only one operation can be in flight at the same time on the same client and you should wait until other operations are finished before calling this function. If another operation is in progress this function will return EHPMError_OperationAlreadyInProgress.
See Also
ObjectFree, HPMSdkFunctions, VersionControlInit, HPMVersionControlRestoreDeletedFiles, HPMChangeCallbackData_VersionControlRestoreDeletedFilesResponse
VersionControlDeleteVersions
Deletes versions on a file in the version control system.
HPMError VersionControlDeleteVersions (
    void * _pSession,
    const HPMVersionControlDeleteVersions * _pFiles,
    const HPMChangeCallbackData_VersionControlDeleteVersionsResponse * * _pResult
    );
Parameters
_pSession
[in] A connected session. See SessionOpen.
_pFiles
[in] Pointer to a HPMVersionControlDeleteVersions structure specifying the parameters for the delete versions operation.
_pResult
[out] Pointer to a pointer of a HPMChangeCallbackData_VersionControlDeleteVersionsResponse object specifying the result of this operation. See comments section.
Return Value
Returns an error code. See EHPMError.
Comments
You must call VersionControlInit before using this function or the function will fail and return EHPMError_FunctionalityNotInitialized. If you specify a non-NULL pointer to the _pResult parameter this function will block and the result of the operation will be returned. The returned result must be freed with ObjectFree or a memory leak will result. If you specify a NULL pointer to the _pResult parameter this function will not block and when the operation is finished you will receive a EHPMChangeCallbackOperation_VersionControlDeleteVersionsResponse callback. Only one operation can be in flight at the same time on the same client and you should wait until other operations are finished before calling this function. If another operation is in progress this function will return EHPMError_OperationAlreadyInProgress.
See Also
ObjectFree, HPMSdkFunctions, VersionControlInit, HPMVersionControlDeleteVersions, HPMChangeCallbackData_VersionControlDeleteVersionsResponse
VersionControlRollbackFile
Roll backs a file to a previous version in the version control system.
HPMError VersionControlRollbackFile (
    void * _pSession,
    const HPMVersionControlRollbackFile * _pFiles,
    const HPMChangeCallbackData_VersionControlRollbackFileResponse * * _pResult
    );
Parameters
_pSession
[in] A connected session. See SessionOpen.
_pFiles
[in] Pointer to a HPMVersionControlRollbackFile structure specifying the parameters for the rollback file operation.
_pResult
[out] Pointer to a pointer of a HPMChangeCallbackData_VersionControlRollbackFileResponse object specifying the result of this operation. See comments section.
Return Value
Returns an error code. See EHPMError.
Comments
You must call VersionControlInit before using this function or the function will fail and return EHPMError_FunctionalityNotInitialized. If you specify a non-NULL pointer to the _pResult parameter this function will block and the result of the operation will be returned. The returned result must be freed with ObjectFree or a memory leak will result. If you specify a NULL pointer to the _pResult parameter this function will not block and when the operation is finished you will receive a EHPMChangeCallbackOperation_VersionControlRollbackFileResponse callback. Only one operation can be in flight at the same time on the same client and you should wait until other operations are finished before calling this function. If another operation is in progress this function will return EHPMError_OperationAlreadyInProgress.
See Also
ObjectFree, HPMSdkFunctions, VersionControlInit, HPMVersionControlRollbackFile, HPMChangeCallbackData_VersionControlRollbackFileResponse
VersionControlSetAccessRights
Sets access rights for files in the version control system.
HPMError VersionControlSetAccessRights (
    void * _pSession,
    const HPMVersionControlFileList * _pFiles,
    const HPMVersionControlAccessRights * _pAccessRights,
    HPMInt32 _bResetSubFiles,
    const HPMChangeCallbackData_VersionControlSetAccessRightsResponse * * _pResult
    );
Parameters
_pSession
[in] A connected session. See SessionOpen.
_pFiles
[in] Pointer to a HPMVersionControlFileList structure specifying the files to set access rights on.
_pAccessRights
[in] Pointer to a HPMVersionControlAccessRights structure specifying the access rights to set on the files.
_bResetSubFiles
[in] Set to 1 to reset the sub files and directories of the files specified in this operation to inherit the these access rights and remove any other access rights, 0 otherwise.
_pResult
[out] Pointer to a pointer of a HPMChangeCallbackData_VersionControlSetAccessRightsResponse object specifying the result of this operation. See comments section.
Return Value
Returns an error code. See EHPMError.
Comments
You must call VersionControlInit before using this function or the function will fail and return EHPMError_FunctionalityNotInitialized. If you specify a non-NULL pointer to the _pResult parameter this function will block and the result of the operation will be returned. The returned result must be freed with ObjectFree or a memory leak will result. If you specify a NULL pointer to the _pResult parameter this function will not block and when the operation is finished you will receive a EHPMChangeCallbackOperation_VersionControlSetAccessRightsResponse callback. Only one operation can be in flight at the same time on the same client and you should wait until other operations are finished before calling this function. If another operation is in progress this function will return EHPMError_OperationAlreadyInProgress.
See Also
ObjectFree, HPMSdkFunctions, VersionControlInit, HPMVersionControlFileList, HPMVersionControlAccessRights, VersionControlGetAccessRights, HPMChangeCallbackData_VersionControlSetAccessRightsResponse
VersionControlUtilPathToFileID
Converts a file path to a file id.
HPMError VersionControlUtilPathToFileID (
    void * _pSession,
    const HPMChar * _pPath,
    HPMUInt64 * _pFileID
    );
Parameters
_pSession
[in] A connected session. See SessionOpen.
_pPath
[in] The path to the file to get file id for.
_pFileID
[out] Pointer to a variable that will receive the file id for the file in the file path. Set to 0xffffffffffffffff if no file was found.
Return Value
Returns an error code. See EHPMError.
Comments
You must call VersionControlInit before using this function or the function will fail and return EHPMError_FunctionalityNotInitialized.
See Also
HPMSdkFunctions, VersionControlInit
VersionControlUtilFileIDToPath
Converts a file id to a file path.
HPMError VersionControlUtilFileIDToPath (
    void * _pSession,
    HPMUInt64 _FileID,
    const HPMString * * _pPath
    );
Parameters
_pSession
[in] A connected session. See SessionOpen.
_FileID
[in] The file id to get the path for.
_pPath
[out] Pointer to a pointer of a HPMString object, representing the returned data.
Return Value
Returns an error code. See EHPMError.
Comments
You must call VersionControlInit before using this function or the function will fail and return EHPMError_FunctionalityNotInitialized. The returned object must be freed with ObjectFree or a memory leak will result.
See Also
VersionControlUtilIsInitialized
Checks if the version control functionality is initialized.
HPMError VersionControlUtilIsInitialized (
    void * _pSession,
    HPMInt32 * _pIsInitialized
    );
Parameters
_pSession
[in] A connected session. See SessionOpen.
_pIsInitialized
[out] Pointer to a variable that will receive the version control initialized status. 1 if initialized, 0 otherwise.
Return Value
Returns an error code. See EHPMError.
See Also
HPMSdkFunctions , VersionControlInit
VersionControlSetLocalPath
Sets the local path where version control files are stored.
HPMError VersionControlSetLocalPath (
    void * _pSession,
    const HPMChar * _pLocalPath
    );
Parameters
_pSession
[in] A connected session. See SessionOpen.
_pLocalPath
[in] The local path where version control files should be stored. This directory will be used to store temporary files as well as the files in the repository.
Return Value
Returns an error code. See EHPMError.
See Also
VersionControlUtilResourceHasRights
Tests to see if a specified resource has a set of specific rights to a specified file in version control.
HPMError VersionControlUtilResourceHasRights (
    void * _pSession,
    const HPMChar * _pPath,
    HPMUniqueID _ResourceID,
    HPMUInt32 _Rights,
    HPMInt32 _bBlocking,
    HPMUInt32 * _Result
    );
Parameters
_pSession
[in] A connected session. See SessionOpen.
_pPath
[in] The path to the file you wish to check for permissions to.
_ResourceID
[in] The ID of the resource whose right you are checking
_Rights
[in] The access rights to test is the specified resource has to the file. Can be any combination of EHPMVersionControlAccessRightFlag.
_bBlocking
[in] Set to true if you want the function to block until a version of the file tree has been retrieved from the server.
_Result
[out] Pointer to a HPMUint32 to receive the result. Set to 0 if the user does not have the rights specified in _Rights, set to >0 if the user does have all the rights specified in _Rights.
Return Value
Returns an error code. See EHPMError.
See Also
VersionControlUtilFileIDToFileInfo
Gets file info from a file id.
HPMError VersionControlUtilFileIDToFileInfo (
    void * _pSession,
    HPMUInt64 _FileID,
    HPMVersionControlFileInfo const * * _pInfo
    );
Parameters
_pSession
[in] A connected session. See SessionOpen.
_FileID
[in] The file id to get the path for.
_pInfo
[out] Pointer to a pointer of a HPMString object, representing the returned data.
Return Value
Returns an error code. See EHPMError.
Comments
You must call VersionControlInit before using this function or the function will fail and return EHPMError_FunctionalityNotInitialized. The returned object must be freed with ObjectFree or a memory leak will result.
See Also
HPMSdkFunctions, HPMVersionControlFileInfo
EHPMDataHistoryEntryType
Data history entry type used for HPMDataHistoryEntry::m_EntryType
enum EHPMDataHistoryEntryType {
EHPMDataHistoryEntryType_NewVersionOfSDKRequired = 0,
EHPMDataHistoryEntryType_FieldCreated = 1,
EHPMDataHistoryEntryType_FieldChanged = 2,
EHPMDataHistoryEntryType_FieldDeleted = 3,
EHPMDataHistoryEntryType_TaskCreated = 4,
EHPMDataHistoryEntryType_Statistics_AbsoluteValue = 5,
EHPMDataHistoryEntryType_Statistics_RelativeValue = 6,
EHPMDataHistoryEntryType_TaskDeleted = 7,
EHPMDataHistoryEntryType_TaskMoved = 8,
EHPMDataHistoryEntryType_TaskRenameCustomColumn = 9,
EHPMDataHistoryEntryType_TaskProxyCreated = 10,
EHPMDataHistoryEntryType_TaskProxyDeleted = 11,
EHPMDataHistoryEntryType_TaskRestoredFromHistory = 12,
EHPMDataHistoryEntryType_ChatHistory = 13,
EHPMDataHistoryEntryType_TaskRenameBoardLane = 14,
EHPMDataHistoryEntryType_TaskRenameBoardColumn = 15,
EHPMDataHistoryEntryType_TaskBoardLaneChanged = 16,
EHPMDataHistoryEntryType_TaskBoardColumnChanged = 17,
EHPMDataHistoryEntryType_TaskBoardLaneDeleted = 18,
EHPMDataHistoryEntryType_TaskBoardColumnDeleted = 19,
EHPMDataHistoryEntryType_TaskBoardElementSettingsChanged = 20,
EHPMDataHistoryEntryType_TaskImportedFromExcel = 21,
EHPMDataHistoryEntryType_TaskImportedFromXml = 22,
};
Values
EHPMDataHistoryEntryType_NewVersionOfSDKRequired
The entry type did not exist when this SDK was created. Upgrade to a newer version of the SDK to be able to use this entry type.
EHPMDataHistoryEntryType_FieldCreated
The field was created.
EHPMDataHistoryEntryType_FieldChanged
The field was changed.
EHPMDataHistoryEntryType_FieldDeleted
The field was deleted.
EHPMDataHistoryEntryType_TaskCreated
A task was created.
EHPMDataHistoryEntryType_Statistics_AbsoluteValue
An absolute value sampled with the statistics module.
EHPMDataHistoryEntryType_Statistics_RelativeValue
An relative value sampled with the statistics module.
EHPMDataHistoryEntryType_TaskDeleted
A task was deleted.
EHPMDataHistoryEntryType_TaskMoved
A task was moved between projects.
EHPMDataHistoryEntryType_TaskRenameCustomColumn
Custom column data was renamed on a task.
EHPMDataHistoryEntryType_TaskProxyCreated
A proxy was created for a task.
EHPMDataHistoryEntryType_TaskProxyDeleted
A proxy was deleted for a task.
EHPMDataHistoryEntryType_TaskRestoredFromHistory
A task was restored from change history.
EHPMDataHistoryEntryType_ChatHistory
A chat entry was made.
EHPMDataHistoryEntryType_TaskRenameBoardLane
A lane task is committed to was renamed
EHPMDataHistoryEntryType_TaskRenameBoardColumn
A column task is committed to was renamed
EHPMDataHistoryEntryType_TaskBoardLaneChanged
Task was moved to another lane
EHPMDataHistoryEntryType_TaskBoardColumnChanged
Task was moved to another column
EHPMDataHistoryEntryType_TaskBoardLaneDeleted
Task was moved out of the board
EHPMDataHistoryEntryType_TaskBoardColumnDeleted
Task was moved out of the board
EHPMDataHistoryEntryType_TaskBoardElementSettingsChanged
Board's element settings were changed
EHPMDataHistoryEntryType_TaskImportedFromExcel
Task was imported from Excel
EHPMDataHistoryEntryType_TaskImportedFromXml
Task was imported from Xml
See Also
EHPMDataHistoryEntryKind
Data history entry kind used for HPMDataHistoryEntry::m_EntryKind
enum EHPMDataHistoryEntryKind {
EHPMDataHistoryEntryKind_NewVersionOfSDKRequired = 0,
EHPMDataHistoryEntryKind_Default = 1,
EHPMDataHistoryEntryKind_ProjectChangeHistory = 2,
};
Values
EHPMDataHistoryEntryKind_NewVersionOfSDKRequired
The entry kind did not exist when this SDK was created. Upgrade to a newer version of the SDK to be able to use this entry kind.
EHPMDataHistoryEntryKind_Default
Data history entry is default value.
EHPMDataHistoryEntryKind_ProjectChangeHistory
Data history entry is project change history.
See Also
EHPMDataHistoryClientOrigin
Data history client origin used for HPMDataHistoryEntry::m_ClientOrigin
enum EHPMDataHistoryClientOrigin {
EHPMDataHistoryClientOrigin_NewVersionOfSDKRequired = 0,
EHPMDataHistoryClientOrigin_None = 1,
EHPMDataHistoryClientOrigin_Unknown = 2,
EHPMDataHistoryClientOrigin_Default = 3,
EHPMDataHistoryClientOrigin_DefaultSDK = 4,
EHPMDataHistoryClientOrigin_Custom = 5,
EHPMDataHistoryClientOrigin_CustomSDK = 6,
EHPMDataHistoryClientOrigin_XMLImport = 7,
EHPMDataHistoryClientOrigin_ExcelImport = 8,
};
Values
EHPMDataHistoryClientOrigin_NewVersionOfSDKRequired
The entry type did not exist when this SDK was created. Upgrade to a newer version of the SDK to be able to use this entry type.
EHPMDataHistoryClientOrigin_None
Does not originate from client
EHPMDataHistoryClientOrigin_Unknown
Recorded when in old version where client version wasn't availaible
EHPMDataHistoryClientOrigin_Default
Normal non-specific client origin
EHPMDataHistoryClientOrigin_DefaultSDK
Normal non-specific SDK client origin
EHPMDataHistoryClientOrigin_Custom
Custom client origin
EHPMDataHistoryClientOrigin_CustomSDK
Custom SDK client origin
EHPMDataHistoryClientOrigin_XMLImport
XML import origin
EHPMDataHistoryClientOrigin_ExcelImport
Excel import origin
See Also
EHPMDataHistoryOrigin
Data history origin used for HPMDataHistoryEntry::m_Origin
enum EHPMDataHistoryOrigin {
EHPMDataHistoryOrigin_NewVersionOfSDKRequired = 0,
EHPMDataHistoryOrigin_None = 1,
EHPMDataHistoryOrigin_Unknown = 2,
EHPMDataHistoryOrigin_StatisticsSampling = 3,
EHPMDataHistoryOrigin_FixDatabaseErrors = 4,
EHPMDataHistoryOrigin_UpdateAllDurationDatabaseLoad = 5,
EHPMDataHistoryOrigin_UpdateTaskToLatestPipeline = 6,
EHPMDataHistoryOrigin_SetInitialFieldValues = 7,
EHPMDataHistoryOrigin_LinkTasksToMilestones = 8,
EHPMDataHistoryOrigin_ChangeDisposition = 9,
EHPMDataHistoryOrigin_CreateTask = 10,
EHPMDataHistoryOrigin_CreateProxy = 11,
EHPMDataHistoryOrigin_MoveTask = 12,
EHPMDataHistoryOrigin_DeleteTask = 13,
EHPMDataHistoryOrigin_UpdateSprintStatisticsMidnight = 14,
EHPMDataHistoryOrigin_UpdateSprintStatisticsDatabaseOnline = 15,
EHPMDataHistoryOrigin_ConvertDatabaseVersion = 16,
EHPMDataHistoryOrigin_DeleteResource = 17,
EHPMDataHistoryOrigin_DeleteShare = 18,
EHPMDataHistoryOrigin_RemoveResourceFromProject = 19,
EHPMDataHistoryOrigin_ChangeProjectArchivedStatus = 20,
EHPMDataHistoryOrigin_InvokeDispositionBug = 21,
EHPMDataHistoryOrigin_DeleteCustomColumn = 22,
EHPMDataHistoryOrigin_RenameCustomColumn = 23,
EHPMDataHistoryOrigin_FullCommentsCreated = 24,
EHPMDataHistoryOrigin_CommentCreated = 25,
EHPMDataHistoryOrigin_CommentDeleted = 26,
EHPMDataHistoryOrigin_ConvertProjectChangeHistory = 27,
EHPMDataHistoryOrigin_ProjectCreate = 28,
EHPMDataHistoryOrigin_ProjectChange = 29,
EHPMDataHistoryOrigin_ProjectSetCustomColumns = 30,
EHPMDataHistoryOrigin_ProjectAddCustomColumn = 31,
EHPMDataHistoryOrigin_ProjectOpenQA = 32,
EHPMDataHistoryOrigin_ProjectSetWorkflow = 33,
EHPMDataHistoryOrigin_ProjectEnableWorkflowsInMainProjectAndBacklog = 34,
EHPMDataHistoryOrigin_ProjectCreateWorkflow = 35,
EHPMDataHistoryOrigin_ProjectChangeWorkflow = 36,
EHPMDataHistoryOrigin_ProjectDeleteWorkflow = 37,
EHPMDataHistoryOrigin_AddResourceToProject = 38,
EHPMDataHistoryOrigin_CreateShare = 39,
EHPMDataHistoryOrigin_CreateResource = 40,
EHPMDataHistoryOrigin_ProjectOpenBacklog = 41,
EHPMDataHistoryOrigin_ProjectSetDefaultActivatedColumns = 42,
EHPMDataHistoryOrigin_CommandChangeField_Comment = 43,
EHPMDataHistoryOrigin_CommandChangeField_Description = 44,
EHPMDataHistoryOrigin_CommandChangeField_TimeZones = 45,
EHPMDataHistoryOrigin_CommandChangeField_Completed = 46,
EHPMDataHistoryOrigin_CommandChangeField_Resources = 47,
EHPMDataHistoryOrigin_CommandChangeField_Color = 48,
EHPMDataHistoryOrigin_CommandChangeField_Unlocked = 49,
EHPMDataHistoryOrigin_CommandChangeField_BudgetedWork = 50,
EHPMDataHistoryOrigin_CommandChangeField_CompletedPercent = 51,
EHPMDataHistoryOrigin_CommandChangeField_LinkedToMilestones = 52,
EHPMDataHistoryOrigin_CommandChangeField_AttachedDocuments = 53,
EHPMDataHistoryOrigin_CommandChangeField_DelegatedTo = 54,
EHPMDataHistoryOrigin_CommandChangeField_OriginallyCreatedBy = 55,
EHPMDataHistoryOrigin_CommandChangeField_CustomColumnData = 56,
EHPMDataHistoryOrigin_CommandChangeField_VisibleTo = 57,
EHPMDataHistoryOrigin_CommandChangeField_DurationHours = 58,
EHPMDataHistoryOrigin_CommandChangeField_HourOffset = 59,
EHPMDataHistoryOrigin_CommandChangeField_Risk = 60,
EHPMDataHistoryOrigin_CommandChangeField_Priority = 61,
EHPMDataHistoryOrigin_CommandChangeField_IdealDays = 62,
EHPMDataHistoryOrigin_CommandChangeField_LinkedToSprint = 63,
EHPMDataHistoryOrigin_CommandChangeField_WorkRemaining = 64,
EHPMDataHistoryOrigin_CommandChangeField_BacklogCategory = 65,
EHPMDataHistoryOrigin_CommandChangeField_Points = 66,
EHPMDataHistoryOrigin_CommandChangeField_ItemStatus = 67,
EHPMDataHistoryOrigin_CommandChangeField_LastUserIntefraceAction = 68,
EHPMDataHistoryOrigin_CommandChangeField_Confidence = 69,
EHPMDataHistoryOrigin_CommandChangeField_WorkRemainingHistory = 70,
EHPMDataHistoryOrigin_CommandChangeField_IdealDaysHistory = 71,
EHPMDataHistoryOrigin_CommandChangeField_PointsHistory = 72,
EHPMDataHistoryOrigin_CommandChangeField_SprintAllocatedResources = 73,
EHPMDataHistoryOrigin_CommandChangeField_HyperLink = 74,
EHPMDataHistoryOrigin_CommandChangeField_CalendarOptions = 75,
EHPMDataHistoryOrigin_CommandChangeField_SprintResourceAllocation = 76,
EHPMDataHistoryOrigin_CommandChangeField_CommentsOptions = 77,
EHPMDataHistoryOrigin_CommandChangeField_WorkflowStatus = 78,
EHPMDataHistoryOrigin_CommandChangeField_Severity = 79,
EHPMDataHistoryOrigin_CommandChangeField_DetailedDescription = 80,
EHPMDataHistoryOrigin_CommandChangeField_IsUserStory = 81,
EHPMDataHistoryOrigin_CommandChangeField_Archived = 82,
EHPMDataHistoryOrigin_CommandChangeField_SprintDisableFullCreationRights = 83,
EHPMDataHistoryOrigin_CommandChangeField_StepsToReproduce = 84,
EHPMDataHistoryOrigin_CommandChangeField_LinkedTo = 85,
EHPMDataHistoryOrigin_CommandChangeField_WallItemColorCategory = 86,
EHPMDataHistoryOrigin_CommandChangeField_WorkflowID = 87,
EHPMDataHistoryOrigin_CommandChangeField_DefaultWorkflowIDForNewItems = 88,
EHPMDataHistoryOrigin_CommandChangeField_FullyCreated = 89,
EHPMDataHistoryOrigin_CommandChangeField_SprintPriority = 90,
EHPMDataHistoryOrigin_CommandChangeField_BacklogPriority = 91,
EHPMDataHistoryOrigin_CommandChangeField_BugPriority = 92,
EHPMDataHistoryOrigin_CommandChangeField_SubProjectLock = 93,
EHPMDataHistoryOrigin_CommandChangeField_OriginallyCreatedOn = 94,
EHPMDataHistoryOrigin_CommandChangeField_IsEpic = 95,
EHPMDataHistoryOrigin_BIHistory = 96,
EHPMDataHistoryOrigin_ProjectSetDefaultQAWorkflow = 97,
EHPMDataHistoryOrigin_ProjectDeleteUserViewPreset = 98,
EHPMDataHistoryOrigin_ProjectChangeUserViewPreset = 99,
EHPMDataHistoryOrigin_ProjectCreateUserViewPreset = 100,
EHPMDataHistoryOrigin_ProjectSetColumnMetaData = 101,
EHPMDataHistoryOrigin_ProjectClone = 102,
EHPMDataHistoryOrigin_UpdateBoardAttributes = 103,
EHPMDataHistoryOrigin_BoardElementDelete = 104,
EHPMDataHistoryOrigin_BoardTasksMove = 105,
EHPMDataHistoryOrigin_BoardTasksHide = 106,
EHPMDataHistoryOrigin_BoardTasksUnhide = 107,
EHPMDataHistoryOrigin_SprintSetBoard = 108,
EHPMDataHistoryOrigin_UpdateBoardElement = 109,
EHPMDataHistoryOrigin_BoardRepositioning = 110,
EHPMDataHistoryOrigin_BoardMapColumnToStatus = 111,
EHPMDataHistoryOrigin_BoardChangeElementSettings = 112,
};
Values
EHPMDataHistoryOrigin_NewVersionOfSDKRequired
The entry type did not exist when this SDK was created. Upgrade to a newer version of the SDK to be able to use this entry type.
EHPMDataHistoryOrigin_None
TBD
EHPMDataHistoryOrigin_Unknown
TBD
EHPMDataHistoryOrigin_StatisticsSampling
TBD
EHPMDataHistoryOrigin_FixDatabaseErrors
TBD
EHPMDataHistoryOrigin_UpdateAllDurationDatabaseLoad
TBD
EHPMDataHistoryOrigin_UpdateTaskToLatestPipeline
TBD
EHPMDataHistoryOrigin_SetInitialFieldValues
TBD
EHPMDataHistoryOrigin_LinkTasksToMilestones
TBD
EHPMDataHistoryOrigin_ChangeDisposition
TBD
EHPMDataHistoryOrigin_CreateTask
TBD
EHPMDataHistoryOrigin_CreateProxy
TBD
EHPMDataHistoryOrigin_MoveTask
TBD
EHPMDataHistoryOrigin_DeleteTask
TBD
EHPMDataHistoryOrigin_UpdateSprintStatisticsMidnight
TBD
EHPMDataHistoryOrigin_UpdateSprintStatisticsDatabaseOnline
TBD
EHPMDataHistoryOrigin_ConvertDatabaseVersion
TBD
EHPMDataHistoryOrigin_DeleteResource
TBD
EHPMDataHistoryOrigin_DeleteShare
TBD
EHPMDataHistoryOrigin_RemoveResourceFromProject
TBD
EHPMDataHistoryOrigin_ChangeProjectArchivedStatus
TBD
EHPMDataHistoryOrigin_InvokeDispositionBug
TBD
EHPMDataHistoryOrigin_DeleteCustomColumn
TBD
EHPMDataHistoryOrigin_RenameCustomColumn
TBD
EHPMDataHistoryOrigin_FullCommentsCreated
TBD
EHPMDataHistoryOrigin_CommentCreated
TBD
EHPMDataHistoryOrigin_CommentDeleted
TBD
EHPMDataHistoryOrigin_ConvertProjectChangeHistory
TBD
EHPMDataHistoryOrigin_ProjectCreate
TBD
EHPMDataHistoryOrigin_ProjectChange
TBD
EHPMDataHistoryOrigin_ProjectSetCustomColumns
TBD
EHPMDataHistoryOrigin_ProjectAddCustomColumn
TBD
EHPMDataHistoryOrigin_ProjectOpenQA
TBD
EHPMDataHistoryOrigin_ProjectSetWorkflow
TBD
EHPMDataHistoryOrigin_ProjectEnableWorkflowsInMainProjectAndBacklog
TBD
EHPMDataHistoryOrigin_ProjectCreateWorkflow
TBD
EHPMDataHistoryOrigin_ProjectChangeWorkflow
TBD
EHPMDataHistoryOrigin_ProjectDeleteWorkflow
TBD
EHPMDataHistoryOrigin_AddResourceToProject
TBD
EHPMDataHistoryOrigin_CreateShare
TBD
EHPMDataHistoryOrigin_CreateResource
TBD
EHPMDataHistoryOrigin_ProjectOpenBacklog
TBD
EHPMDataHistoryOrigin_ProjectSetDefaultActivatedColumns
TBD
EHPMDataHistoryOrigin_CommandChangeField_Comment
TBD
EHPMDataHistoryOrigin_CommandChangeField_Description
TBD
EHPMDataHistoryOrigin_CommandChangeField_TimeZones
TBD
EHPMDataHistoryOrigin_CommandChangeField_Completed
TBD
EHPMDataHistoryOrigin_CommandChangeField_Resources
TBD
EHPMDataHistoryOrigin_CommandChangeField_Color
TBD
EHPMDataHistoryOrigin_CommandChangeField_Unlocked
TBD
EHPMDataHistoryOrigin_CommandChangeField_BudgetedWork
TBD
EHPMDataHistoryOrigin_CommandChangeField_CompletedPercent
TBD
EHPMDataHistoryOrigin_CommandChangeField_LinkedToMilestones
TBD
EHPMDataHistoryOrigin_CommandChangeField_AttachedDocuments
TBD
EHPMDataHistoryOrigin_CommandChangeField_DelegatedTo
TBD
EHPMDataHistoryOrigin_CommandChangeField_OriginallyCreatedBy
TBD
EHPMDataHistoryOrigin_CommandChangeField_CustomColumnData
TBD
EHPMDataHistoryOrigin_CommandChangeField_VisibleTo
TBD
EHPMDataHistoryOrigin_CommandChangeField_DurationHours
TBD
EHPMDataHistoryOrigin_CommandChangeField_HourOffset
TBD
EHPMDataHistoryOrigin_CommandChangeField_Risk
TBD
EHPMDataHistoryOrigin_CommandChangeField_Priority
TBD
EHPMDataHistoryOrigin_CommandChangeField_IdealDays
TBD
EHPMDataHistoryOrigin_CommandChangeField_LinkedToSprint
TBD
EHPMDataHistoryOrigin_CommandChangeField_WorkRemaining
TBD
EHPMDataHistoryOrigin_CommandChangeField_BacklogCategory
TBD
EHPMDataHistoryOrigin_CommandChangeField_Points
TBD
EHPMDataHistoryOrigin_CommandChangeField_ItemStatus
TBD
EHPMDataHistoryOrigin_CommandChangeField_LastUserIntefraceAction
TBD
EHPMDataHistoryOrigin_CommandChangeField_Confidence
TBD
EHPMDataHistoryOrigin_CommandChangeField_WorkRemainingHistory
TBD
EHPMDataHistoryOrigin_CommandChangeField_IdealDaysHistory
TBD
EHPMDataHistoryOrigin_CommandChangeField_PointsHistory
TBD
EHPMDataHistoryOrigin_CommandChangeField_SprintAllocatedResources
TBD
EHPMDataHistoryOrigin_CommandChangeField_HyperLink
TBD
EHPMDataHistoryOrigin_CommandChangeField_CalendarOptions
TBD
EHPMDataHistoryOrigin_CommandChangeField_SprintResourceAllocation
TBD
EHPMDataHistoryOrigin_CommandChangeField_CommentsOptions
TBD
EHPMDataHistoryOrigin_CommandChangeField_WorkflowStatus
TBD
EHPMDataHistoryOrigin_CommandChangeField_Severity
TBD
EHPMDataHistoryOrigin_CommandChangeField_DetailedDescription
TBD
EHPMDataHistoryOrigin_CommandChangeField_IsUserStory
TBD
EHPMDataHistoryOrigin_CommandChangeField_Archived
TBD
EHPMDataHistoryOrigin_CommandChangeField_SprintDisableFullCreationRights
TBD
EHPMDataHistoryOrigin_CommandChangeField_StepsToReproduce
TBD
EHPMDataHistoryOrigin_CommandChangeField_LinkedTo
TBD
EHPMDataHistoryOrigin_CommandChangeField_WallItemColorCategory
TBD
EHPMDataHistoryOrigin_CommandChangeField_WorkflowID
TBD
EHPMDataHistoryOrigin_CommandChangeField_DefaultWorkflowIDForNewItems
TBD
EHPMDataHistoryOrigin_CommandChangeField_FullyCreated
TBD
EHPMDataHistoryOrigin_CommandChangeField_SprintPriority
TBD
EHPMDataHistoryOrigin_CommandChangeField_BacklogPriority
TBD
EHPMDataHistoryOrigin_CommandChangeField_BugPriority
TBD
EHPMDataHistoryOrigin_CommandChangeField_SubProjectLock
TBD
EHPMDataHistoryOrigin_CommandChangeField_OriginallyCreatedOn
TBD
EHPMDataHistoryOrigin_CommandChangeField_IsEpic
TBD
EHPMDataHistoryOrigin_BIHistory
TBD
EHPMDataHistoryOrigin_ProjectSetDefaultQAWorkflow
TBD
EHPMDataHistoryOrigin_ProjectDeleteUserViewPreset
TBD
EHPMDataHistoryOrigin_ProjectChangeUserViewPreset
TBD
EHPMDataHistoryOrigin_ProjectCreateUserViewPreset
TBD
EHPMDataHistoryOrigin_ProjectSetColumnMetaData
TBD
EHPMDataHistoryOrigin_ProjectClone
TBD
EHPMDataHistoryOrigin_UpdateBoardAttributes
TBD
EHPMDataHistoryOrigin_BoardElementDelete
TBD
EHPMDataHistoryOrigin_BoardTasksMove
TBD
EHPMDataHistoryOrigin_BoardTasksHide
TBD
EHPMDataHistoryOrigin_BoardTasksUnhide
TBD
EHPMDataHistoryOrigin_SprintSetBoard
TBD
EHPMDataHistoryOrigin_UpdateBoardElement
TBD
EHPMDataHistoryOrigin_BoardRepositioning
TBD
EHPMDataHistoryOrigin_BoardMapColumnToStatus
TBD
EHPMDataHistoryOrigin_BoardChangeElementSettings
TBD
See Also
EHPMStatisticsField
Used in DataHistoryGetHistory to specify a statistics field.
enum EHPMStatisticsField {
EHPMStatisticsField_NewVersionOfSDKRequired = -2147483648,
EHPMStatisticsField_WorkRemaining = 0,
EHPMStatisticsField_EstimatedIdealDays = 1,
EHPMStatisticsField_ItemStatus = 2,
EHPMStatisticsField_Severity = 3,
EHPMStatisticsField_BugStatus = 4,
EHPMStatisticsField_CompletedAndInCompletedDays = 5,
EHPMStatisticsField_BudgetedWorkEarnedValue = 6,
EHPMStatisticsField_ComplexityPoints = 7,
EHPMStatisticsField_Priority = 8,
EHPMStatisticsField_Risk = 9,
EHPMStatisticsField_Confidence = 10,
EHPMStatisticsField_CustomColumn = 11,
EHPMStatisticsField_CustomStatisticsSampler = 12,
EHPMStatisticsField_PipelineTasksBuildupAndBurndown = 13,
EHPMStatisticsField_RecordedStatisticsOnDate = 14,
EHPMStatisticsField_NoStatistics = 15,
};
Values
EHPMStatisticsField_NewVersionOfSDKRequired
The statistics field did not exist when this SDK was created. Upgrade to a newer version of the SDK to be able to use this entry type.
EHPMStatisticsField_WorkRemaining
Work remaining statistics.
EHPMStatisticsField_EstimatedIdealDays
Estimated ideal days statistics.
EHPMStatisticsField_ItemStatus
Item status statistics. Deprecated. Not statistics sampled from Hansoft 8.3.
EHPMStatisticsField_Severity
Severity statistics. Deprecated. Not statistics sampled from Hansoft 8.3.
EHPMStatisticsField_BugStatus
QA Bug status statistics. Deprecated. Not statistics sampled from Hansoft 8.3.
EHPMStatisticsField_CompletedAndInCompletedDays
Statistics about complete and incomplete working days. Deprecated. Not statistics sampled from Hansoft 8.3.
EHPMStatisticsField_BudgetedWorkEarnedValue
Budgeted work earned value statistics. Deprecated. Not statistics sampled from Hansoft 8.3.
EHPMStatisticsField_ComplexityPoints
Complexity point statistics.
EHPMStatisticsField_Priority
Priority statistics. Deprecated. Not statistics sampled from Hansoft 8.3.
EHPMStatisticsField_Risk
Risk statistics. Deprecated. Not statistics sampled from Hansoft 8.3.
EHPMStatisticsField_Confidence
Confidence statistics. Deprecated. Not statistics sampled from Hansoft 8.3.
EHPMStatisticsField_CustomColumn
Custom column statistics. Deprecated. Not statistics sampled from Hansoft 8.3.
EHPMStatisticsField_CustomStatisticsSampler
The field is a custom statistics sampler Deprecated. Not statistics sampled from Hansoft 8.3.
EHPMStatisticsField_PipelineTasksBuildupAndBurndown
Pipeline tasks buildup and burndown statistics. Deprecated. Not statistics sampled from Hansoft 8.3.
EHPMStatisticsField_RecordedStatisticsOnDate
Recorded statistics on specified date. Deprecated. Not statistics sampled from Hansoft 8.3.
EHPMStatisticsField_NoStatistics
No statistics used
See Also
EHPMStatisticsScope
Used in DataHistoryGetHistory to specify a statistics scope.
enum EHPMStatisticsScope {
EHPMStatisticsScope_NewVersionOfSDKRequired = -2147483648,
EHPMStatisticsScope_Everyone = 0,
EHPMStatisticsScope_Resource = 1,
EHPMStatisticsScope_ResourceGroup = 2,
EHPMStatisticsScope_Milestone = 3,
EHPMStatisticsScope_ChatHistory = 4,
EHPMStatisticsScope_ProjectChangeHistory = 5,
EHPMStatisticsScope_NoStatisticsScope = 6,
};
Values
EHPMStatisticsScope_NewVersionOfSDKRequired
The statistics field did not exist when this SDK was created. Upgrade to a newer version of the SDK to be able to use this entry type.
EHPMStatisticsScope_Everyone
The statistics are for everyone.
EHPMStatisticsScope_Resource
The statistics are for a specific resource.
EHPMStatisticsScope_ResourceGroup
The statistics are for a specific resource group.
EHPMStatisticsScope_Milestone
The statistics are for a specific milestone.
EHPMStatisticsScope_ChatHistory
The statistics are for chat history.
EHPMStatisticsScope_ProjectChangeHistory
The statistics are for project change history.
EHPMStatisticsScope_NoStatisticsScope
No statistics scope used.
See Also
EHPMDataHistoryFlag
Flags used with HPMDataHistoryGetHistoryParameters::m_Flags.
enum EHPMDataHistoryFlag {
EHPMDataHistoryFlag_None = 0,
EHPMDataHistoryFlag_GetEntriesReverse = 1,
};
Values
EHPMDataHistoryFlag_None
TBD
EHPMDataHistoryFlag_GetEntriesReverse
Get the data history entries in reverse, starting with the latest data history entry.
See Also
HPMDataHistoryGetHistoryParameters
EHPMCustomChoiceValueType
Used in HPMCustomChoiceValue::m_ValueType to specify the type of value the decoded data represents.
enum EHPMCustomChoiceValueType {
EHPMCustomChoiceValueType_NewVersionOfSDKRequired = 0,
EHPMCustomChoiceValueType_Unknown = 1,
EHPMCustomChoiceValueType_Resource = 2,
EHPMCustomChoiceValueType_Project = 3,
EHPMCustomChoiceValueType_Task = 4,
EHPMCustomChoiceValueType_CustomColumnHash = 5,
EHPMCustomChoiceValueType_DefaultColumn = 6,
EHPMCustomChoiceValueType_GlobalReport = 7,
EHPMCustomChoiceValueType_Report = 8,
EHPMCustomChoiceValueType_ResourceGroup = 9,
};
Values
EHPMCustomChoiceValueType_NewVersionOfSDKRequired
The choice value type did not exist when this SDK was created. Upgrade to a newer version of the SDK to be able to use this entry type.
EHPMCustomChoiceValueType_Unknown
The value type is unknown and cannot be decoded.
EHPMCustomChoiceValueType_Resource
The value is a resource unique id. Use HPMCustomChoiceValue::m_UniqueID.
EHPMCustomChoiceValueType_Project
The value is a project unique id. Use HPMCustomChoiceValue::m_UniqueID.
EHPMCustomChoiceValueType_Task
The value is a task unique id. Use HPMCustomChoiceValue::m_UniqueID.
EHPMCustomChoiceValueType_CustomColumnHash
The value is a custom column hash. Use HPMCustomChoiceValue::m_IntValue.
EHPMCustomChoiceValueType_DefaultColumn
The value is a default column. Use HPMCustomChoiceValue::m_IntValue interpreted as a EHPMProjectDefaultColumn.
EHPMCustomChoiceValueType_GlobalReport
The value is a global report unique id. Use HPMCustomChoiceValue::m_UniqueID.
EHPMCustomChoiceValueType_Report
The value is a report unique id. Use HPMCustomChoiceValue::m_UniqueID.
EHPMCustomChoiceValueType_ResourceGroup
The value is a resource unique id. Use HPMCustomChoiceValue::m_UniqueID.
See Also
EHPMFindCriteriaType
Criteria type used for HPMFindCriteria::m_Type
enum EHPMFindCriteriaType {
EHPMFindCriteriaType_NewVersionOfSDKRequired = 0,
EHPMFindCriteriaType_Criteria = 1,
EHPMFindCriteriaType_AllItems = 2,
EHPMFindCriteriaType_ReportedItems = 3,
EHPMFindCriteriaType_ExcludingCriteria = 4,
};
Values
EHPMFindCriteriaType_NewVersionOfSDKRequired
The type did not exist when this SDK was created. Upgrade to a newer version of the SDK to be able to use this type.
EHPMFindCriteriaType_Criteria
Find criteria type.
EHPMFindCriteriaType_AllItems
All items start type.
EHPMFindCriteriaType_ReportedItems
Reported items end type.
EHPMFindCriteriaType_ExcludingCriteria
Excluding find criteria type.
See Also
EHPMFindCriteriaDataType
Criteria data type used for HPMFindCriteriaData::m_Type.
enum EHPMFindCriteriaDataType {
EHPMFindCriteriaDataType_NewVersionOfSDKRequired = 0,
EHPMFindCriteriaDataType_Invalid = 1,
EHPMFindCriteriaDataType_Text = 2,
EHPMFindCriteriaDataType_Droplist = 3,
EHPMFindCriteriaDataType_Integer = 4,
EHPMFindCriteriaDataType_Float = 5,
EHPMFindCriteriaDataType_Date = 6,
EHPMFindCriteriaDataType_GeneralCondition = 7,
EHPMFindCriteriaDataType_MultiSelectDroplist = 8,
EHPMFindCriteriaDataType_UnquotedText = 9,
EHPMFindCriteriaDataType_CustomQueryString = 10,
EHPMFindCriteriaDataType_DropListWithDate = 11,
EHPMFindCriteriaDataType_DropListWithMultiSelectDropList = 12,
EHPMFindCriteriaDataType_DropListWithDropList = 13,
};
Values
EHPMFindCriteriaDataType_NewVersionOfSDKRequired
The criteria type did not exist when this SDK was created. Upgrade to a newer version of the SDK to be able to use this type.
EHPMFindCriteriaDataType_Invalid
Invalid criteria data.
EHPMFindCriteriaDataType_Text
The criteria data condition is free text.
EHPMFindCriteriaDataType_Droplist
The criteria data condition is a list of selectable items.
EHPMFindCriteriaDataType_Integer
The criteria data is an integer condition.
EHPMFindCriteriaDataType_Float
The criteria data is a float condition.
EHPMFindCriteriaDataType_Date
The criteria data is a date condition.
EHPMFindCriteriaDataType_GeneralCondition
The criteria data is a general condition.
EHPMFindCriteriaDataType_MultiSelectDroplist
The criteria data is a list of selectable items with a condition set by HPMFindCriteriaDataHeader::m_Operator.
EHPMFindCriteriaDataType_UnquotedText
The criteria data condition is unquoted text.
EHPMFindCriteriaDataType_CustomQueryString
The criteria data condition is a custom query string.
EHPMFindCriteriaDataType_DropListWithDate
The criteria data condition is a list with dates.
EHPMFindCriteriaDataType_DropListWithMultiSelectDropList
The criteria data condition is a list with another multi select list.
EHPMFindCriteriaDataType_DropListWithDropList
The criteria data condition is a list with another list.
See Also
HPMFindCriteriaData, UtilGetFindCriteriaDataTypeFromData, UtilGetFindCriteriaDataTypeFromColumn, UtilGetColumnDescription, HPMColumnDescription
EHPMFindCriteriaOperator
Criteria operator used for HPMFindCriteriaDataHeader::m_Operator
enum EHPMFindCriteriaOperator {
EHPMFindCriteriaOperator_NewVersionOfSDKRequired = 0,
EHPMFindCriteriaOperator_NoOperator = 1,
EHPMFindCriteriaOperator_EmptyOperator = 2,
EHPMFindCriteriaOperator_Contains = 3,
EHPMFindCriteriaOperator_ContainsCase = 4,
EHPMFindCriteriaOperator_NotContains = 5,
EHPMFindCriteriaOperator_NotContainsCase = 6,
EHPMFindCriteriaOperator_StartsWith = 7,
EHPMFindCriteriaOperator_StartsWithCase = 8,
EHPMFindCriteriaOperator_EndsWith = 9,
EHPMFindCriteriaOperator_EndsWithCase = 10,
EHPMFindCriteriaOperator_EqualTo = 11,
EHPMFindCriteriaOperator_EqualToCase = 12,
EHPMFindCriteriaOperator_NotEqualTo = 13,
EHPMFindCriteriaOperator_NotEqualToCase = 14,
EHPMFindCriteriaOperator_GreaterThan = 15,
EHPMFindCriteriaOperator_GreaterThanCase = 16,
EHPMFindCriteriaOperator_LessThan = 17,
EHPMFindCriteriaOperator_LessThanCase = 18,
EHPMFindCriteriaOperator_GreaterThanEqual = 19,
EHPMFindCriteriaOperator_GreaterThanEqualCase = 20,
EHPMFindCriteriaOperator_LessThanEqual = 21,
EHPMFindCriteriaOperator_LessThanEqualCase = 22,
EHPMFindCriteriaOperator_Range = 23,
EHPMFindCriteriaOperator_DateFromNowToXDays = 24,
EHPMFindCriteriaOperator_DateFromNowToXWeeks = 25,
EHPMFindCriteriaOperator_DateFromNowToXMonths = 26,
EHPMFindCriteriaOperator_DateFromNowToXYears = 27,
EHPMFindCriteriaOperator_DateFromXDaysInThePast = 28,
EHPMFindCriteriaOperator_DateFromXWeeksInThePast = 29,
EHPMFindCriteriaOperator_DateFromXMonthsInThePast = 30,
EHPMFindCriteriaOperator_DateFromXYearsInThePast = 31,
EHPMFindCriteriaOperator_DateFromNowToXHours = 32,
EHPMFindCriteriaOperator_DateFromNowToXMinutes = 33,
EHPMFindCriteriaOperator_DateFromXHoursInThePast = 34,
EHPMFindCriteriaOperator_DateFromXMinutesInThePast = 35,
};
Values
EHPMFindCriteriaOperator_NewVersionOfSDKRequired
The operator did not exist when this SDK was created. Upgrade to a newer version of the SDK to be able to use this operator.
EHPMFindCriteriaOperator_NoOperator
No operator set.
EHPMFindCriteriaOperator_EmptyOperator
No operator used.
EHPMFindCriteriaOperator_Contains
Contains operator.
EHPMFindCriteriaOperator_ContainsCase
Contains operator (case sensitive).
EHPMFindCriteriaOperator_NotContains
Does not contain operator.
EHPMFindCriteriaOperator_NotContainsCase
Does not contain operator (case sensitive).
EHPMFindCriteriaOperator_StartsWith
Starts with operator.
EHPMFindCriteriaOperator_StartsWithCase
Starts with operator (case sensitive).
EHPMFindCriteriaOperator_EndsWith
Ends with operator.
EHPMFindCriteriaOperator_EndsWithCase
Ends with operator (case sensitive).
EHPMFindCriteriaOperator_EqualTo
Equal to operator.
EHPMFindCriteriaOperator_EqualToCase
Equal to operator (case sensitive).
EHPMFindCriteriaOperator_NotEqualTo
Not equal to operator.
EHPMFindCriteriaOperator_NotEqualToCase
Not equal to operator (case sensitive).
EHPMFindCriteriaOperator_GreaterThan
Greater than operator.
EHPMFindCriteriaOperator_GreaterThanCase
Greater than operator (case sensitive).
EHPMFindCriteriaOperator_LessThan
Less than operator.
EHPMFindCriteriaOperator_LessThanCase
Less than operator (case sensitive).
EHPMFindCriteriaOperator_GreaterThanEqual
Greater or equal than operator.
EHPMFindCriteriaOperator_GreaterThanEqualCase
Greater or equal than (case sensitive).
EHPMFindCriteriaOperator_LessThanEqual
Less or equal than operator.
EHPMFindCriteriaOperator_LessThanEqualCase
Less or equal than operator (case sensitive).
EHPMFindCriteriaOperator_Range
Range operator.
EHPMFindCriteriaOperator_DateFromNowToXDays
From today to X days in the future operator.
EHPMFindCriteriaOperator_DateFromNowToXWeeks
From today to X weeks in the future operator.
EHPMFindCriteriaOperator_DateFromNowToXMonths
From today to X months in the future operator.
EHPMFindCriteriaOperator_DateFromNowToXYears
From today to X years in the future operator.
EHPMFindCriteriaOperator_DateFromXDaysInThePast
From X days in the past to today operator.
EHPMFindCriteriaOperator_DateFromXWeeksInThePast
From X weeks in the past to today operator.
EHPMFindCriteriaOperator_DateFromXMonthsInThePast
From X months in the past to today operator.
EHPMFindCriteriaOperator_DateFromXYearsInThePast
From X years in the past to today operator.
EHPMFindCriteriaOperator_DateFromNowToXHours
From today to X hours in the future operator.
EHPMFindCriteriaOperator_DateFromNowToXMinutes
From today to X minutes in the future operator.
EHPMFindCriteriaOperator_DateFromXHoursInThePast
From X hours in the past to today operator.
EHPMFindCriteriaOperator_DateFromXMinutesInThePast
From X minutes in the past to today operator.
Comments
All combinations of operator and criterias are not possible.
See Also
EHPMValueType
Value type used for HPMColumnDescription::m_Type.
enum EHPMValueType {
EHPMValueType_NewVersionOfSDKRequired = 0,
EHPMValueType_Undefined = 1,
EHPMValueType_Normal = 2,
EHPMValueType_Number = 3,
EHPMValueType_Boolean = 4,
EHPMValueType_Hours = 5,
EHPMValueType_Days = 6,
EHPMValueType_Year = 7,
EHPMValueType_Time = 8,
EHPMValueType_Points = 9,
EHPMValueType_Resources = 10,
EHPMValueType_Tasks = 11,
EHPMValueType_Task = 12,
EHPMValueType_Project = 13,
EHPMValueType_Column = 14,
EHPMValueType_CustomColumnDrop = 15,
EHPMValueType_ID_BugStatus = 16,
EHPMValueType_IDs_WorkflowAndStatus = 17,
EHPMValueType_Enum_Risk = 18,
EHPMValueType_Enum_Priority = 19,
EHPMValueType_Enum_BacklogCategory = 20,
EHPMValueType_Enum_Confidence = 21,
EHPMValueType_Enum_Severity = 22,
EHPMValueType_Enum_ItemStatus = 23,
EHPMValueType_Enum_ItemType = 24,
EHPMValueType_Enum_Defined = 25,
EHPMValueType_Enum_Unset = 26,
EHPMValueType_Unset = 27,
EHPMValueType_CustomColumnMultiSelectionDrop = 28,
EHPMValueType_BoardLane = 29,
EHPMValueType_BoardColumn = 30,
EHPMValueType_Enum_Color = 31,
};
Values
EHPMValueType_NewVersionOfSDKRequired
The value did not exist when this SDK was created. Upgrade to a newer version of the SDK to be able to use this type.
EHPMValueType_Undefined
TBD
EHPMValueType_Normal
TBD
EHPMValueType_Number
TBD
EHPMValueType_Boolean
TBD
EHPMValueType_Hours
TBD
EHPMValueType_Days
TBD
EHPMValueType_Year
TBD
EHPMValueType_Time
TBD
EHPMValueType_Points
TBD
EHPMValueType_Resources
TBD
EHPMValueType_Tasks
TBD
EHPMValueType_Task
TBD
EHPMValueType_Project
TBD
EHPMValueType_Column
TBD
EHPMValueType_CustomColumnDrop
TBD
EHPMValueType_ID_BugStatus
TBD
EHPMValueType_IDs_WorkflowAndStatus
TBD
EHPMValueType_Enum_Risk
TBD
EHPMValueType_Enum_Priority
TBD
EHPMValueType_Enum_BacklogCategory
TBD
EHPMValueType_Enum_Confidence
TBD
EHPMValueType_Enum_Severity
TBD
EHPMValueType_Enum_ItemStatus
TBD
EHPMValueType_Enum_ItemType
TBD
EHPMValueType_Enum_Defined
TBD
EHPMValueType_Enum_Unset
TBD
EHPMValueType_Unset
TBD
EHPMValueType_CustomColumnMultiSelectionDrop
TBD
EHPMValueType_BoardLane
TBD
EHPMValueType_BoardColumn
TBD
EHPMValueType_Enum_Color
TBD
See Also
UtilGetColumnDescription, HPMColumnDescription
EHPMFindCriteriaConnectionSite
Connection site used for HPMFindCriteriaConnection::m_ConnectionFrom and HPMFindCriteriaConnection::m_ConnectionTo
enum EHPMFindCriteriaConnectionSite {
EHPMFindCriteriaConnectionSite_NewVersionOfSDKRequired = 0,
EHPMFindCriteriaConnectionSite_Top = 1,
EHPMFindCriteriaConnectionSite_Bottom = 2,
};
Values
EHPMFindCriteriaConnectionSite_NewVersionOfSDKRequired
The connection site did not exist when this SDK was created. Upgrade to a newer version of the SDK to be able to use this connection site.
EHPMFindCriteriaConnectionSite_Top
The connection is to/from the top connection site of the object box.
EHPMFindCriteriaConnectionSite_Bottom
The connection is to/from the bottom connection site of the object box.
See Also
EHPMChannelFlag
Flags used with CommunicationChannelRegister.
enum EHPMChannelFlag {
EHPMChannelFlag_None = 0,
EHPMChannelFlag_SupportsAuthentication = 1,
EHPMChannelFlag_SupportsResolveCredentials = 2,
EHPMChannelFlag_PermitSharing = 4,
};
Values
EHPMChannelFlag_None
TBD
EHPMChannelFlag_SupportsAuthentication
The Channel and this session accept client login authentication requests.
EHPMChannelFlag_SupportsResolveCredentials
The Channel and this session accept and process requests for credential checks and resolution.
EHPMChannelFlag_PermitSharing
The Channel may be shared with other Helix Plan database servers, enabling their clients to send packets to this channel and session.
See Also
CommunicationChannelRegister, EHPMChangeCallbackOperation_AuthenticationResolveCredentials
EHPMCertificateVerificationFlag
Flags used with HPMCertificateSettings::m_VerificationFlags
enum EHPMCertificateVerificationFlag {
EHPMCertificateVerificationFlag_None = 0,
EHPMCertificateVerificationFlag_UserCanAcceptUntrusted = 1,
EHPMCertificateVerificationFlag_RememberTrustedCertificates = 2,
EHPMCertificateVerificationFlag_UseSpecificPeerCertificate = 4,
EHPMCertificateVerificationFlag_UseOSStoreIfNoCASpecified = 8,
EHPMCertificateVerificationFlag_VerifyHostnameMatches = 16,
EHPMCertificateVerificationFlag_UserCanIgnoreVerificationFailures = 32,
};
Values
EHPMCertificateVerificationFlag_None
TBD
EHPMCertificateVerificationFlag_UserCanAcceptUntrusted
Accept untrusted certificates.
EHPMCertificateVerificationFlag_RememberTrustedCertificates
Remember trusted certificates.
EHPMCertificateVerificationFlag_UseSpecificPeerCertificate
Use specific peer certificate stored in HPMCertificateSettings::m_CACertificateData.
EHPMCertificateVerificationFlag_UseOSStoreIfNoCASpecified
If no CA is specified the operating systems own CA store should be used.
EHPMCertificateVerificationFlag_VerifyHostnameMatches
Decides whether or not to verify the certificate's hostnames with the hostname of the server you are connecting to.
EHPMCertificateVerificationFlag_UserCanIgnoreVerificationFailures
Determines whether a user can ignore validation failures (e.g. expired certificates, hostname mismatches).
See Also
EHPMPacketFlag
Used in CommunicationChannelSendPacket and EHPMChangeCallbackOperation_CommunicationChannelPacketReceived to specify properties of a channel packet.
enum EHPMPacketFlag {
EHPMPacketFlag_None = 0,
EHPMPacketFlag_AuthenticationPacket = 1,
EHPMPacketFlag_CredentialResolutionPacket = 2,
};
Values
EHPMPacketFlag_None
TBD
EHPMPacketFlag_AuthenticationPacket
Packet is part of a client authentication exchange, receiving channels must have the EHPMChannelFlag_SupportsAuthentication {@EHPMChannelFlag}
EHPMPacketFlag_CredentialResolutionPacket
Packet is part of a credential resolution request, receiving channels must have the EHPMChannelFlag_SupportsResolveCredentials {@EHPMChannelFlag}
See Also
CommunicationChannelSendPacket, EHPMChangeCallbackOperation_CommunicationChannelPacketReceived, HPMCommunicationChannelPacket
EHPMFindCriteriaFlag
Criteria flag used for HPMFindCriteria::m_Flags
enum EHPMFindCriteriaFlag {
EHPMFindCriteriaFlag_None = 0,
EHPMFindCriteriaFlag_CustomQueryString = 1,
};
Values
EHPMFindCriteriaFlag_None
TBD
EHPMFindCriteriaFlag_CustomQueryString
Custom query string.
See Also
EHPMTimesheetRequestType
Type of timesheet request used for TimesheetGetDateRange.
enum EHPMTimesheetRequestType {
EHPMTimesheetRequestType_NewVersionOfSDKRequired = 0,
EHPMTimesheetRequestType_Resources = 1,
EHPMTimesheetRequestType_Projects = 2,
EHPMTimesheetRequestType_Tasks = 3,
};
Values
EHPMTimesheetRequestType_NewVersionOfSDKRequired
The timesheet request type did not exist when this SDK was created. Upgrade to a newer version of the SDK to be able to use this request type.
EHPMTimesheetRequestType_Resources
Request type for resources.
EHPMTimesheetRequestType_Projects
Request type for projects.
EHPMTimesheetRequestType_Tasks
Request type for tasks.
See Also
EHPMChatOnlineStatus
Chat online status used for ResourceSetChatOnlineStatus and ResourceGetChatOnlineStatus
enum EHPMChatOnlineStatus {
EHPMChatOnlineStatus_NewVersionOfSDKRequired = 0,
EHPMChatOnlineStatus_Offline = 1,
EHPMChatOnlineStatus_Away = 2,
EHPMChatOnlineStatus_Online = 3,
};
Values
EHPMChatOnlineStatus_NewVersionOfSDKRequired
The chat status did not exist when this SDK was created. Upgrade to a newer version of the SDK to be able to use this chat status.
EHPMChatOnlineStatus_Offline
Offline chat status.
EHPMChatOnlineStatus_Away
Away chat status.
EHPMChatOnlineStatus_Online
Online chat status.
See Also
ResourceSetChatOnlineStatus, ResourceGetChatOnlineStatus
EHPMEmailSecurityProtocol
Type of email security protocol used in HPMGlobalEmailSettings::m_SecurityProtocol
enum EHPMEmailSecurityProtocol {
EHPMEmailSecurityProtocol_NewVersionOfSDKRequired = 0,
EHPMEmailSecurityProtocol_None = 1,
EHPMEmailSecurityProtocol_SSL = 2,
EHPMEmailSecurityProtocol_TLS = 3,
};
Values
EHPMEmailSecurityProtocol_NewVersionOfSDKRequired
The security protocol did not exist when this SDK was created. Upgrade to a newer version of the SDK to be able to use this security protocol.
EHPMEmailSecurityProtocol_None
No security protocol.
EHPMEmailSecurityProtocol_SSL
Secure Socket Layer.
EHPMEmailSecurityProtocol_TLS
Transport Layer Security.
See Also
EHPMSdkDebugMode
SDK debug mode
enum EHPMSdkDebugMode {
EHPMSdkDebugMode_Off = 0,
EHPMSdkDebugMode_Debug = 1,
EHPMSdkDebugMode_Testing = 2,
};
Values
EHPMSdkDebugMode_Off
No debugging
EHPMSdkDebugMode_Debug
Full debugging
EHPMSdkDebugMode_Testing
Minimal debugging with only contracts enabled. Deprecated
See Also
EHPMDataHistoryEntryFilterFlag
Data history entry filter flag used for HPMDataHistoryEntryFilter::m_Flags that determines which fields are used in HPMDataHistoryFilter::m_EntryFilter.
enum EHPMDataHistoryEntryFilterFlag {
EHPMDataHistoryEntryFilterFlag_None = 0,
EHPMDataHistoryEntryFilterFlag_Kind = 1,
EHPMDataHistoryEntryFilterFlag_Type = 2,
EHPMDataHistoryEntryFilterFlag_FieldID = 4,
EHPMDataHistoryEntryFilterFlag_FieldData = 8,
};
Values
EHPMDataHistoryEntryFilterFlag_None
TBD
EHPMDataHistoryEntryFilterFlag_Kind
Filter on the HPMDataHistoryEntryFilter::m_EntryKind field.
EHPMDataHistoryEntryFilterFlag_Type
Filter on the HPMDataHistoryEntryFilter::m_EntryType field.
EHPMDataHistoryEntryFilterFlag_FieldID
Filter on the HPMDataHistoryEntryFilter::m_FieldID field.
EHPMDataHistoryEntryFilterFlag_FieldData
Filter on the HPMDataHistoryEntryFilter::m_FieldData field.
See Also
EHPMDataHistoryFilterOperatorFlag
The logical operators used for HPMDataHistoryFilter::m_Flags. If not set a logical OR will be used to combine the filters.
enum EHPMDataHistoryFilterOperatorFlag {
EHPMDataHistoryFilterOperatorFlag_None = 0,
EHPMDataHistoryFilterOperatorFlag_And = 1,
EHPMDataHistoryFilterOperatorFlag_Not = 2,
};
Values
EHPMDataHistoryFilterOperatorFlag_None
TBD
EHPMDataHistoryFilterOperatorFlag_And
Logical AND will be used to combine the HPMDataHistoryFilter::m_pFilters filters.
EHPMDataHistoryFilterOperatorFlag_Not
Every filter in HPMDataHistoryFilter::m_pFilters will negated.
See Also
EHPMCalculatedColumnValueState
The state of calculated Column value
enum EHPMCalculatedColumnValueState {
EHPMCalculatedColumnValueState_NewVersionOfSDK = 0,
EHPMCalculatedColumnValueState_UpToDate = 1,
EHPMCalculatedColumnValueState_Previous = 2,
EHPMCalculatedColumnValueState_NotCalculatedYet = 3,
};
Values
EHPMCalculatedColumnValueState_NewVersionOfSDK
The calculated column did not exist when this SDK was created. Upgrade to a newer version of the SDK to be able to use this enum.
EHPMCalculatedColumnValueState_UpToDate
TBD
EHPMCalculatedColumnValueState_Previous
TBD
EHPMCalculatedColumnValueState_NotCalculatedYet
TBD
See Also
EHPMDebugFlag
Debug Flags for SDK session
enum EHPMDebugFlag {
EHPMDebugFlag_None = 0,
EHPMDebugFlag_DisableCustomColumnsChangesChecking = 1,
};
Values
EHPMDebugFlag_None
TBD
EHPMDebugFlag_DisableCustomColumnsChangesChecking
Disables checking whether custom column changes are valid
See Also
HPMDataHistoryEntryFilter
The filter used in HPMDataHistoryFilter::m_EntryFilter.
struct HPMDataHistoryEntryFilter {
HPMUInt32 m_Flags;
HPMUInt32 m_EntryType;
HPMUInt32 m_EntryKind;
HPMInt32 m_FieldID;
HPMUInt32 m_FieldData;
} HPMDataHistoryEntryFilter;
Members
m_Flags
These flags determine which fields in HPMDataHistoryEntryFilter will be used for filtering. The data history entry EHPMDataHistoryEntryFilterFlag flags.
m_EntryType
The type of entry to filter on. See EHPMDataHistoryEntryType.
m_EntryKind
The kind of entry to filter on. See EHPMDataHistoryEntryKind.
m_FieldID
The field id of the data to filter on. If filtering on a task history entry, i.e. m_EntryKind is not set to EHPMDataHistoryEntryKind_ProjectChangeHistory, this is one of EHPMTaskField, although not all fields will be used. If m_EntryKind is set to EHPMDataHistoryEntryKind_ProjectChangeHistory it will be one of EHPMProjectField
m_FieldData
The field data of the data to filter on. If m_FieldID is EHPMTaskField_CustomColumnData this member is the column hash of the custom column data.
See Also
HPMDataHistoryFilter
Filter to limit the number of returned data history entries. Used for HPMDataHistoryGetHistoryParameters::m_Filter
struct HPMDataHistoryFilter {
HPMUInt32 m_Flags;
HPMDataHistoryEntryFilter m_EntryFilter;
HPMUInt32 m_nFilters;
conststruct @class_00006f77; HPMDataHistoryFilter * m_pFilters;
} HPMDataHistoryFilter;
Members
m_Flags
The operator that will combine the filters in the m_pFilter list. Can be a combination of the EHPMDataHistoryFilterOperatorFlag flags.
m_EntryFilter
The filter parameters. Only valid if m_nFilters is 0.
m_nFilters
The number of HPMDataHistoryFilter that this filter combines.
m_pFilters
Pointer to a list of HPMDataHistoryFilter that specifies the filters to apply to the data history search.
See Also
HPMDataHistoryGetHistoryParameters
HPMDataHistoryTimePosition
Time and position used to limit the returned data history entries.
struct HPMDataHistoryTimePosition {
HPMUInt64 m_Time;
HPMInt64 m_Position;
} HPMDataHistoryTimePosition;
Members
m_Time
Time value expressed as the number of micro seconds since 1970 UTC. Set to 0 to have unbounded start time.
m_Position
Position value. See HPMDataHistory Differentiator when several entries have the same time stamp.
See Also
HPMDataHistoryGetHistoryParameters, HPMDataHistory
HPMDataHistoryGetHistoryParameters
The parameters passed to DataHistoryGetHistory.
struct HPMDataHistoryGetHistoryParameters {
HPMUniqueID m_DataID;
HPMInt32 m_FieldID;
HPMUInt32 m_FieldData;
HPMUInt32 m_DataIdent0;
HPMUInt32 m_DataIdent1;
HPMUInt32 m_Flags;
HPMUInt32 m_MaxEntries;
HPMDataHistoryTimePosition m_Start;
HPMDataHistoryTimePosition m_End;
HPMDataHistoryFilter m_Filter;
} HPMDataHistoryGetHistoryParameters;
Members
m_DataID
The identifier of the data to retrieve. See comments for more information.
m_FieldID
The field id of the data to retrieve. See comments for more information.
m_FieldData
The field data of the data to retrieve. See comments for more information.
m_DataIdent0
The first identifier of the data to retrieve. See comments for more information.
m_DataIdent1
The second identifier of the data to retrieve. See comments for more information.
m_Flags
The data history entry EHPMDataHistoryFlag flags.
m_MaxEntries
The max number of entries to retrieve. Set to 0 to have unbounded number of entries.
m_Start
Limit start time and start position.
m_End
Limit end time and end position.
m_Filter
HPMDataHistoryEntryFilter that specifies the filters to apply to the data history search.
Retrieving Task or Project History
To retrieve history for a task or project pass the
following parameters
m_DataID
The unique identifier of the task or project to retrieve history for.
m_FieldID
EHPMStatisticsField_NoStatistics
m_FieldData
0
m_DataIdent0
EHPMStatisticsScope_NoStatisticsScope
m_DataIdent1
0
Retrieving Statistics
To retrieve sampled statistics for an object pass the following parameters:
m_DataID
Pass -1 to retrieve global statistics. Pass the unique identifier of an project to retrieve statistics of a specific project.
m_FieldID
Should be one of EHPMStatisticsField.
m_FieldData
If m_FieldID is EHPMStatisticsField_CustomColumn this parameter should be the column hash for the custom column to retrieve statistics for. If m_FieldID is EHPMStatisticsField_CustomStatisticsSampler this parameter should be the sampler ID of the custom statistics sampler for the project (can only be retrieved when m_DataID is a project). Otherwise 0.
m_DataIdent0
Should be one of EHPMStatisticsScope.
m_DataIdent1
If m_DataIdent0 is EHPMStatisticsScope_Everyone this parameter should be 0. If m_DataIdent0 is EHPMStatisticsScope_Resource this parameter should be the unique identifier of the resource to retrieve statistics for. If m_DataIdent0 is EHPMStatisticsScope_ResourceGroup this parameter should be the identifier for the resource group to retrieve statistics for. If m_DataIdent0 is EHPMStatisticsScope_Milestone this parameter the unique reference identifier of the milestone to retrieve statistics for. When a data history entry is received, it is cached locally in memory on the client. To limit the size of the cache use DataHistorySetMaxCacheEntries.
See Also
HPMDataHistoryEntry
Data history entry used for HPMDataHistory::m_pHistoryEntries.
struct HPMDataHistoryEntry {
HPMUInt64 m_Time;
HPMUniqueID m_ResourceID;
HPMString m_Resource;
HPMUniqueID m_ObjectID;
HPMUniqueID m_NonImpersonatedResourceID;
HPMString m_NonImpersonatedResource;
HPMUInt32 m_EntryType;
HPMUInt32 m_EntryKind;
HPMInt32 m_FieldID;
HPMUInt32 m_FieldData;
HPMInt32 m_Origin;
HPMInt32 m_ClientOrigin;
const HPMUntranslatedString * m_pClientCustomOrigin;
HPMInt32 m_bHasDataRecorded;
} HPMDataHistoryEntry;
Members
m_Time
The time when the data was changed. Expressed as the number of micro seconds since 1970 UTC.
m_ResourceID
The unique identifier of the resource that changed the data.
m_Resource
The resource that changed the data.
m_ObjectID
Set to task id if this is a task history entry and project id if this is a project history entry.
m_NonImpersonatedResourceID
The unique identifier of the non impersonated resource that changed the data. Differs from m_ResourceID when resource is impersonated.
m_NonImpersonatedResource
The non impersonated resource that changed the data. Differs from m_Resource when resource is impersonated.
m_EntryType
The type of entry. See EHPMDataHistoryEntryType.
m_EntryKind
The kind of entry. See EHPMDataHistoryEntryKind.
m_FieldID
The field id of the data for this entry. If this is a task history entry this is one of EHPMTaskField, although not all fields will be used. If this is project history entry this is one of EHPMProjectField.
m_FieldData
The field data of the data for this entry. If m_FieldID is EHPMTaskField_CustomColumnData this member is the column hash of the custom column data.
m_Origin
The origin detailing where on the server the entry was created from.
m_ClientOrigin
The client origin detailing where on the client the entry was created from.
m_pClientCustomOrigin
A string detailing the custom client origin.
m_bHasDataRecorded
Set to true if this entry is a has any data recorded. If set it is safe to call DataHistoryGetEntryData on the entry.
Retrieving Task History Data
Task history data is retrieved differently depending on the type of field you want to retrieve data for. HPMDataHistoryEntry::m_EntryKind is set to EHPMDataHistoryEntryKind_Default.
EHPMTaskField_BacklogCategory
Use VariantDecode_HPMInt32. EHPMTaskBacklogCategory
EHPMTaskField_Confidence
Use VariantDecode_HPMInt32. EHPMTaskConfidence
EHPMTaskField_Risk
Use VariantDecode_HPMInt32. EHPMTaskRisk
EHPMTaskField_Status
Use VariantDecode_HPMInt32. EHPMTaskStatus
EHPMTaskField_Severity
Use VariantDecode_HPMInt32. EHPMTaskSeverity
EHPMTaskField_SprintPriority
Use VariantDecode_HPMInt32. EHPMTaskAgilePriorityCategory
EHPMTaskField_BacklogPriority
Use VariantDecode_HPMInt32. EHPMTaskAgilePriorityCategory
EHPMTaskField_BugPriority
Use VariantDecode_HPMInt32. EHPMTaskAgilePriorityCategory
EHPMTaskField_VacationOptions (FieldData = 2)
Use VariantDecode_HPMInt32. EHPMTaskVacationOptionsFlag
EHPMTaskField_LastUserInterfaceAction
Use VariantDecode_HPMInt32. EHPMTaskLastUserInterfaceAction
EHPMTaskField_Priority
Use VariantDecode_HPMInt32. EHPMTaskPriority
EHPMTaskField_LockedType
Use VariantDecode_HPMInt32. EHPMTaskLockedType
EHPMTaskField_Type
Use VariantDecode_HPMInt32. EHPMTaskType
EHPMTaskField_WallItemColor
Use VariantDecode_HPMInt32. EHPMTaskWallItemColor
EHPMTaskField_Unlocked
Use VariantDecode_HPMInt32. Boolean.
EHPMTaskField_Completed
Use VariantDecode_HPMInt32. Boolean.
EHPMTaskField_UserStoryFlag
Use VariantDecode_HPMInt32. Boolean.
EHPMTaskField_Archived
Use VariantDecode_HPMInt32. Boolean.
EHPMTaskField_FullyCreated
Use VariantDecode_HPMInt32. Boolean.
EHPMTaskField_ForceSubProject
Use VariantDecode_HPMInt32. Boolean.
EHPMTaskField_SprintResourcesHaveFullRights
Use VariantDecode_HPMInt32. Boolean.
EHPMTaskField_VacationOptions (FieldData = 0)
Use VariantDecode_HPMInt32. Boolean. Set if vacation task flag is on.
EHPMTaskField_BudgetedWork
Use VariantDecode_HPMInt32. Hours.
EHPMTaskField_StartOffset
Use VariantDecode_HPMInt32. Hours.
EHPMTaskField_Duration
Use VariantDecode_HPMInt32. Hours.
EHPMTaskField_TotalDuration
Use VariantDecode_HPMInt32. Days.
EHPMTaskField_PercentComplete
Use VariantDecode_HPMInt32. 0 - 100.
EHPMTaskField_ResourceAllocationFirstPercent
Use VariantDecode_HPMInt32. 0 - 100.
EHPMTaskField_ComplexityPoints
EHPMTaskField_WorkflowStatus
Use VariantDecode_HPMInt32. Corresponds to object id in workflow.
EHPMTaskField_Workflow
Use VariantDecode_HPMUInt32. Corresponds to workflow container ID.
EHPMTaskField_Color
Use VariantDecode_HPMUInt32. RGB.
EHPMTaskField_TimeZoneStart
Use VariantDecode_HPMUInt64. Micro seconds since 1970.
EHPMTaskField_TimeZoneEnd
Use VariantDecode_HPMUInt64. Micro seconds since 1970.
EHPMTaskField_WorkRemaining
Use VariantDecode_HPMFP32. Hours.
EHPMTaskField_EstimatedIdealDays
EHPMTaskField_ResourceAllocationFirst
Use VariantDecode_HPMUniqueID.
EHPMTaskField_DefaultWorkflow
Use VariantDecode_HPMUniqueID.
EHPMTaskField_LinkedToPipelineTask
Use VariantDecode_HPMUniqueID.
EHPMTaskField_LinkedToSprint
Use VariantDecode_HPMUniqueID.
EHPMTaskField_OriginallyCreatedBy
Use VariantDecode_HPMUniqueID.
EHPMTaskField_Description
EHPMTaskField_Hyperlink
EHPMTaskField_DetailedDescription
EHPMTaskField_StepsToReproduce
EHPMTaskField_CustomColumnData
EHPMTaskField_LinkedToMilestone
Use VariantDecode_HPMTaskLinkedToMilestones.
EHPMTaskField_DelegateTo
Use VariantDecode_HPMTaskDelegateTo.
EHPMTaskField_SprintAllocatedResources
Use VariantDecode_HPMTaskSprintAllocatedResources.
EHPMTaskField_VisibleTo
Use VariantDecode_HPMTaskVisibleTo.
EHPMTaskField_ResourceAllocationMore
Use VariantDecode_HPMTaskResourceAllocation.
EHPMTaskField_AttachedDocuments
Use VariantDecode_HPMTaskAttachedDocuments.
EHPMTaskField_VacationOptions (FieldData = 1)
Use VariantDecode_HPMTaskVacationOptions.
EHPMTaskField_CommentsOptions
Use VariantDecode_HPMTaskCommentsOptions.
EHPMTaskField_LinkedTo
Use VariantDecode_HPMTaskLinkedTo.
EHPMTaskField_SprintResourceAllocation
Use VariantDecode_HPMTaskSprintResourceAllocation.
EHPMTaskField_TimeZones
Use VariantDecode_HPMTaskTimeZones.
EHPMTaskField_Comment
No data recorded.
EHPMTaskField_IdealDaysHistory
No data recorded.
EHPMTaskField_PointsHistory
No data recorded.
EHPMTaskField_WorkRemainingHistory
No data recorded.
Retrieving Task History Special Data
Task history data is retrieved differently depending on the entry type of field you want to retrieve data for.
EHPMDataHistoryEntryType_TaskCreated
Use VariantDecode_HPMDataHistoryTaskCreated.
EHPMDataHistoryEntryType_TaskRestoredFromHistory
Use VariantDecode_HPMDataHistoryTaskRestoredFromHistory.
EHPMDataHistoryEntryType_TaskMoved
Use VariantDecode_HPMDataHistoryTaskMoved.
EHPMDataHistoryEntryType_TaskRenameCustomColumn
Use VariantDecode_HPMDataHistoryTaskRenameCustomColumn.
EHPMDataHistoryEntryType_TaskProxyCreated
Use VariantDecode_HPMDataHistoryTaskProxyCreated.
EHPMDataHistoryEntryType_TaskProxyDeleted
Use VariantDecode_HPMDataHistoryTaskProxyDeleted.
EHPMDataHistoryEntryType_TaskDeleted
EHPMDataHistoryEntryType_TaskRenameBoardLane
Use VariantDecode_HPMDataHistoryTaskRenameBoardElementInfo.
EHPMDataHistoryEntryType_TaskRenameBoardColumn
Use VariantDecode_HPMDataHistoryTaskRenameBoardElementInfo.
EHPMDataHistoryEntryType_TaskBoardLaneChanged
Use VariantDecode_HPMDataHistoryTaskBoardCardInfo.
EHPMDataHistoryEntryType_TaskBoardColumnChanged
Use VariantDecode_HPMDataHistoryTaskBoardCardInfo.
EHPMDataHistoryEntryType_TaskBoardLaneDeleted
No additional data is needed
EHPMDataHistoryEntryType_TaskBoardColumnDeleted
No additional data is needed
Retrieving Statistics Data
Statistics data is retrieved differently depending on the type of field you want to retrieve data for.
EHPMStatisticsField_WorkRemaining
EHPMStatisticsField_EstimatedIdealDays
Use VariantDecode_HPMStatisticsMultiFrequency. If m_UniqueID is 0, m_Frequency is Days. If m_UniqueID is 1, m_Frequency is Days not done.
EHPMStatisticsField_ItemStatus
Use VariantDecode_HPMStatisticsMultiFrequency.
EHPMStatisticsField_Severity
Use VariantDecode_HPMStatisticsMultiFrequency.
EHPMStatisticsField_BugStatus
Use VariantDecode_HPMStatisticsMultiFrequency.
EHPMStatisticsField_CompletedAndInCompletedDays
Use VariantDecode_HPMStatisticsMultiFrequency.
EHPMStatisticsField_BudgetedWorkEarnedValue
Use VariantDecode_HPMStatisticsMultiFrequency.
EHPMStatisticsField_ComplexityPoints
Use VariantDecode_HPMStatisticsMultiFrequency. If m_UniqueID is 0, m_Frequency is Points. If m_UniqueID is 1, m_Frequency is Points not done.
EHPMStatisticsField_Priority
Use VariantDecode_HPMStatisticsMultiFrequency.
EHPMStatisticsField_Risk
Use VariantDecode_HPMStatisticsMultiFrequency.
EHPMStatisticsField_Confidence
Use VariantDecode_HPMStatisticsMultiFrequency.
EHPMStatisticsField_CustomColumn
Use VariantDecode_HPMStatisticsMultiFrequency. To interpret the data you need to check the custom column configuration for the specific column hash with ProjectCustomColumnsGet
EHPMStatisticsField_CustomStatisticsSampler
Use VariantDecode_HPMStatisticsCustomStatisticsFrequency.
EHPMStatisticsField_PipelineTasksBuildupAndBurndown
Use VariantDecode_HPMStatisticsMultiFrequency.
Retrieving Project History Data
Project history data is retrieved differently depending on the type of field you want to retrieve data for. HPMDataHistoryEntry::m_EntryKind is set to EHPMDataHistoryEntryKind_ProjectChangeHistory.
EHPMProjectField_CustomColumns
Use VariantDecode_HPMProjectCustomColumns.
EHPMProjectField_WorkflowSettings
Use VariantDecode_HPMProjectWorkflowSettings.
EHPMProjectField_CalendarHolidays
Use VariantDecode_HPMHolidays.
EHPMProjectField_CalendarWorkingDays
Use VariantDecode_HPMWorkingDays.
EHPMProjectField_CalendarCustomWorkingDays
Use VariantDecode_HPMCustomWorkingDays.
EHPMProjectField_CalendarWorkingHours
Use VariantDecode_HPMWorkingHours.
EHPMProjectField_CalendarCustomWorkingHours
Use VariantDecode_HPMCustomWorkingHours.
EHPMProjectField_Name
EHPMProjectField_ArchivedStatus
Use VariantDecode_HPMInt32. Boolean.
EHPMProjectField_ProjectMethod
Use VariantDecode_HPMInt32. EHPMProjectMethod .
EHPMProjectField_CompletionStyle
Use VariantDecode_HPMInt32. EHPMProjectTaskCompletionStyle.
EHPMProjectField_AgileTemplate
Use VariantDecode_HPMInt32. EHPMProjectAgileTemplate.
EHPMProjectField_OldCustomColumn
Use VariantDecode_HPMProjectCustomColumnsColumn.
EHPMProjectField_WorkflowsInMainProjectAndBacklog
Use VariantDecode_HPMInt32. Boolean.
EHPMProjectField_OldResource
Use VariantDecode_HPMUniqueID.
EHPMProjectField_DefaultEditorMode
Use VariantDecode_HPMInt32. EHPMProjectDefaultEditorMode.
EHPMProjectField_DefaultActivatedColumns
Use VariantDecode_HPMProjectDefaultColumns.
EHPMProjectField_CustomColumnAncestry
Use VariantDecode_HPMProjectCustomColumnAncestry.
EHPMProjectField_UsersCanReportNewBugs
Use VariantDecode_ProjectBugReportResources.
EHPMProjectField_DefaultQAWorkflow
Use VariantDecode_HPMUniqueID.
EHPMProjectField_ConvertedQAWorkflow
Use VariantDecode_HPMUniqueID.
EHPMProjectField_DefaultColumnMetaData
Use VariantDecode_HPMProjectColumnMetaData.
EHPMProjectField_CustomColumnMetaData
Use VariantDecode_HPMProjectColumnMetaData.
EHPMProjectField_ViewPresets
Use VariantDecode_HPMProjectViewPreset.
Comments
Note that there can be several EHPMDataHistoryEntryType_TaskCreated entries, since a task can be recreated by a cut and paste or from history. The current history is often what you are looking for and in that case just look at entries from the latest EHPMDataHistoryEntryType_TaskCreated.
See Also
HPMDataHistory, EHPMDataHistoryEntryType
HPMStatisticsMultiFrequencyEntry
Frequency entry used in HPMStatisticsMultiFrequency.
struct HPMStatisticsMultiFrequencyEntry {
HPMInt32 m_UniqueID;
HPMInt32 m_Frequency;
HPMFP64 m_FrequencyFP;
} HPMStatisticsMultiFrequencyEntry;
Members
m_UniqueID
The unique identifier of the state to count frequency for.
m_Frequency
The number of occurrences of the unique id.
m_FrequencyFP
The statistic as a floating point number. Used for statistics for custom columns that is of the decimal format.
See Also
HPMStatisticsMultiFrequency
Frequency entries used in VariantDecode_HPMStatisticsMultiFrequency.
struct HPMStatisticsMultiFrequency {
HPMUInt32 m_nFrequencyEntries;
const HPMStatisticsMultiFrequencyEntry * m_pFrequencyEntries;
} HPMStatisticsMultiFrequency;
Members
m_nFrequencyEntries
The number of frequency entries.
m_pFrequencyEntries
Pointer to a list of HPMStatisticsMultiFrequencyEntry that specifies the frequency entries.
See Also
VariantDecode_HPMStatisticsMultiFrequency, HPMStatisticsMultiFrequencyEntry
HPMDataHistoryTaskCreated
Task created data used in VariantDecode_HPMDataHistoryTaskCreated.
struct HPMDataHistoryTaskCreated {
HPMUniqueID m_Container;
HPMUniqueID m_TaskMainReferenceID;
HPMUInt32 m_ID;
} HPMDataHistoryTaskCreated;
Members
m_Container
The container the task was created in.
m_TaskMainReferenceID
The main reference ID for the task.
m_ID
The task ID. See TaskGetID.
See Also
VariantDecode_HPMDataHistoryTaskCreated,
HPMDataHistoryTaskRestoredFromHistory
Restored task data used in VariantDecode_HPMDataHistoryTaskRestoredFromHistory.
struct HPMDataHistoryTaskRestoredFromHistory {
HPMUniqueID m_Container;
HPMUniqueID m_TaskMainReferenceID;
HPMUInt32 m_ID;
} HPMDataHistoryTaskRestoredFromHistory;
Members
m_Container
The container the task was restored in.
m_TaskMainReferenceID
The main reference ID for the task.
m_ID
The task ID. See TaskGetID.
See Also
VariantDecode_HPMDataHistoryTaskRestoredFromHistory,
HPMDataHistoryTaskMoved
Task moved data used in VariantDecode_HPMDataHistoryTaskMoved.
struct HPMDataHistoryTaskMoved {
HPMUniqueID m_ContainerFrom;
HPMUniqueID m_ContainerTo;
HPMUniqueID m_TaskMainReferenceID;
HPMUInt32 m_ID;
} HPMDataHistoryTaskMoved;
Members
m_ContainerFrom
The container the task was moved from.
m_ContainerTo
The container the task was moved to.
m_TaskMainReferenceID
The main reference ID for the task.
m_ID
The task ID. See TaskGetID.
See Also
VariantDecode_HPMDataHistoryTaskMoved,
HPMDataHistoryTaskProxyCreated
Frequency entries used in VariantDecode_HPMDataHistoryTaskProxyCreated.
struct HPMDataHistoryTaskProxyCreated {
HPMUniqueID m_Container;
HPMUniqueID m_TaskReferenceID;
} HPMDataHistoryTaskProxyCreated;
Members
m_Container
The container the task proxy was created in.
m_TaskReferenceID
The task reference ID of the created proxy.
See Also
VariantDecode_HPMDataHistoryTaskProxyCreated,
HPMDataHistoryTaskProxyDeleted
Proxy deleted data used in VariantDecode_HPMDataHistoryTaskProxyDeleted.
struct HPMDataHistoryTaskProxyDeleted {
HPMUniqueID m_Container;
HPMUniqueID m_TaskReferenceID;
} HPMDataHistoryTaskProxyDeleted;
Members
m_Container
The container the task proxy was deleted from.
m_TaskReferenceID
The task reference ID of the deleted proxy.
See Also
VariantDecode_HPMDataHistoryTaskProxyDeleted,
HPMDataHistoryTaskRenameCustomColumn
Rename custom column data used in VariantDecode_HPMDataHistoryTaskRenameCustomColumn.
struct HPMDataHistoryTaskRenameCustomColumn {
HPMUInt32 m_HashFrom;
HPMUInt32 m_HashTo;
} HPMDataHistoryTaskRenameCustomColumn;
Members
m_HashFrom
The hash of the custom column that was renamed from.
m_HashTo
The hash of the custom column that was renamed to.
See Also
VariantDecode_HPMDataHistoryTaskRenameCustomColumn,
HPMDataHistoryTaskRenameBoardElementInfo
Rename baord's element data used in VariantDecode_HPMDataHistoryTaskRenameBoardElementInfo.
struct HPMDataHistoryTaskRenameBoardElementInfo {
HPMUniqueID m_ElementID;
HPMString m_From;
HPMString m_To;
} HPMDataHistoryTaskRenameBoardElementInfo;
Members
m_ElementID
Database ID of element
m_From
The old name of board's element
m_To
The new name of board's element
See Also
VariantDecode_HPMDataHistoryTaskRenameBoardElementInfo,
HPMDataHistoryTaskBoardCardInfo
Element data used in VariantDecode_HPMDataHistoryTaskBoardCardInfo.
struct HPMDataHistoryTaskBoardCardInfo {
HPMUniqueID m_ElementID;
HPMString m_ElementName;
} HPMDataHistoryTaskBoardCardInfo;
Members
m_ElementID
Database ID of element
m_ElementName
The name of board's element when task was moved into it
See Also
VariantDecode_HPMDataHistoryTaskBoardCardInfo,
HPMStatisticsCustomStatisticsFrequencyEntry
Frequency entry used in HPMStatisticsCustomStatisticsFrequency.
struct HPMStatisticsCustomStatisticsFrequencyEntry {
HPMInt32 m_nFieldData;
HPMInt32 * m_pFieldData;
HPMInt32 m_Frequency;
} HPMStatisticsCustomStatisticsFrequencyEntry;
Members
m_nFieldData
The number of field data that specifies the combination for this specific entry. Should always be the same as HPMStatisticsCustomStatisticsFrequency::m_nFields.
m_pFieldData
Pointer to a list of {HPMInt32} that specifies the data for the fields that specifies the specific combination for this entry. Appears in the order specified in HPMStatisticsCustomStatisticsFrequency::m_pFields.
m_Frequency
The number of occurrences of this combination of data.
See Also
HPMStatisticsCustomStatisticsFrequency
HPMStatisticsCustomStatisticsFrequency
Frequency entries used in VariantDecode_HPMStatisticsCustomStatisticsFrequency.
struct HPMStatisticsCustomStatisticsFrequency {
HPMUInt32 m_nFields;
const HPMCustomStatisticsField * m_pFields;
HPMUInt32 m_nFrequencyEntries;
const HPMStatisticsCustomStatisticsFrequencyEntry * m_pFrequencyEntries;
} HPMStatisticsCustomStatisticsFrequency;
Members
m_nFields
The number of fields the custom statistic is comprised of. Normally the same as specified in HPMProjectCustomStatisticsSampler.
m_pFields
Pointer to a list of HPMCustomStatisticsField that specifies the fields the custom statistic is comprised of. This is the order that data in HPMStatisticsCustomStatisticsFrequencyEntry::m_pFieldData appears.
m_nFrequencyEntries
The number of frequency entries.
m_pFrequencyEntries
Pointer to a list of HPMStatisticsCustomStatisticsFrequencyEntry that specifies the frequency entries.
See Also
VariantDecode_HPMStatisticsCustomStatisticsFrequency, HPMStatisticsCustomStatisticsFrequencyEntry
HPMDebugFlushWatchNotificationEntry
Watch email in HPMDebugFlushWatchNotification.
struct HPMDebugFlushWatchNotificationEntry {
HPMString m_UserName;
HPMString m_WatchEmailHTML;
} HPMDebugFlushWatchNotificationEntry;
Members
m_UserName
Username of the email recipient
m_WatchEmailHTML
HTML of the Watch Email
See Also
HPMDebugFlushWatchNotification
HPMDebugFlushWatchNotification
Watch emails used in DebugFlushWatchNotifications.
struct HPMDebugFlushWatchNotification {
HPMUInt32 m_nFlushWatchEmailsEntries;
const HPMDebugFlushWatchNotificationEntry * m_pFlushWatchEmailsEntries;
} HPMDebugFlushWatchNotification;
Members
m_nFlushWatchEmailsEntries
The number of Flush Watch Email entries.
m_pFlushWatchEmailsEntries
Pointer to a list of HPMDebugFlushWatchNotificationEntry that specifies the frequency entries.
See Also
DebugFlushWatchNotifications, HPMStatisticsCustomStatisticsFrequencyEntry
ClientSDKGetFunctionPtr
Callback used by the SDK to get function pointers when the SDK is used as a client plugin.
void * ClientSDKGetFunctionPtr (
    HPMUInt32 _ClientVersion,
    const HPMAsciChar * _pFunctionName
    );
Parameters
_ClientVersion
[in] Pointer to a HPMInt32 value that will receive the error code for the function. See EHPMError.
_pFunctionName
[in] Pointer to a HPMInt32 value that will receive the error code for the function. See EHPMError.
Return Value
Returns the function pointer.
See Also
HPMClientSDKData
This structure is passed to the Init function when the Helix Plan executable loads a client plugin.
struct HPMClientSDKData {
HPMFunctionClientSDKGetFunctionPtr m_pGetFunctionPtr;
HPMUInt32 m_HansoftVersion;
} HPMClientSDKData;
Members
m_pGetFunctionPtr
The function pointer used by HPMInit to get the functions from the SDK implementation in the client.
m_HansoftVersion
The Helix Plan version that the client plugin is loaded into.
Comments
For a client plugin you should export a function named HPMClientSDKCreate and a function named HPMClientSDKDestroy with the following prototypes: void DHPMSdkCallingConvention HPMClientSDKCreate(const HPMClientSDKData *_pClientData); void DHPMSdkCallingConvention HPMClientSDKDestroy(); HPMClientSDKCreate will be called when the Helix Plan client loads the plugin dll. HPMClientSDKDestroy will be called right before the Helix Plan client uploads the plugin dll. You should make sure to destroy any SDK objects and stop all threads before returning from this function, or the client executable might start leaking memory.
See Also
HPMCustomChoiceValue
Used in UtilDecodeCustomChoiceValue to specify a decoded custom choice value.
struct HPMCustomChoiceValue {
HPMInt32 m_ValueType;
HPMUniqueID m_UniqueID;
HPMUniqueID m_UniqueID2;
HPMUInt32 m_IntValue;
} HPMCustomChoiceValue;
Members
m_ValueType
Can be one of EHPMCustomChoiceValueType.
m_UniqueID
The unique identifier of the decoded custom value, if the m_ValueType specifies a type that is expressed as an unique identifier.
m_UniqueID2
A second unique identifier of the decoded custom value, if the m_ValueType specifies a type that needs a second unique identifier. Currently used for EHPMCustomChoiceValueType::_Report and EHPMCustomChoiceValueType::_GlobalReport.
m_IntValue
The integer value of the decoded custom value, if the m_ValueType specifies a type that is expressed as an integer value.
See Also
UtilDecodeCustomChoiceValue, EHPMCustomChoiceValueType
HPMCommunicationChannelData
Stores custom data for a channel, provided by the session that registered the channel using CommunicationChannelRegister.
struct HPMCommunicationChannelData {
HPMUInt32 m_nBytes;
const HPMUInt8 * m_pBytes;
} HPMCommunicationChannelData;
Members
m_nBytes
The number of bytes of channel data.
m_pBytes
The channel data, as at the beginning of session login sequence.
See Also
CommunicationChannelRegister, CommunicationChannelEnum
HPMCommunicationChannelProperties
Used in CommunicationChannelEnum, to provide information about a communication channel.
struct HPMCommunicationChannelProperties {
const HPMChar * m_pChannelName;
HPMUInt64 m_OwnerSessionID;
const HPMChar * m_pDatabaseGUID;
const HPMChar * m_pDescription;
HPMCommunicationChannelData m_ChannelData;
HPMUInt32 m_Flags;
} HPMCommunicationChannelProperties;
Members
m_pChannelName
The name of the Channel. An empty channel name means the channel is owned by the server hosting the channel's database.
m_OwnerSessionID
The session ID of the channel's owner
m_pDatabaseGUID
The globally unique GUID of the database where Channel is originally registered, as a string.
m_pDescription
A description of the database's domain, for example the name of the organization or department owning it.
m_ChannelData
Custom channel data, provided by channel's owner.
m_Flags
The Channel's EHPMChannelFlag flags.
See Also
CommunicationChannelEnum, CommunicationChannelRegister
HPMCommunicationChannelEnum
Used for enumerating channels of a server.
struct HPMCommunicationChannelEnum {
HPMUInt32 m_nChannels;
const HPMCommunicationChannelProperties * m_pChannels;
} HPMCommunicationChannelEnum;
Members
m_nChannels
The number of channels in the array.
m_pChannels
Pointer to a list of channels and their properties.
See Also
HPMCredentialResolutionSessionIDsEnum
Used for specifying target Session IDs for credential resolution queries.
struct HPMCredentialResolutionSessionIDsEnum {
HPMUInt32 m_nSessionIDs;
const HPMUInt64 * m_pSessionIDs;
} HPMCredentialResolutionSessionIDsEnum;
Members
m_nSessionIDs
The number of Session IDs in the array.
m_pSessionIDs
Pointer to a list of Session IDs.
See Also
AuthenticationResolveCredentials
HPMCertificateData
Stores certificate data.
struct HPMCertificateData {
HPMUInt32 m_nBytes;
const HPMUInt8 * m_pBytes;
} HPMCertificateData;
Members
m_nBytes
The number of bytes of certificate data.
m_pBytes
The certificate data.
See Also
HPMCertificateSettings
Certificate settings used for session connect.
struct HPMCertificateSettings {
HPMUInt32 m_VerificationFlags;
HPMCertificateData m_PublicCertificateData;
HPMCertificateData m_PrivateKeyData;
HPMCertificateData m_CRLData;
HPMCertificateData m_CACertificateData;
const HPMChar * m_CAStoreLocation;
const HPMChar * m_PathToCRLs;
HPMInt32 m_VerificationDepth;
} HPMCertificateSettings;
Members
m_VerificationFlags
The certificate verification flags.
m_PublicCertificateData
Public certificate data.
m_PrivateKeyData
Private key data.
m_CRLData
Certificate revocation list data.
m_CACertificateData
CA certificate data.
m_CAStoreLocation
File system location of CA store.
m_PathToCRLs
File system location of CRLs.
m_VerificationDepth
The certificate verification depth.
See Also
HPMDataHistory
Data history entries used in DataHistoryGetHistory.
struct HPMDataHistory {
HPMUInt32 m_nHistoryEntries;
const HPMDataHistoryEntry * m_pHistoryEntries;
HPMDataHistoryTimePosition m_Delivered;
HPMDataHistoryTimePosition m_Earliest;
HPMDataHistoryTimePosition m_Latests;
} HPMDataHistory;
Members
m_nHistoryEntries
The number of history entries.
m_pHistoryEntries
Pointer to a list of HPMDataHistoryEntry that specifies the history entries.
m_Delivered
The actual last time and last position of the delivered entries.
m_Earliest
The earliest time and position of all entries available in the unfiltered data history search.
m_Latests
The latest time and position of all entries available in the unfiltered data history search.
Time and pos values
The data history search can be limited with the m_Start, m_End and m_MaxEntries fields in HPMDataHistoryGetHistoryParameters. | Together with the returned time and position values in m_Delivered, m_First and m_Last, data history can be returned in chunks.
See Also
DataHistoryGetHistory, HPMDataHistoryEntry
HPMCustomTaskStatusDialogValues
Task status custom dialog strings used in GlobalDisplayCustomTaskStatusDialog.
struct HPMCustomTaskStatusDialogValues {
const HPMUntranslatedString * m_pTitle;
const HPMUntranslatedString * m_pInfoText;
const HPMUntranslatedString * m_pButtonLabel;
const HPMUntranslatedString * m_pCancelLabel;
const HPMUntranslatedString * m_pSelectionActionText;
const HPMUntranslatedString * m_pOptionalTextHeading;
const HPMChar * m_pOptionalText;
} HPMCustomTaskStatusDialogValues;
Members
m_pTitle
The dialog title.
m_pInfoText
General description.
m_pButtonLabel
Label on submit button.
m_pCancelLabel
Label on cancel button.
m_pSelectionActionText
Description of submit action.
m_pOptionalTextHeading
Heading for section that can display optional information.
m_pOptionalText
Optional text.
See Also
GlobalDisplayCustomTaskStatusDialog
HPMCalculatedColumnValue
Used to store the calculated column value or error
struct HPMCalculatedColumnValue {
HPMUInt32 m_State;
HPMFP64 m_Value;
HPMUntranslatedString const * m_pError;
} HPMCalculatedColumnValue;
Members
m_State
The state of the column value. Can be one of EHPMCalculatedColumnValueState.
m_Value
Up to date only if m_State is EHPMCalculatedColumnValueState_UpToDate, if m_State == EHPMCalculatedColumnValueState_Previous contains previous valid value.
m_pError
Error can represent division by zero or that the custom column expression is invalid. Relevant only if m_State is EHPMCalculatedColumnValueState_Previous.
See Also
HPMSessionInfo
Used to describe the information about a session.
struct HPMSessionInfo {
const HPMChar * m_pAddress;
HPMInt32 m_Port;
const HPMChar * m_pDatabase;
const HPMChar * m_pResourceName;
HPMUInt64 m_SessionID;
} HPMSessionInfo;
Members
m_pAddress
The address of the server the session is connected to
m_Port
The port of the server the session is connected to
m_pDatabase
The database the session is connected to
m_pResourceName
The resource used to connect to the database with
m_SessionID
The session ID of this session.
See Also
HPMSessionLock
Used to keep a reference to a session lock.
struct HPMSessionLock {
HPMInt32 m_Dummy;
} HPMSessionLock;
Members
m_Dummy
Unused dummy member
See Also
HPMSessionReadLock
Used to keep a reference to a session read lock.
struct HPMSessionReadLock {
HPMInt32 m_Dummy;
} HPMSessionReadLock;
Members
m_Dummy
Unused dummy member
See Also
HPMSessionReadLockHeld
Used to manage the lifetime of the effects of a SessionReadLockHeld call.
struct HPMSessionReadLockHeld {
HPMInt32 m_Dummy;
} HPMSessionReadLockHeld;
Members
m_Dummy
Unused dummy member
See Also
HPMSessionTryLock
Used to manage the lifetime of the effects of a SessionReadLockHeld call.
struct HPMSessionTryLock {
HPMInt32 m_Dummy;
} HPMSessionTryLock;
Members
m_Dummy
Unused dummy member
See Also
HPMNeedSessionProcessCallback
Definition of the callback function called when you need to call SessionProcess because new events have been received from the server.
void HPMNeedSessionProcessCallback (
    void * _pContext
    );
Parameters
_pContext
[in] The context provided to
Comments
You cannot call any SDK functions when called into this function. It is intended that you signal another thread that will subsequently call SessionProcess. When converting from 7.0 or older SDKs just signal the semaphore that was previously used for the same purpose.
See Also
HPMNeedSessionProcessCallbackInfo
HPMNeedSessionProcessCallbackInfo
Need session process callback.
struct HPMNeedSessionProcessCallbackInfo {
void * m_pContext;
HPMNeedSessionProcessCallback m_pCallback;
} HPMNeedSessionProcessCallbackInfo;
Members
m_pContext
The user supplied context that will be provided when the callback is called
m_pCallback
The callback to call when you need to call SessionProcess
See Also
SessionOpen
Opens a session to a database on a server.
void * SessionOpen (
    HPMError * _pError,
    const HPMChar * _pAddress,
    HPMInt32 _Port,
    const HPMChar * _pDatabase,
    const HPMChar * _pResourceName,
    const HPMChar * _pPassword,
    HPMInt32 _bBlockOnOperations,
    HPMNeedSessionProcessCallbackInfo const * _pNeedProcessCallback,
    HPMUInt32 _SDKVersion,
    HPMInt32 _SDKDebug,
    HPMUInt32 _nSessions,
    const HPMChar * _pWorkingDirectory,
    const HPMCertificateSettings * _pCertificateSettings,
    const HPMChar * * _pExtendedErrorMessage
    );
Parameters
_pError
[out] Pointer to a HPMInt32 value that will receive the error code for the function. See EHPMError.
_pAddress
[in] The address of the server to connect to.
_Port
[in] The port of the server to connect to.
_pDatabase
[in] The database on the server to connect to.
_pResourceName
[in] The resource name of the user to log in with. See comments for more information.
_pPassword
[in] The password of the resource to login with.
_bBlockOnOperations
[in] Turn on blocking operation of the SDK. It is recommended that you turn on blocking operation as non blocking operations has not been tested extensively.
_pNeedProcessCallback
[in] A callback that will be called when you need to call SessionProcess. Specify NULL to let the SDK do SessionProcess from a worker thread.
_SDKVersion
[in] Used by the SDK to keep track of what version of the interface is being used. You must set this to EHPMSDK_Version.
_SDKDebug
[in] Turn on debugging of the SDK. Use this during development to detect memory leaks, detect memory overwrites and turn on other run time checks such as asserts. Can be one of EHPMSdkDebugMode
_nSessions
[in] The number of sessions in an optional session pool. If set to 0 no pool is created. The pooled sessions are handled by SessionOpenVirtual.
_pWorkingDirectory
[in] The working directory where the SDK stores its working data. If not set the program directory of the application will be used.
_pCertificateSettings
[in] The security certificate settings for the SDK session. If no settings are provided, i.e. a NULL value sent, the SDK session to the server will be created without credentials.
_pExtendedErrorMessage
[out] HPMChar memory that will be allocated by the SDK if there are extra error message set by e.g. SSL. Will not be used if set to NULL. Must be freed with MemoryFree if returning non NULL content or a memory leak will result.
Return Value
Returns a session identifier. This identifier is used in all other functions of the SDK to identify the session to perform an operation on.
Comments
When you are done with the session you should close it with SessionClose. You need to call SessionProcess periodically or when the need process callback is called. If no callback is specified in the non-C SDKs, the SDK will deliver notifications from it's own thread with all the concurrency implications this has. If don't want to deal with the concurrency issues specify the callback/semaphore and call SessionProcess manually on your main thread. For more information see Connecting to a Database. If _nSessions > 0 a session pool is created. The session pool is a collection of SDK sessions where each session caches its own copy of the database. You can access the sessions in the session pool with SessionOpenVirtual. Every function call made on the virtual session calls any of the real sessions in the session pool. Every call on the virtual session can be made on a different real session under the hood and it does not need to be aware of this. If you have set the number of sessions parameter in SessionOpen to zero and use virtual sessions, all virtual sessions will work towards the same session. As long as your program is mostly reading and not doing heavy writing or blocking operations you can have a large number of virtual sessions without increasing the size of the session pool. For every session in the pool a new SDK user is created. This user will be named _pResourceName_number and have the password _pPassword. Note that for the Java, managed and C++ wrappers the SessionOpen and HPMInit functions are combined into a SessionOpen with HPMInit's last argument added.
See Also
HPMSdkFunctions, SessionProcess, SessionClose, SessionOpenVirtual
SessionGetInfo
Used to get the information about a connected session.
HPMError SessionGetInfo (
    void * _pSession,
    const HPMSessionInfo * * _pInfo
    );
Parameters
_pSession
[in] A connected session. See SessionOpen.
_pInfo
[out] Pointer to a pointer of a HPMSessionInfo object, representing the returned data.
Return Value
Returns an error code. See EHPMError.
Comments
The returned object must be freed with ObjectFree or a memory leak will result.
See Also
HPMSdkFunctions, HPMSessionInfo
SessionLock
Used to lock the session from receiving server updates.
HPMError SessionLock (
    void * _pSession,
    HPMSessionLock const * * _pLockReference
    );
Parameters
_pSession
[in] A connected session. See SessionOpen.
_pLockReference
[out] Pointer to a pointer of a HPMSessionLock object, representing the returned data.
Return Value
Returns an error code. See EHPMError.
Comments
The returned object must be freed with ObjectFree or a memory leak will result. When the object is freed the session is unlocked and can receive updates from the server again. Try to lock the session as little time as possible to allow the processing of messages from the server. If you call a blocking function while having the session lock it will temporarily be unlocked and updates from the server will be received until the blocking command has been returned from the server. Keep in mind that if you call this function from a client dll session the client will hang until you unlock the session.
See Also
HPMSdkFunctions, HPMSessionLock
SessionReadLock
Used to lock the session from receiving server updates.
HPMError SessionReadLock (
    void * _pSession,
    HPMSessionReadLock const * * _pLockReference
    );
Parameters
_pSession
[in] A connected session. See SessionOpen.
_pLockReference
[out] Pointer to a pointer of a HPMSessionReadLock object, representing the returned data.
Return Value
Returns an error code. See EHPMError.
Comments
The returned object must be freed with ObjectFree or a memory leak will result. When the object is freed the session is unlocked and can receive updates from the server again. Try to lock the session as little time as possible to allow the processing of messages from the server. If you call a blocking function while having the session lock it will temporarily be unlocked and updates from the server will be received until the blocking command has been returned from the server. Keep in mind that if you call this function from a client dll session the client will hang until you unlock the session.
See Also
HPMSdkFunctions, HPMSessionReadLock
SessionReadLockHeld
Used to notify the SDK that you are guaranteeing that the SDK read lock is being held on another thread until the HPMSessionReadLockHeld object is destroyed.
HPMError SessionReadLockHeld (
    void * _pSession,
    HPMSessionReadLockHeld const * * _pHeldReference
    );
Parameters
_pSession
[in] A connected session. See SessionOpen.
_pHeldReference
[out] Pointer to a pointer of a HPMSessionReadLockHeld object, representing the returned data.
Return Value
Returns an error code. See EHPMError.
Comments
The returned object must be freed with ObjectFree or a memory leak will result and a deadlock will occur. When the object is freed the session is notified that you are no longer guaranteeing that a read lock is being held on another thread.
See Also
HPMSdkFunctions, HPMSessionReadLockHeld
SessionOpenVirtual
Opens a virtual session. Function calls made on this virtual session uses pre-opened sessions from a session pool. Every call can use a different session from the session pool.
void * SessionOpenVirtual (
    void * _pSession
    );
Parameters
_pSession
[in] A connected session. See SessionOpen.
Return Value
Returns a virtual session identifier. This identifier is used in all other functions of the SDK to identify the session to perform an operation on. If no session pool has been created by SessionOpen the return value will be NULL. Note that you can use virtual sessions even if only one session was created by SessionOpen, i.e. the number of session parameter in SessionOpen is set to zero.
Comments
Callbacks and the process semaphore are handled by the parent session. If no session currently is available in the session pool when a function call is made, the call will block until a session is available or the call timeouts. In this case EHPMError_SessionPoolSessionNotAvailable is returned by functions that returns EHPMError and 0 for all other functions. If you have set the number of sessions parameter in SessionOpen to zero and use virtual sessions, all virtual sessions will work towards the same session. As long as your SDK program is doing mostly reads and not spend to much time writing or on blocking operations you can have quite a large number of virtual sessions without increasing the size of the session pool. Our recommendation is that you start by setting the number of sessions parameter to zero and increase it if you start experiencing slowdowns.
See Also
SessionClose
Closes a session.
HPMError SessionClose (
    void * _pSession
    );
Parameters
_pSession
[in] A connected session. See SessionOpen.
Return Value
Returns an error code. See EHPMError.
Comments
When you close the session eventual memory leaks will be displayed if you specified to have debugging enabled when you opened the session.
See Also
SessionStop
Stops a session.
HPMError SessionStop (
    void * _pSession
    );
Parameters
_pSession
[in] A connected session. See SessionOpen.
Return Value
Returns an error code. See EHPMError.
Comments
After SessionStop has been called on a session all functions called on the session will return the disconnected attribute. All current functions that are running will also return a timout. You don't have to call this functions before SessionClose, but it can be useful in case you need to wait for threads to quit before calling SessionClose.
See Also
SessionProcess
Does deferred processing in the SDK.
HPMError SessionProcess (
    void * _pSession
    );
Parameters
_pSession
[in] A connected session. See SessionOpen.
Return Value
Returns an error code. See EHPMError.
Comments
This function calls any callbacks that you have specified. You need to call this function periodically or when the semaphore specified in SessionOpen is signaled.
See Also
ObjectFree
Frees an object returned by the SDK.
HPMError ObjectFree (
    void * _pSession,
    const void * _pObject,
    HPMInt32 * _pDeleted
    );
Parameters
_pSession
[in] A connected session. See SessionOpen.
_pObject
[in] The object to free.
_pDeleted
[out] Set to 1 if the object was deleted (ref count went to 0).
Return Value
Returns an error code. See EHPMError.
Comments
You need to call this function on any objects that have been returned from the SDK or memory leaks will result. To debug memory leaks specify the debug flag when you call SessionOpen.
See Also
ObjectAddRef
Adds a reference to an object returned by the SDK.
HPMError ObjectAddRef (
    void * _pSession,
    const void * _pObject
    );
Parameters
_pSession
[in] A connected session. See SessionOpen.
_pObject
[in] The object to add a reference to.
Return Value
Returns an error code. See EHPMError.
See Also
ObjectGetRef
Gets the reference count of an object returned by the SDK.
HPMError ObjectGetRef (
    void * _pSession,
    const void * _pObject,
    HPMUInt32 * _pRefCount
    );
Parameters
_pSession
[in] A connected session. See SessionOpen.
_pObject
[in] The object to get the reference count for.
_pRefCount
[out] The reference count of the object.
Return Value
Returns an error code. See EHPMError.
See Also
ObjectCompare
Compares two SDK objects.
HPMError ObjectCompare (
    void * _pSession,
    const void * _pObjectLeft,
    const void * _pObjectRight,
    HPMInt32 * _pReturn
    );
Parameters
_pSession
[in] A connected session. See SessionOpen.
_pObjectLeft
[in] The first object to compare.
_pObjectRight
[in] The second object to compare.
_pReturn
[out] The return value from the comparison. If left is less than right return is -1, if left is greater than right return is 1, if equals return is 0.
Return Value
Returns an error code. See EHPMError.
See Also
MemoryFree
Frees an external object that has had its memory allocated by the SDK. Currently used by the SessionOpen._pExtendedErrorMessage parameter
HPMError MemoryFree (
    void * _pMemory
    );
Parameters
_pMemory
[in] The object to free.
Return Value
Returns an error code. See EHPMError.
Comments
You need to call this function on any objects that have memory allocated from the SDK or memory leaks will result.
See Also
UtilGetColumnHash
Calculates the column hash of a custom column.
HPMError UtilGetColumnHash (
    void * _pSession,
    const HPMProjectCustomColumnsColumn * _pColumn,
    HPMUInt32 * _pColumnHash
    );
Parameters
_pSession
[in] A connected session. See SessionOpen.
_pColumn
[in] The column to calculate the hash of. See HPMProjectCustomColumnsColumn
_pColumnHash
[out] The returned column hash.
Return Value
Returns an error code. See EHPMError.
Comments
The column hash is used to identify a custom column. When new columns are created you need to make sure that the hash value doesn't collide with any other column hashes in all projects of the database, otherwise unexpected things will happen when data is copy/pasted between projects.
See Also
HPMSdkFunctions, HPMProjectCustomColumnsColumn
UtilIsIDValid
Checks if an unique identifier is valid in the database.
HPMError UtilIsIDValid (
    void * _pSession,
    HPMUniqueID _ID,
    HPMInt32 * _pReturn
    );
Parameters
_pSession
[in] A connected session. See SessionOpen.
_ID
[in] The unique identifier to check the validity of.
_pReturn
[out] Returns 1 if the identifier is valid 0 otherwise.
Return Value
Returns an error code. See EHPMError.
See Also
UtilIsIDTask
Checks if a unique identifier is a task identifier.
HPMError UtilIsIDTask (
    void * _pSession,
    HPMUniqueID _ID,
    HPMInt32 * _pReturn
    );
Parameters
_pSession
[in] A connected session. See SessionOpen.
_ID
[in] The unique identifier to check if it is a task.
_pReturn
[out] Returns 1 if the identifier is a Task 0 otherwise.
Return Value
Returns an error code. See EHPMError.
See Also
UtilIsIDTaskRef
Checks if a unique identifier is a task reference identifier.
HPMError UtilIsIDTaskRef (
    void * _pSession,
    HPMUniqueID _ID,
    HPMInt32 * _pReturn
    );
Parameters
_pSession
[in] A connected session. See SessionOpen.
_ID
[in] The unique identifier to check if it is a task reference.
_pReturn
[out] Returns 1 if the identifier is a task reference 0 otherwise.
Return Value
Returns an error code. See EHPMError.
See Also
UtilIsIDProject
Checks if a unique identifier is a project identifier.
HPMError UtilIsIDProject (
    void * _pSession,
    HPMUniqueID _ID,
    HPMInt32 * _pReturn
    );
Parameters
_pSession
[in] A connected session. See SessionOpen.
_ID
[in] The unique identifier to check if it is a project.
_pReturn
[out] Returns 1 if the identifier is a project 0 otherwise.
Return Value
Returns an error code. See EHPMError.
See Also
UtilIsIDBacklogProject
Checks if a unique identifier is a backlog project identifier.
HPMError UtilIsIDBacklogProject (
    void * _pSession,
    HPMUniqueID _ID,
    HPMInt32 * _pReturn
    );
Parameters
_pSession
[in] A connected session. See SessionOpen.
_ID
[in] The unique identifier to check if it is a backlog project.
_pReturn
[out] Returns 1 if the identifier is a backlog 0 otherwise.
Return Value
Returns an error code. See EHPMError.
See Also
UtilIsIDQAProject
Checks if a unique identifier is a QA project identifier.
HPMError UtilIsIDQAProject (
    void * _pSession,
    HPMUniqueID _ID,
    HPMInt32 * _pReturn
    );
Parameters
_pSession
[in] A connected session. See SessionOpen.
_ID
[in] The unique identifier to check if it is a QA project.
_pReturn
[out] Returns 1 if the identifier is a QA project 0 otherwise.
Return Value
Returns an error code. See EHPMError.
See Also
UtilIsIDResource
Checks if a unique identifier is a resource identifier.
HPMError UtilIsIDResource (
    void * _pSession,
    HPMUniqueID _ID,
    HPMInt32 * _pReturn
    );
Parameters
_pSession
[in] A connected session. See SessionOpen.
_ID
[in] The unique identifier to check if it is a resource.
_pReturn
[out] Returns 1 if the identifier is a resource 0 otherwise.
Return Value
Returns an error code. See EHPMError.
See Also
UtilDecodeCustomChoiceValue
Used to decode custom choices produced by automatically filled in lists in a custom dialog.
HPMError UtilDecodeCustomChoiceValue (
    void * _pSession,
    const HPMChar * _pValue,
    const HPMCustomChoiceValue * * _pDecodedValue
    );
Parameters
_pSession
[in] A connected session. See SessionOpen.
_pValue
[in] The value to decode.
_pDecodedValue
[out] Pointer to a pointer of a HPMCustomChoiceValue object, representing the returned data.
Return Value
Returns an error code. See EHPMError.
Comments
The returned object must be freed with ObjectFree or a memory leak will result.
See Also
HPMSdkFunctions, HPMCustomChoiceValue
UtilDecodeCustomColumnResourcesValue
Used to decode the value of a custom column when the type of custom column is EHPMProjectCustomColumnsColumnType_Resources.
HPMError UtilDecodeCustomColumnResourcesValue (
    void * _pSession,
    const HPMChar * _pValue,
    const HPMResourceDefinitionList * * _pDecodedValue
    );
Parameters
_pSession
[in] A connected session. See SessionOpen.
_pValue
[in] The value to decode.
_pDecodedValue
[out] Pointer to a pointer of a HPMResourceDefinitionList object, representing the returned data.
Return Value
Returns an error code. See EHPMError.
Comments
The returned object must be freed with ObjectFree or a memory leak will result.
See Also
HPMSdkFunctions, HPMResourceDefinitionList, EHPMProjectCustomColumnsColumnType
UtilEncodeCustomColumnResourcesValue
Used to encode the value of a custom column when the type of custom column is EHPMProjectCustomColumnsColumnType_Resources.
HPMError UtilEncodeCustomColumnResourcesValue (
    void * _pSession,
    const HPMResourceDefinitionList * _pResources,
    HPMUniqueID _ProjectID,
    const HPMString * * _pRsourceString
    );
Parameters
_pSession
[in] A connected session. See SessionOpen.
_pResources
[in] The value to encode.
_ProjectID
[in] The unique id of the project of the custom column.
_pRsourceString
[out] Pointer to a pointer of a HPMString object, representing the encoded data.
Return Value
Returns an error code. See EHPMError.
Comments
The returned object must be freed with ObjectFree or a memory leak will result.
See Also
HPMSdkFunctions, HPMResourceDefinitionList, EHPMProjectCustomColumnsColumnType
UtilDecodeCustomColumnDateTimeValue
Used to decode the value of a custom column when the type of custom column is EHPMProjectCustomColumnsColumnType_DateTime.
HPMError UtilDecodeCustomColumnDateTimeValue (
    void * _pSession,
    const HPMChar * _pValue,
    HPMUInt64 * _pDateTime
    );
Parameters
_pSession
[in] A connected session. See SessionOpen.
_pValue
[in] The value to decode.
_pDateTime
[out] Pointer to a variable representing the returned data. This is the number of micro seconds since 1970 UTC.
Return Value
Returns an error code. See EHPMError.
See Also
HPMSdkFunctions, EHPMProjectCustomColumnsColumnType
UtilEncodeCustomColumnDateTimeValue
Used to encode the value of a custom column when the type of custom column is EHPMProjectCustomColumnsColumnType_DateTime.
HPMError UtilEncodeCustomColumnDateTimeValue (
    void * _pSession,
    HPMUInt64 _DateTime,
    const HPMString * * _pTimeString
    );
Parameters
_pSession
[in] A connected session. See SessionOpen.
_DateTime
[in] The value to encode. This is the number of micro seconds since 1970 UTC.
_pTimeString
[out] Pointer to a pointer of a HPMString object, representing the encoded data.
Return Value
Returns an error code. See EHPMError.
Comments
The returned object must be freed with ObjectFree or a memory leak will result.
See Also
HPMSdkFunctions, EHPMProjectCustomColumnsColumnType
UtilGetRealProjectIDFromProjectID
Gets the unique identifier of the real project associated with a project. For example you might send in the identifier of a QA or backlog project to get the real project they belong to back. If you send in a unique identifier to a real project the same identifier will be returned.
HPMError UtilGetRealProjectIDFromProjectID (
    void * _pSession,
    HPMUniqueID _ID,
    HPMUniqueID * _pReturn
    );
Parameters
_pSession
[in] A connected session. See SessionOpen.
_ID
[in] The unique identifier of the project to get the real project for.
_pReturn
[out] The unique identifier of the project. If the function fails the return value is -1.
Return Value
Returns an error code. See EHPMError.
See Also
UtilGetLastErrorDescription
Gets a more detailed description for the last occurred error.
HPMError UtilGetLastErrorDescription (
    void * _pSession,
    const HPMString * * _pData
    );
Parameters
_pSession
[in] A connected session. See SessionOpen.
_pData
[out] Pointer to a pointer of a HPMString object, representing the returned data.
Return Value
Returns an error code. See EHPMError.
Comments
The returned object must be freed with ObjectFree or a memory leak will result. Only some errors will change the value of the last error description, check EHPMError for more information. The last error is stored per thread, so you must call this function from the thread where you called the function that returned an error.
See Also
HPMSdkFunctions, ObjectFree, HPMString, EHPMError
ChatHistoryGetHistory
Gets chat data history for a chat room.
HPMError ChatHistoryGetHistory (
    void * _pSession,
    const HPMChatRoom * _pChatRoom,
    HPMUInt64 _StartTime,
    HPMUInt64 _EndTime,
    const HPMDataHistory * * _pHistory
    );
Parameters
_pSession
[in] A connected session. See SessionOpen.
_pChatRoom
[in] The chat room identifier to get history for. See HPMChatRoom.
_StartTime
[in] The start time to query history entries for. Expressed as the number of micro seconds since 1970 UTC. Set to 0 to have unbounded start time.
_EndTime
[in] The end time to queriy history entries for. Expressed as the number of micro seconds since 1970 UTC. Set to 0 to have unbounded end time.
_pHistory
[out] Pointer to a pointer of a HPMDataHistory object, representing the returned data.
Return Value
Returns an error code. See EHPMError. The function might return EHPMError_DataNotYetAvailable if the history data hasn't been requsted before. If it have been requested before it might be available in the cache and the function will return EHPMError_NoError.
Comments
The returned object must be freed with ObjectFree or a memory leak will result. When first calling this function for a specific set of data this function will return EHPMError_DataNotYetAvailable and you will have to wait for the data to be downloaded from the server. You can either poll the function until it returns EHPMError_NoError or register a callback with RegisterChangeCallback and wait for the EHPMChangeCallbackOperation_DataHistoryReceived callback to be received.
See Also
HPMSdkFunctions, ObjectFree, HPMDataHistory
DataHistoryGetHistory
Gets data history for an object.
HPMError DataHistoryGetHistory (
    void * _pSession,
    const HPMDataHistoryGetHistoryParameters * _pParameters,
    const HPMDataHistory * * _pHistory
    );
Parameters
_pSession
[in] A connected session. See SessionOpen.
_pParameters
[in] The parameters to apply to the data history search. See HPMDataHistoryGetHistoryParameters.
_pHistory
[out] Pointer to a pointer of a HPMDataHistory object, representing the returned data.
Return Value
Returns an error code. See EHPMError. The function might return EHPMError_DataNotYetAvailable if the history data hasn't been requsted before. If it have been requested before it might be available in the cache and the function will return EHPMError_NoError.
Comments
The returned object must be freed with ObjectFree or a memory leak will result. This function is used to retrieve task history for tasks as well as sampled statistics information. When first calling this function for a specific set of data this function will return EHPMError_DataNotYetAvailable and you will have to wait for the data to be downloaded from the server. You can either poll the function until it returns EHPMError_NoError or register a callback with RegisterChangeCallback and wait for the EHPMChangeCallbackOperation_DataHistoryReceived callback to be received.
See Also
HPMSdkFunctions, ObjectFree, HPMDataHistory, HPMDataHistoryGetHistoryParameters
DataHistoryGetEntryData
Get a data in a data history entry variant data. See HPMVariantData.
HPMError DataHistoryGetEntryData (
    void * _pSession,
    const HPMDataHistory * _pHistory,
    HPMUInt32 _Index,
    const HPMVariantData * * _pData
    );
Parameters
_pSession
[in] A connected session. See SessionOpen.
_pHistory
[in] Pointer to the history to retrieve data for.
_Index
[in] The index of the history entry to get data for.
_pData
[out] Pointer to a pointer of a HPMVariantData object, representing the returned data.
Return Value
Returns an error code. See EHPMError.
Comments
The returned object must be freed with ObjectFree or a memory leak will result. Make sure that the _pHistory parameter is a pointer returned by DataHistoryGetHistory and that the history list hasn't been freed yet.
See Also
HPMSdkFunctions, HPMDataHistory, DataHistoryGetHistory, HPMVariantData
DataHistorySetMaxCacheEntries
Sets the max number of data history entries that are cached in memory on the client.
HPMError DataHistorySetMaxCacheEntries (
    void * _pSession,
    HPMUInt32 _MaxCacheEntries
    );
Parameters
_pSession
[in] A connected session. See SessionOpen.
_MaxCacheEntries
[in] The maximum number of data history entries that will be cached on the client.
Return Value
Returns an error code. See EHPMError.
See Also
HPMSdkFunctions, DataHistoryGetHistory
VariantDecode_HPMInt32
Decode variant data as HPMInt32.
HPMError VariantDecode_HPMInt32 (
    void * _pSession,
    const HPMVariantData * _pVariantData,
    HPMInt32 * _pData
    );
Parameters
_pSession
[in] A connected session. See SessionOpen.
_pVariantData
[in] Pointer to the variant data to decode. See HPMVariantData.
_pData
[out] Pointer to the variable representing the returned data.
Return Value
Returns an error code. See EHPMError. If the data cannot be converted to the requested format EHPMError_ConversionNotSupported is returned.
See Also
HPMSdkFunctions, HPMVariantData, HPMInt32
VariantDecode_HPMUInt32
Get variant data as HPMUInt32.
HPMError VariantDecode_HPMUInt32 (
    void * _pSession,
    const HPMVariantData * _pVariantData,
    HPMUInt32 * _pData
    );
Parameters
_pSession
[in] A connected session. See SessionOpen.
_pVariantData
[in] Pointer to the variant data to decode. See HPMVariantData.
_pData
[out] Pointer to the variable representing the returned data.
Return Value
Returns an error code. See EHPMError. If the data cannot be converted to the requested format EHPMError_ConversionNotSupported is returned.
See Also
HPMSdkFunctions, HPMVariantData, HPMUInt32
VariantDecode_HPMInt64
Get variant data as HPMInt64.
HPMError VariantDecode_HPMInt64 (
    void * _pSession,
    const HPMVariantData * _pVariantData,
    HPMInt64 * _pData
    );
Parameters
_pSession
[in] A connected session. See SessionOpen.
_pVariantData
[in] Pointer to the variant data to decode. See HPMVariantData.
_pData
[out] Pointer to the variable representing the returned data.
Return Value
Returns an error code. See EHPMError. If the data cannot be converted to the requested format EHPMError_ConversionNotSupported is returned.
See Also
HPMSdkFunctions, HPMVariantData, HPMInt64
VariantDecode_HPMUInt64
Get variant data as HPMUInt64.
HPMError VariantDecode_HPMUInt64 (
    void * _pSession,
    const HPMVariantData * _pVariantData,
    HPMUInt64 * _pData
    );
Parameters
_pSession
[in] A connected session. See SessionOpen.
_pVariantData
[in] Pointer to the variant data to decode. See HPMVariantData.
_pData
[out] Pointer to the variable representing the returned data.
Return Value
Returns an error code. See EHPMError. If the data cannot be converted to the requested format EHPMError_ConversionNotSupported is returned.
See Also
HPMSdkFunctions, HPMVariantData, HPMUInt64
VariantDecode_HPMFP32
Get variant data as HPMFP32.
HPMError VariantDecode_HPMFP32 (
    void * _pSession,
    const HPMVariantData * _pVariantData,
    HPMFP32 * _pData
    );
Parameters
_pSession
[in] A connected session. See SessionOpen.
_pVariantData
[in] Pointer to the variant data to decode. See HPMVariantData.
_pData
[out] Pointer to the variable representing the returned data.
Return Value
Returns an error code. See EHPMError. If the data cannot be converted to the requested format EHPMError_ConversionNotSupported is returned.
See Also
HPMSdkFunctions, HPMVariantData, HPMFP32
VariantDecode_HPMFP64
Get variant data as HPMFP64.
HPMError VariantDecode_HPMFP64 (
    void * _pSession,
    const HPMVariantData * _pVariantData,
    HPMFP64 * _pData
    );
Parameters
_pSession
[in] A connected session. See SessionOpen.
_pVariantData
[in] Pointer to the variant data to decode. See HPMVariantData.
_pData
[out] Pointer to the variable representing the returned data.
Return Value
Returns an error code. See EHPMError. If the data cannot be converted to the requested format EHPMError_ConversionNotSupported is returned.
See Also
HPMSdkFunctions, HPMVariantData, HPMFP64
VariantDecode_HPMUniqueID
Get variant data as HPMUniqueID.
HPMError VariantDecode_HPMUniqueID (
    void * _pSession,
    const HPMVariantData * _pVariantData,
    HPMUniqueID * _pData
    );
Parameters
_pSession
[in] A connected session. See SessionOpen.
_pVariantData
[in] Pointer to the variant data to decode. See HPMVariantData.
_pData
[out] Pointer to the variable representing the returned data.
Return Value
Returns an error code. See EHPMError. If the data cannot be converted to the requested format EHPMError_ConversionNotSupported is returned.
See Also
HPMSdkFunctions, HPMVariantData, HPMUniqueID
VariantDecode_HPMString
Get variant data as HPMString.
HPMError VariantDecode_HPMString (
    void * _pSession,
    const HPMVariantData * _pVariantData,
    const HPMString * * _pData
    );
Parameters
_pSession
[in] A connected session. See SessionOpen.
_pVariantData
[in] Pointer to the variant data to decode. See HPMVariantData.
_pData
[out] Pointer to a pointer of a HPMString object, representing the returned data.
Return Value
Returns an error code. See EHPMError. If the data cannot be converted to the requested format EHPMError_ConversionNotSupported is returned.
Comments
The returned object must be freed with ObjectFree or a memory leak will result.
See Also
HPMSdkFunctions, ObjectFree, HPMVariantData, HPMString
VariantDecode_HPMTaskLinkedToMilestones
Get variant data as HPMTaskLinkedToMilestones.
HPMError VariantDecode_HPMTaskLinkedToMilestones (
    void * _pSession,
    const HPMVariantData * _pVariantData,
    const HPMTaskLinkedToMilestones * * _pData
    );
Parameters
_pSession
[in] A connected session. See SessionOpen.
_pVariantData
[in] Pointer to the variant data to decode. See HPMVariantData.
_pData
[out] Pointer to a pointer of a HPMTaskLinkedToMilestones object, representing the returned data.
Return Value
Returns an error code. See EHPMError. If the data cannot be converted to the requested format EHPMError_ConversionNotSupported is returned.
Comments
The returned object must be freed with ObjectFree or a memory leak will result.
See Also
HPMSdkFunctions, HPMVariantData, HPMTaskLinkedToMilestones
VariantDecode_HPMTaskDelegateTo
Get variant data as HPMResourceDefinitionList.
HPMError VariantDecode_HPMTaskDelegateTo (
    void * _pSession,
    const HPMVariantData * _pVariantData,
    const HPMResourceDefinitionList * * _pData
    );
Parameters
_pSession
[in] A connected session. See SessionOpen.
_pVariantData
[in] Pointer to the variant data to decode. See HPMVariantData.
_pData
[out] Pointer to a pointer of a HPMResourceDefinitionList object, representing the returned data.
Return Value
Returns an error code. See EHPMError. If the data cannot be converted to the requested format EHPMError_ConversionNotSupported is returned.
Comments
The returned object must be freed with ObjectFree or a memory leak will result.
See Also
HPMSdkFunctions, ObjectFree, HPMVariantData, HPMResourceDefinitionList
VariantDecode_HPMTaskSprintAllocatedResources
Get variant data as HPMTaskSprintAllocatedResources.
HPMError VariantDecode_HPMTaskSprintAllocatedResources (
    void * _pSession,
    const HPMVariantData * _pVariantData,
    const HPMTaskSprintAllocatedResources * * _pData
    );
Parameters
_pSession
[in] A connected session. See SessionOpen.
_pVariantData
[in] Pointer to the variant data to decode. See HPMVariantData.
_pData
[out] Pointer to a pointer of a HPMTaskSprintAllocatedResources object, representing the returned data.
Return Value
Returns an error code. See EHPMError. If the data cannot be converted to the requested format EHPMError_ConversionNotSupported is returned.
Comments
The returned object must be freed with ObjectFree or a memory leak will result.
See Also
HPMSdkFunctions, ObjectFree, HPMVariantData, HPMTaskSprintAllocatedResources
VariantDecode_HPMTaskVisibleTo
Get variant data as HPMResourceDefinitionList.
HPMError VariantDecode_HPMTaskVisibleTo (
    void * _pSession,
    const HPMVariantData * _pVariantData,
    const HPMResourceDefinitionList * * _pData
    );
Parameters
_pSession
[in] A connected session. See SessionOpen.
_pVariantData
[in] Pointer to the variant data to decode. See HPMVariantData.
_pData
[out] Pointer to a pointer of a HPMResourceDefinitionList object, representing the returned data.
Return Value
Returns an error code. See EHPMError. If the data cannot be converted to the requested format EHPMError_ConversionNotSupported is returned.
Comments
The returned object must be freed with ObjectFree or a memory leak will result.
See Also
HPMSdkFunctions, ObjectFree, HPMVariantData, HPMResourceDefinitionList
VariantDecode_HPMTaskResourceAllocation
Get variant data as HPMTaskResourceAllocation.
HPMError VariantDecode_HPMTaskResourceAllocation (
    void * _pSession,
    const HPMVariantData * _pVariantData,
    const HPMTaskResourceAllocation * * _pData
    );
Parameters
_pSession
[in] A connected session. See SessionOpen.
_pVariantData
[in] Pointer to the variant data to decode. See HPMVariantData.
_pData
[out] Pointer to a pointer of a HPMTaskResourceAllocation object, representing the returned data.
Return Value
Returns an error code. See EHPMError. If the data cannot be converted to the requested format EHPMError_ConversionNotSupported is returned.
Comments
The returned object must be freed with ObjectFree or a memory leak will result.
See Also
HPMSdkFunctions, ObjectFree, HPMVariantData, HPMTaskResourceAllocation
VariantDecode_HPMStatisticsMultiFrequency
Get variant data as HPMStatisticsMultiFrequency.
HPMError VariantDecode_HPMStatisticsMultiFrequency (
    void * _pSession,
    const HPMVariantData * _pVariantData,
    const HPMStatisticsMultiFrequency * * _pData
    );
Parameters
_pSession
[in] A connected session. See SessionOpen.
_pVariantData
[in] Pointer to the variant data to decode. See HPMVariantData.
_pData
[out] Pointer to a pointer of a HPMStatisticsMultiFrequency object, representing the returned data.
Return Value
Returns an error code. See EHPMError. If the data cannot be converted to the requested format EHPMError_ConversionNotSupported is returned.
Comments
The returned object must be freed with ObjectFree or a memory leak will result.
See Also
HPMSdkFunctions, ObjectFree, HPMVariantData, HPMStatisticsMultiFrequency
VariantDecode_HPMStatisticsCustomStatisticsFrequency
Get variant data as HPMStatisticsCustomStatisticsFrequency.
HPMError VariantDecode_HPMStatisticsCustomStatisticsFrequency (
    void * _pSession,
    const HPMVariantData * _pVariantData,
    const HPMStatisticsCustomStatisticsFrequency * * _pData
    );
Parameters
_pSession
[in] A connected session. See SessionOpen.
_pVariantData
[in] Pointer to the variant data to decode. See HPMVariantData.
_pData
[out] Pointer to a pointer of a HPMStatisticsCustomStatisticsFrequency object, representing the returned data.
Return Value
Returns an error code. See EHPMError. If the data cannot be converted to the requested format EHPMError_ConversionNotSupported is returned.
Comments
The returned object must be freed with ObjectFree or a memory leak will result.
See Also
HPMSdkFunctions, ObjectFree, HPMVariantData, HPMStatisticsCustomStatisticsFrequency
VariantDecode_HPMTaskAttachedDocuments
Get variant data as HPMTaskAttachedDocuments.
HPMError VariantDecode_HPMTaskAttachedDocuments (
    void * _pSession,
    const HPMVariantData * _pVariantData,
    const HPMTaskAttachedDocuments * * _pData
    );
Parameters
_pSession
[in] A connected session. See SessionOpen.
_pVariantData
[in] Pointer to the variant data to decode. See HPMVariantData.
_pData
[out] Pointer to a pointer of a HPMTaskAttachedDocuments object, representing the returned data.
Return Value
Returns an error code. See EHPMError. If the data cannot be converted to the requested format EHPMError_ConversionNotSupported is returned.
Comments
The returned object must be freed with ObjectFree or a memory leak will result.
See Also
HPMSdkFunctions, ObjectFree, HPMVariantData, HPMTaskAttachedDocuments
VariantDecode_HPMTaskVacationOptions
Get variant data as HPMTaskVacationOptions.
HPMError VariantDecode_HPMTaskVacationOptions (
    void * _pSession,
    const HPMVariantData * _pVariantData,
    const HPMTaskVacationOptions * * _pData
    );
Parameters
_pSession
[in] A connected session. See SessionOpen.
_pVariantData
[in] Pointer to the variant data to decode. See HPMVariantData.
_pData
[out] Pointer to a pointer of a HPMTaskVacationOptions object, representing the returned data.
Return Value
Returns an error code. See EHPMError. If the data cannot be converted to the requested format EHPMError_ConversionNotSupported is returned.
Comments
The returned object must be freed with ObjectFree or a memory leak will result.
See Also
HPMSdkFunctions, ObjectFree, HPMVariantData, HPMTaskVacationOptions
VariantDecode_HPMTaskCommentsOptions
Get variant data as HPMTaskCommentsOptions.
HPMError VariantDecode_HPMTaskCommentsOptions (
    void * _pSession,
    const HPMVariantData * _pVariantData,
    const HPMTaskCommentsOptions * * _pData
    );
Parameters
_pSession
[in] A connected session. See SessionOpen.
_pVariantData
[in] Pointer to the variant data to decode. See HPMVariantData.
_pData
[out] Pointer to a pointer of a HPMTaskCommentsOptions object, representing the returned data.
Return Value
Returns an error code. See EHPMError. If the data cannot be converted to the requested format EHPMError_ConversionNotSupported is returned.
Comments
The returned object must be freed with ObjectFree or a memory leak will result.
See Also
HPMSdkFunctions, ObjectFree, HPMVariantData, HPMTaskCommentsOptions
VariantDecode_HPMTaskLinkedTo
Get variant data as HPMTaskLinkedTo.
HPMError VariantDecode_HPMTaskLinkedTo (
    void * _pSession,
    const HPMVariantData * _pVariantData,
    const HPMTaskLinkedTo * * _pData
    );
Parameters
_pSession
[in] A connected session. See SessionOpen.
_pVariantData
[in] Pointer to the variant data to decode. See HPMVariantData.
_pData
[out] Pointer to a pointer of a HPMTaskLinkedTo object, representing the returned data.
Return Value
Returns an error code. See EHPMError. If the data cannot be converted to the requested format EHPMError_ConversionNotSupported is returned.
Comments
The returned object must be freed with ObjectFree or a memory leak will result.
See Also
HPMSdkFunctions, ObjectFree, HPMVariantData, HPMTaskLinkedTo
VariantDecode_HPMTaskSprintResourceAllocation
Get variant data as HPMTaskSprintResourceAllocation.
HPMError VariantDecode_HPMTaskSprintResourceAllocation (
    void * _pSession,
    const HPMVariantData * _pVariantData,
    const HPMTaskSprintResourceAllocation * * _pData
    );
Parameters
_pSession
[in] A connected session. See SessionOpen.
_pVariantData
[in] Pointer to the variant data to decode. See HPMVariantData.
_pData
[out] Pointer to a pointer of a HPMTaskSprintResourceAllocation object, representing the returned data.
Return Value
Returns an error code. See EHPMError. If the data cannot be converted to the requested format EHPMError_ConversionNotSupported is returned.
Comments
The returned object must be freed with ObjectFree or a memory leak will result.
See Also
HPMSdkFunctions, ObjectFree, HPMVariantData, HPMTaskSprintResourceAllocation
VariantDecode_HPMDataHistoryTaskCreated
Get variant data as HPMDataHistoryTaskCreated.
HPMError VariantDecode_HPMDataHistoryTaskCreated (
    void * _pSession,
    const HPMVariantData * _pVariantData,
    const HPMDataHistoryTaskCreated * * _pData
    );
Parameters
_pSession
[in] A connected session. See SessionOpen.
_pVariantData
[in] Pointer to the variant data to decode. See HPMVariantData.
_pData
[out] Pointer to a pointer of a HPMDataHistoryTaskCreated object, representing the returned data.
Return Value
Returns an error code. See EHPMError. If the data cannot be converted to the requested format EHPMError_ConversionNotSupported is returned.
Comments
The returned object must be freed with ObjectFree or a memory leak will result.
See Also
HPMSdkFunctions, ObjectFree, HPMVariantData, HPMDataHistoryTaskCreated
VariantDecode_HPMDataHistoryTaskRestoredFromHistory
Get variant data as HPMDataHistoryTaskRestoredFromHistory.
HPMError VariantDecode_HPMDataHistoryTaskRestoredFromHistory (
    void * _pSession,
    const HPMVariantData * _pVariantData,
    const HPMDataHistoryTaskRestoredFromHistory * * _pData
    );
Parameters
_pSession
[in] A connected session. See SessionOpen.
_pVariantData
[in] Pointer to the variant data to decode. See HPMVariantData.
_pData
[out] Pointer to a pointer of a HPMDataHistoryTaskRestoredFromHistory object, representing the returned data.
Return Value
Returns an error code. See EHPMError. If the data cannot be converted to the requested format EHPMError_ConversionNotSupported is returned.
Comments
The returned object must be freed with ObjectFree or a memory leak will result.
See Also
HPMSdkFunctions, ObjectFree, HPMVariantData, HPMDataHistoryTaskRestoredFromHistory
VariantDecode_HPMDataHistoryTaskMoved
Get variant data as HPMDataHistoryTaskMoved.
HPMError VariantDecode_HPMDataHistoryTaskMoved (
    void * _pSession,
    const HPMVariantData * _pVariantData,
    const HPMDataHistoryTaskMoved * * _pData
    );
Parameters
_pSession
[in] A connected session. See SessionOpen.
_pVariantData
[in] Pointer to the variant data to decode. See HPMVariantData.
_pData
[out] Pointer to a pointer of a HPMDataHistoryTaskMoved object, representing the returned data.
Return Value
Returns an error code. See EHPMError. If the data cannot be converted to the requested format EHPMError_ConversionNotSupported is returned.
Comments
The returned object must be freed with ObjectFree or a memory leak will result.
See Also
HPMSdkFunctions, ObjectFree, HPMVariantData, HPMDataHistoryTaskMoved
VariantDecode_HPMDataHistoryTaskRenameCustomColumn
Get variant data as HPMDataHistoryTaskRenameCustomColumn.
HPMError VariantDecode_HPMDataHistoryTaskRenameCustomColumn (
    void * _pSession,
    const HPMVariantData * _pVariantData,
    const HPMDataHistoryTaskRenameCustomColumn * * _pData
    );
Parameters
_pSession
[in] A connected session. See SessionOpen.
_pVariantData
[in] Pointer to the variant data to decode. See HPMVariantData.
_pData
[out] Pointer to a pointer of a HPMDataHistoryTaskRenameCustomColumn object, representing the returned data.
Return Value
Returns an error code. See EHPMError. If the data cannot be converted to the requested format EHPMError_ConversionNotSupported is returned.
Comments
The returned object must be freed with ObjectFree or a memory leak will result.
See Also
HPMSdkFunctions, ObjectFree, HPMVariantData, HPMDataHistoryTaskRenameCustomColumn
VariantDecode_HPMDataHistoryTaskProxyCreated
Get variant data as HPMDataHistoryTaskProxyCreated.
HPMError VariantDecode_HPMDataHistoryTaskProxyCreated (
    void * _pSession,
    const HPMVariantData * _pVariantData,
    const HPMDataHistoryTaskProxyCreated * * _pData
    );
Parameters
_pSession
[in] A connected session. See SessionOpen.
_pVariantData
[in] Pointer to the variant data to decode. See HPMVariantData.
_pData
[out] Pointer to a pointer of a HPMDataHistoryTaskProxyCreated object, representing the returned data.
Return Value
Returns an error code. See EHPMError. If the data cannot be converted to the requested format EHPMError_ConversionNotSupported is returned.
Comments
The returned object must be freed with ObjectFree or a memory leak will result.
See Also
HPMSdkFunctions, ObjectFree, HPMVariantData, HPMDataHistoryTaskProxyCreated
VariantDecode_HPMDataHistoryTaskProxyDeleted
Get variant data as HPMDataHistoryTaskProxyDeleted.
HPMError VariantDecode_HPMDataHistoryTaskProxyDeleted (
    void * _pSession,
    const HPMVariantData * _pVariantData,
    const HPMDataHistoryTaskProxyDeleted * * _pData
    );
Parameters
_pSession
[in] A connected session. See SessionOpen.
_pVariantData
[in] Pointer to the variant data to decode. See HPMVariantData.
_pData
[out] Pointer to a pointer of a HPMDataHistoryTaskProxyDeleted object, representing the returned data.
Return Value
Returns an error code. See EHPMError. If the data cannot be converted to the requested format EHPMError_ConversionNotSupported is returned.
Comments
The returned object must be freed with ObjectFree or a memory leak will result.
See Also
HPMSdkFunctions, ObjectFree, HPMVariantData, HPMDataHistoryTaskProxyDeleted
VariantDecode_HPMDataHistoryTaskRenameBoardElementInfo
Get variant data as HPMDataHistoryTaskRenameBoardElementInfo.
HPMError VariantDecode_HPMDataHistoryTaskRenameBoardElementInfo (
    void * _pSession,
    HPMVariantData const * _pVariantData,
    HPMDataHistoryTaskRenameBoardElementInfo const * * _pData
    );
Parameters
_pSession
[in] A connected session. See SessionOpen.
_pVariantData
[in] Pointer to the variant data to decode. See HPMVariantData.
_pData
[out] Pointer to a pointer of a HPMDataHistoryTaskRenameBoardElementInfo object, representing the returned data.
Return Value
Returns an error code. See EHPMError. If the data cannot be converted to the requested format EHPMError_ConversionNotSupported is returned.
Comments
The returned object must be freed with ObjectFree or a memory leak will result.
See Also
HPMSdkFunctions, ObjectFree, HPMVariantData, HPMDataHistoryTaskRenameBoardElementInfo
VariantDecode_HPMDataHistoryTaskBoardCardInfo
Get variant data as HPMDataHistoryTaskBoardCardInfo.
HPMError VariantDecode_HPMDataHistoryTaskBoardCardInfo (
    void * _pSession,
    HPMVariantData const * _pVariantData,
    HPMDataHistoryTaskBoardCardInfo const * * _pData
    );
Parameters
_pSession
[in] A connected session. See SessionOpen.
_pVariantData
[in] Pointer to the variant data to decode. See HPMVariantData.
_pData
[out] Pointer to a pointer of a HPMDataHistoryTaskRenameBoardElementInfo object, representing the returned data.
Return Value
Returns an error code. See EHPMError. If the data cannot be converted to the requested format EHPMError_ConversionNotSupported is returned.
Comments
The returned object must be freed with ObjectFree or a memory leak will result.
See Also
HPMSdkFunctions, ObjectFree, HPMVariantData, HPMDataHistoryTaskBoardCardInfo
VariantDecode_HPMTaskTimeZones
Get variant data as HPMTaskTimeZones.
HPMError VariantDecode_HPMTaskTimeZones (
    void * _pSession,
    const HPMVariantData * _pVariantData,
    const HPMTaskTimeZones * * _pData
    );
Parameters
_pSession
[in] A connected session. See SessionOpen.
_pVariantData
[in] Pointer to the variant data to decode. See HPMVariantData.
_pData
[out] Pointer to a pointer of a HPMTaskTimeZones object, representing the returned data.
Return Value
Returns an error code. See EHPMError. If the data cannot be converted to the requested format EHPMError_ConversionNotSupported is returned.
Comments
The returned object must be freed with ObjectFree or a memory leak will result.
See Also
HPMSdkFunctions, ObjectFree, HPMVariantData, HPMTaskTimeZones
VariantDecode_HPMChatMessage
Get variant data as HPMChatMessage.
HPMError VariantDecode_HPMChatMessage (
    void * _pSession,
    const HPMVariantData * _pVariantData,
    const HPMChatMessage * * _pData
    );
Parameters
_pSession
[in] A connected session. See SessionOpen.
_pVariantData
[in] Pointer to the variant data to decode. See HPMVariantData.
_pData
[out] Pointer to a pointer of a HPMChatMessage object, representing the returned data.
Return Value
Returns an error code. See EHPMError. If the data cannot be converted to the requested format EHPMError_ConversionNotSupported is returned.
Comments
The returned object must be freed with ObjectFree or a memory leak will result.
See Also
HPMSdkFunctions, ObjectFree, HPMVariantData, HPMChatMessage
VariantDecode_HPMProjectCustomColumns
Get variant data as HPMProjectCustomColumns.
HPMError VariantDecode_HPMProjectCustomColumns (
    void * _pSession,
    const HPMVariantData * _pVariantData,
    const HPMProjectCustomColumns * * _pData
    );
Parameters
_pSession
[in] A connected session. See SessionOpen.
_pVariantData
[in] Pointer to the variant data to decode. See HPMVariantData.
_pData
[out] Pointer to a pointer of a HPMProjectCustomColumns object, representing the returned data.
Return Value
Returns an error code. See EHPMError. If the data cannot be converted to the requested format EHPMError_ConversionNotSupported is returned.
Comments
The returned object must be freed with ObjectFree or a memory leak will result.
See Also
HPMSdkFunctions, ObjectFree, HPMVariantData, HPMProjectCustomColumns
VariantDecode_HPMProjectCustomColumnsColumn
Get variant data as HPMProjectCustomColumnsColumn.
HPMError VariantDecode_HPMProjectCustomColumnsColumn (
    void * _pSession,
    const HPMVariantData * _pVariantData,
    const HPMProjectCustomColumnsColumn * * _pData
    );
Parameters
_pSession
[in] A connected session. See SessionOpen.
_pVariantData
[in] Pointer to the variant data to decode. See HPMVariantData.
_pData
[out] Pointer to a pointer of a HPMProjectCustomColumnsColumn object, representing the returned data.
Return Value
Returns an error code. See EHPMError. If the data cannot be converted to the requested format EHPMError_ConversionNotSupported is returned.
Comments
The returned object must be freed with ObjectFree or a memory leak will result.
See Also
HPMSdkFunctions, ObjectFree, HPMVariantData, HPMProjectCustomColumns
VariantDecode_HPMProjectCustomColumnAncestry
Get variant data as HPMProjectCustomColumnAncestry.
HPMError VariantDecode_HPMProjectCustomColumnAncestry (
    void * _pSession,
    const HPMVariantData * _pVariantData,
    const HPMProjectCustomColumnAncestry * * _pData
    );
Parameters
_pSession
[in] A connected session. See SessionOpen.
_pVariantData
[in] Pointer to the variant data to decode. See HPMVariantData.
_pData
[out] Pointer to a pointer of a HPMProjectCustomColumnAncestry object, representing the returned data.
Return Value
Returns an error code. See EHPMError. If the data cannot be converted to the requested format EHPMError_ConversionNotSupported is returned.
Comments
The returned object must be freed with ObjectFree or a memory leak will result.
See Also
HPMSdkFunctions, ObjectFree, HPMVariantData, HPMProjectCustomColumnAncestry
VariantDecode_HPMProjectWorkflowSettings
Get variant data as HPMProjectWorkflowSettings.
HPMError VariantDecode_HPMProjectWorkflowSettings (
    void * _pSession,
    const HPMVariantData * _pVariantData,
    const HPMProjectWorkflowSettings * * _pData
    );
Parameters
_pSession
[in] A connected session. See SessionOpen.
_pVariantData
[in] Pointer to the variant data to decode. See HPMVariantData.
_pData
[out] Pointer to a pointer of a HPMProjectWorkflowSettings object, representing the returned data.
Return Value
Returns an error code. See EHPMError. If the data cannot be converted to the requested format EHPMError_ConversionNotSupported is returned.
Comments
The returned object must be freed with ObjectFree or a memory leak will result.
See Also
HPMSdkFunctions, ObjectFree, HPMVariantData, HPMProjectWorkflowSettings
VariantDecode_HPMHolidays
Get variant data as HPMHolidays.
HPMError VariantDecode_HPMHolidays (
    void * _pSession,
    const HPMVariantData * _pVariantData,
    const HPMHolidays * * _pData
    );
Parameters
_pSession
[in] A connected session. See SessionOpen.
_pVariantData
[in] Pointer to the variant data to decode. See HPMVariantData.
_pData
[out] Pointer to a pointer of a HPMHolidays object, representing the returned data.
Return Value
Returns an error code. See EHPMError. If the data cannot be converted to the requested format EHPMError_ConversionNotSupported is returned.
Comments
The returned object must be freed with ObjectFree or a memory leak will result.
See Also
HPMSdkFunctions, ObjectFree, HPMVariantData, HPMHolidays
VariantDecode_HPMWorkingDays
Get variant data as HPMWorkingDays.
HPMError VariantDecode_HPMWorkingDays (
    void * _pSession,
    const HPMVariantData * _pVariantData,
    const HPMWorkingDays * * _pData
    );
Parameters
_pSession
[in] A connected session. See SessionOpen.
_pVariantData
[in] Pointer to the variant data to decode. See HPMVariantData.
_pData
[out] Pointer to a pointer of a HPMWorkingDays object, representing the returned data.
Return Value
Returns an error code. See EHPMError. If the data cannot be converted to the requested format EHPMError_ConversionNotSupported is returned.
Comments
The returned object must be freed with ObjectFree or a memory leak will result.
See Also
HPMSdkFunctions, ObjectFree, HPMVariantData, HPMWorkingDays
VariantDecode_HPMCustomWorkingDays
Get variant data as HPMCustomWorkingDays.
HPMError VariantDecode_HPMCustomWorkingDays (
    void * _pSession,
    const HPMVariantData * _pVariantData,
    const HPMCustomWorkingDays * * _pData
    );
Parameters
_pSession
[in] A connected session. See SessionOpen.
_pVariantData
[in] Pointer to the variant data to decode. See HPMVariantData.
_pData
[out] Pointer to a pointer of a HPMCustomWorkingDays object, representing the returned data.
Return Value
Returns an error code. See EHPMError. If the data cannot be converted to the requested format EHPMError_ConversionNotSupported is returned.
Comments
The returned object must be freed with ObjectFree or a memory leak will result.
See Also
HPMSdkFunctions, ObjectFree, HPMVariantData, HPMCustomWorkingDays
VariantDecode_HPMWorkingHours
Get variant data as HPMWorkingHours.
HPMError VariantDecode_HPMWorkingHours (
    void * _pSession,
    const HPMVariantData * _pVariantData,
    const HPMWorkingHours * * _pData
    );
Parameters
_pSession
[in] A connected session. See SessionOpen.
_pVariantData
[in] Pointer to the variant data to decode. See HPMVariantData.
_pData
[out] Pointer to a pointer of a HPMWorkingHours object, representing the returned data.
Return Value
Returns an error code. See EHPMError. If the data cannot be converted to the requested format EHPMError_ConversionNotSupported is returned.
Comments
The returned object must be freed with ObjectFree or a memory leak will result.
See Also
HPMSdkFunctions, ObjectFree, HPMVariantData, HPMWorkingHours
VariantDecode_HPMCustomWorkingHours
Get variant data as HPMCustomWorkingHours.
HPMError VariantDecode_HPMCustomWorkingHours (
    void * _pSession,
    const HPMVariantData * _pVariantData,
    const HPMCustomWorkingHours * * _pData
    );
Parameters
_pSession
[in] A connected session. See SessionOpen.
_pVariantData
[in] Pointer to the variant data to decode. See HPMVariantData.
_pData
[out] Pointer to a pointer of a HPMCustomWorkingHours object, representing the returned data.
Return Value
Returns an error code. See EHPMError. If the data cannot be converted to the requested format EHPMError_ConversionNotSupported is returned.
Comments
The returned object must be freed with ObjectFree or a memory leak will result.
See Also
HPMSdkFunctions, ObjectFree, HPMVariantData, HPMCustomWorkingHours
VariantDecode_HPMProjectDefaultColumns
Get variant data as HPMProjectDefaultColumns.
HPMError VariantDecode_HPMProjectDefaultColumns (
    void * _pSession,
    const HPMVariantData * _pVariantData,
    const HPMProjectDefaultColumns * * _pData
    );
Parameters
_pSession
[in] A connected session. See SessionOpen.
_pVariantData
[in] Pointer to the variant data to decode. See HPMVariantData.
_pData
[out] Pointer to a pointer of a HPMProjectDefaultColumns object, representing the returned data.
Return Value
Returns an error code. See EHPMError. If the data cannot be converted to the requested format EHPMError_ConversionNotSupported is returned.
Comments
The returned object must be freed with ObjectFree or a memory leak will result.
See Also
HPMSdkFunctions, ObjectFree, HPMVariantData, HPMProjectDefaultColumns
VariantDecode_HPMUntranslatedString
Get variant data as HPMUntranslatedString.
HPMError VariantDecode_HPMUntranslatedString (
    void * _pSession,
    HPMVariantData const * _pVariantData,
    HPMUntranslatedString const * * _pData
    );
Parameters
_pSession
[in] A connected session. See SessionOpen.
_pVariantData
[in] Pointer to the variant data to decode. See HPMVariantData.
_pData
[out] Pointer to a pointer of a HPMUntranslatedString object, representing the returned data.
Return Value
Returns an error code. See EHPMError. If the data cannot be converted to the requested format EHPMError_ConversionNotSupported is returned.
Comments
The returned object must be freed with ObjectFree or a memory leak will result.
See Also
HPMSdkFunctions, ObjectFree, HPMVariantData, HPMUntranslatedString
VariantDecode_HPMBinaryBuffer
Get variant data as HPMBinaryBuffer.
HPMError VariantDecode_HPMBinaryBuffer (
    void * _pSession,
    HPMVariantData const * _pVariantData,
    HPMBinaryBuffer const * * _pData
    );
Parameters
_pSession
[in] A connected session. See SessionOpen.
_pVariantData
[in] Pointer to the variant data to decode. See HPMVariantData.
_pData
[out] Pointer to a pointer of a HPMBinaryBuffer object, representing the returned data.
Return Value
Returns an error code. See EHPMError. If the data cannot be converted to the requested format EHPMError_ConversionNotSupported is returned.
Comments
The returned object must be freed with ObjectFree or a memory leak will result.
See Also
HPMSdkFunctions, ObjectFree, HPMVariantData, HPMBinaryBuffer
VariantDecode_ProjectBugReportResources
Get variant data as HPMResourceDefinitionList.
HPMError VariantDecode_ProjectBugReportResources (
    void * _pSession,
    HPMVariantData const * _pVariantData,
    HPMResourceDefinitionList const * * _pData
    );
Parameters
_pSession
[in] A connected session. See SessionOpen.
_pVariantData
[in] Pointer to the variant data to decode. See HPMVariantData.
_pData
[out] Pointer to a pointer of a HPMResourceDefinitionList object, representing the returned data.
Return Value
Returns an error code. See EHPMError. If the data cannot be converted to the requested format EHPMError_ConversionNotSupported is returned.
Comments
The returned object must be freed with ObjectFree or a memory leak will result.
See Also
HPMSdkFunctions, ObjectFree, HPMVariantData
VariantDecode_HPMProjectColumnMetaData
Get variant data as HPMProjectColumnMetaData.
HPMError VariantDecode_HPMProjectColumnMetaData (
    void * _pSession,
    const HPMVariantData * _pVariantData,
    const HPMProjectColumnMetaData * * _pData
    );
Parameters
_pSession
[in] A connected session. See SessionOpen.
_pVariantData
[in] Pointer to the variant data to decode. See HPMVariantData.
_pData
[out] Pointer to a pointer of a HPMProjectColumnMetaData object, representing the returned data.
Return Value
Returns an error code. See EHPMError. If the data cannot be converted to the requested format EHPMError_ConversionNotSupported is returned.
Comments
The returned object must be freed with ObjectFree or a memory leak will result.
See Also
HPMSdkFunctions, ObjectFree, HPMVariantData, HPMProjectColumnMetaData
VariantDecode_HPMProjectViewPreset
Get variant data as HPMProjectViewPreset.
HPMError VariantDecode_HPMProjectViewPreset (
    void * _pSession,
    HPMVariantData const * _pVariantData,
    HPMProjectViewPreset const * * _pData
    );
Parameters
_pSession
[in] A connected session. See SessionOpen.
_pVariantData
[in] Pointer to the variant data to decode. See HPMVariantData.
_pData
[out] Pointer to a pointer of a HPMProjectViewPreset object, representing the returned data.
Return Value
Returns an error code. See EHPMError. If the data cannot be converted to the requested format EHPMError_ConversionNotSupported is returned.
Comments
The returned object must be freed with ObjectFree or a memory leak will result.
See Also
HPMSdkFunctions, ObjectFree, HPMVariantData
VariantDecode_HPMResourceDefinitionList
Get variant data as HPMResourceDefinitionList.
HPMError VariantDecode_HPMResourceDefinitionList (
    void * _pSession,
    HPMVariantData const * _pVariantData,
    HPMResourceDefinitionList const * * _pData
    );
Parameters
_pSession
[in] A connected session. See SessionOpen.
_pVariantData
[in] Pointer to the variant data to decode. See HPMVariantData.
_pData
[out] Pointer to a pointer of a HPMResourceDefinitionList object, representing the returned data.
Return Value
Returns an error code. See EHPMError. If the data cannot be converted to the requested format EHPMError_ConversionNotSupported is returned.
Comments
The returned object must be freed with ObjectFree or a memory leak will result.
See Also
HPMSdkFunctions, ObjectFree, HPMVariantData
VariantEncode_HPMResourceDefinitionList
Encodes HPMResourceDefinitionList as a variant.
HPMError VariantEncode_HPMResourceDefinitionList (
    void * _pSession,
    HPMResourceDefinitionList const * _pData,
    HPMVariantData const * * _pVariantData
    );
Parameters
_pSession
[in] A connected session. See SessionOpen.
_pData
[in] The data to encode as a variant.
_pVariantData
[out] Pointer to a pointer of a HPMVariantData object, representing the returned data.
Return Value
Returns an error code. See EHPMError.
Comments
The returned object must be freed with ObjectFree or a memory leak will result.
See Also
HPMSdkFunctions, HPMVariantData, HPMResourceDefinitionList
VariantEncode_HPMInt32
Encodes HPMInt32 as a variant.
HPMError VariantEncode_HPMInt32 (
    void * _pSession,
    HPMInt32 _Data,
    const HPMVariantData * * _pVariantData
    );
Parameters
_pSession
[in] A connected session. See SessionOpen.
_Data
[in] The data to encode as a variant.
_pVariantData
[out] Pointer to a pointer of a HPMVariantData object, representing the returned data.
Return Value
Returns an error code. See EHPMError.
Comments
The returned object must be freed with ObjectFree or a memory leak will result.
See Also
HPMSdkFunctions, HPMVariantData, HPMInt32
VariantEncode_HPMUInt32
Encodes HPMUInt32 as a variant.
HPMError VariantEncode_HPMUInt32 (
    void * _pSession,
    HPMUInt32 _Data,
    const HPMVariantData * * _pVariantData
    );
Parameters
_pSession
[in] A connected session. See SessionOpen.
_Data
[in] The data to encode as a variant.
_pVariantData
[out] Pointer to a pointer of a HPMVariantData object, representing the returned data.
Return Value
Returns an error code. See EHPMError.
Comments
The returned object must be freed with ObjectFree or a memory leak will result.
See Also
HPMSdkFunctions, HPMVariantData, HPMUInt32
VariantEncode_HPMInt64
Encodes HPMInt64 as a variant.
HPMError VariantEncode_HPMInt64 (
    void * _pSession,
    HPMInt64 _Data,
    const HPMVariantData * * _pVariantData
    );
Parameters
_pSession
[in] A connected session. See SessionOpen.
_Data
[in] The data to encode as a variant.
_pVariantData
[out] Pointer to a pointer of a HPMVariantData object, representing the returned data.
Return Value
Returns an error code. See EHPMError.
Comments
The returned object must be freed with ObjectFree or a memory leak will result.
See Also
HPMSdkFunctions, HPMVariantData, HPMInt64
VariantEncode_HPMUInt64
Encodes HPMUInt64 as a variant.
HPMError VariantEncode_HPMUInt64 (
    void * _pSession,
    HPMUInt64 _Data,
    const HPMVariantData * * _pVariantData
    );
Parameters
_pSession
[in] A connected session. See SessionOpen.
_Data
[in] The data to encode as a variant.
_pVariantData
[out] Pointer to a pointer of a HPMVariantData object, representing the returned data.
Return Value
Returns an error code. See EHPMError.
Comments
The returned object must be freed with ObjectFree or a memory leak will result.
See Also
HPMSdkFunctions, HPMVariantData, HPMUInt64
VariantEncode_HPMFP32
Encodes HPMFP32 as a variant.
HPMError VariantEncode_HPMFP32 (
    void * _pSession,
    HPMFP32 _Data,
    const HPMVariantData * * _pVariantData
    );
Parameters
_pSession
[in] A connected session. See SessionOpen.
_Data
[in] The data to encode as a variant.
_pVariantData
[out] Pointer to a pointer of a HPMVariantData object, representing the returned data.
Return Value
Returns an error code. See EHPMError.
Comments
The returned object must be freed with ObjectFree or a memory leak will result.
See Also
HPMSdkFunctions, HPMVariantData, HPMFP32
VariantEncode_HPMFP64
Encodes HPMFP64 as a variant.
HPMError VariantEncode_HPMFP64 (
    void * _pSession,
    HPMFP64 _Data,
    const HPMVariantData * * _pVariantData
    );
Parameters
_pSession
[in] A connected session. See SessionOpen.
_Data
[in] The data to encode as a variant.
_pVariantData
[out] Pointer to a pointer of a HPMVariantData object, representing the returned data.
Return Value
Returns an error code. See EHPMError.
Comments
The returned object must be freed with ObjectFree or a memory leak will result.
See Also
HPMSdkFunctions, HPMVariantData, HPMFP64
VariantEncode_HPMUniqueID
Encodes HPMUniqueID as a variant.
HPMError VariantEncode_HPMUniqueID (
    void * _pSession,
    HPMUniqueID _Data,
    const HPMVariantData * * _pVariantData
    );
Parameters
_pSession
[in] A connected session. See SessionOpen.
_Data
[in] The data to encode as a variant.
_pVariantData
[out] Pointer to a pointer of a HPMVariantData object, representing the returned data.
Return Value
Returns an error code. See EHPMError.
Comments
The returned object must be freed with ObjectFree or a memory leak will result.
See Also
HPMSdkFunctions, HPMVariantData, HPMUniqueID
VariantEncode_HPMString
Encodes HPMString as a variant.
HPMError VariantEncode_HPMString (
    void * _pSession,
    const HPMChar * _pData,
    const HPMVariantData * * _pVariantData
    );
Parameters
_pSession
[in] A connected session. See SessionOpen.
_pData
[in] The string to encode as a variant.
_pVariantData
[out] Pointer to a pointer of a HPMVariantData object, representing the returned data.
Return Value
Returns an error code. See EHPMError.
Comments
The returned object must be freed with ObjectFree or a memory leak will result.
See Also
HPMSdkFunctions, ObjectFree, HPMVariantData, HPMString
VariantEncode_HPMUntranslatedString
Encodes HPMUntranslatedString as a variant.
HPMError VariantEncode_HPMUntranslatedString (
    void * _pSession,
    const HPMUntranslatedString * _pData,
    const HPMVariantData * * _pVariantData
    );
Parameters
_pSession
[in] A connected session. See SessionOpen.
_pData
[in] The untranslated string to encode as a variant.
_pVariantData
[out] Pointer to a pointer of a HPMVariantData object, representing the returned data.
Return Value
Returns an error code. See EHPMError.
Comments
The returned object must be freed with ObjectFree or a memory leak will result.
See Also
HPMSdkFunctions, ObjectFree, HPMVariantData, HPMUntranslatedString
VariantEncode_EHPMTaskStatus
Encodes a EHPMTaskStatus as a variant.
HPMError VariantEncode_EHPMTaskStatus (
    void * _pSession,
    HPMInt32 _Data,
    const HPMVariantData * * _pVariantData
    );
Parameters
_pSession
[in] A connected session. See SessionOpen.
_Data
[in] The data to encode as a variant. Can be any of the statuses in EHPMTaskStatus.
_pVariantData
[out] Pointer to a pointer of a HPMVariantData object, representing the returned data.
Return Value
Returns an error code. See EHPMError.
Comments
The returned object must be freed with ObjectFree or a memory leak will result.
See Also
HPMSdkFunctions, HPMVariantData, EHPMTaskStatus
CriteriaDataDecode_HPMTaskFindCriteriaTypeText
Gets find criteria as HPMFindCriteriaTypeText.
HPMError CriteriaDataDecode_HPMTaskFindCriteriaTypeText (
    void * _pSession,
    const HPMFindCriteriaData * _pCriteriaData,
    const HPMFindCriteriaTypeText * * _pData
    );
Parameters
_pSession
[in] A connected session. See SessionOpen.
_pCriteriaData
[in] Pointer to the criteria data to decode. See HPMFindCriteriaData.
_pData
[out] Pointer to a pointer of a HPMFindCriteriaTypeText object, representing the returned data.
Return Value
Returns an error code. See EHPMError. If the data cannot be converted to the requested format EHPMError_ConversionNotSupported is returned.
Comments
The returned object must be freed with ObjectFree or a memory leak will result.
See Also
HPMSdkFunctions, ObjectFree, HPMFindCriteriaData, HPMFindCriteriaTypeText
CriteriaDataDecode_HPMTaskFindCriteriaTypeInteger
Gets find criteria as HPMFindCriteriaTypeInteger.
HPMError CriteriaDataDecode_HPMTaskFindCriteriaTypeInteger (
    void * _pSession,
    const HPMFindCriteriaData * _pCriteriaData,
    const HPMFindCriteriaTypeInteger * * _pData
    );
Parameters
_pSession
[in] A connected session. See SessionOpen.
_pCriteriaData
[in] Pointer to the criteria data to decode. See HPMFindCriteriaData.
_pData
[out] Pointer to a pointer of a HPMFindCriteriaTypeInteger object, representing the returned data.
Return Value
Returns an error code. See EHPMError. If the data cannot be converted to the requested format EHPMError_ConversionNotSupported is returned.
Comments
The returned object must be freed with ObjectFree or a memory leak will result.
See Also
HPMSdkFunctions, ObjectFree, HPMFindCriteriaData, HPMFindCriteriaTypeInteger
CriteriaDataDecode_HPMTaskFindCriteriaTypeFloat
Gets find criteria as HPMFindCriteriaTypeFloat.
HPMError CriteriaDataDecode_HPMTaskFindCriteriaTypeFloat (
    void * _pSession,
    const HPMFindCriteriaData * _pCriteriaData,
    const HPMFindCriteriaTypeFloat * * _pData
    );
Parameters
_pSession
[in] A connected session. See SessionOpen.
_pCriteriaData
[in] Pointer to the criteria data to decode. See HPMFindCriteriaData.
_pData
[out] Pointer to a pointer of a HPMFindCriteriaTypeFloat object, representing the returned data.
Return Value
Returns an error code. See EHPMError. If the data cannot be converted to the requested format EHPMError_ConversionNotSupported is returned.
Comments
The returned object must be freed with ObjectFree or a memory leak will result.
See Also
HPMSdkFunctions, ObjectFree, HPMFindCriteriaData, HPMFindCriteriaTypeFloat
CriteriaDataDecode_HPMTaskFindCriteriaTypeGeneralCondition
Gets find criteria as HPMFindCriteriaTypeGeneralCondition.
HPMError CriteriaDataDecode_HPMTaskFindCriteriaTypeGeneralCondition (
    void * _pSession,
    const HPMFindCriteriaData * _pCriteriaData,
    const HPMFindCriteriaTypeGeneralCondition * * _pData
    );
Parameters
_pSession
[in] A connected session. See SessionOpen.
_pCriteriaData
[in] Pointer to the criteria data to decode. See HPMFindCriteriaData.
_pData
[out] Pointer to a pointer of a HPMFindCriteriaTypeGeneralCondition object, representing the returned data.
Return Value
Returns an error code. See EHPMError. If the data cannot be converted to the requested format EHPMError_ConversionNotSupported is returned.
Comments
The returned object must be freed with ObjectFree or a memory leak will result.
See Also
HPMSdkFunctions, ObjectFree, HPMFindCriteriaData, HPMFindCriteriaTypeGeneralCondition
CriteriaDataDecode_HPMTaskFindCriteriaTypeDate
Gets find criteria as HPMFindCriteriaTypeDate.
HPMError CriteriaDataDecode_HPMTaskFindCriteriaTypeDate (
    void * _pSession,
    const HPMFindCriteriaData * _pCriteriaData,
    const HPMFindCriteriaTypeDate * * _pData
    );
Parameters
_pSession
[in] A connected session. See SessionOpen.
_pCriteriaData
[in] Pointer to the criteria data to decode. See HPMFindCriteriaData.
_pData
[out] Pointer to a pointer of a HPMFindCriteriaTypeDate object, representing the returned data.
Return Value
Returns an error code. See EHPMError. If the data cannot be converted to the requested format EHPMError_ConversionNotSupported is returned.
Comments
The returned object must be freed with ObjectFree or a memory leak will result.
See Also
HPMSdkFunctions, ObjectFree, HPMFindCriteriaData, HPMFindCriteriaTypeDate
CriteriaDataDecode_HPMTaskFindCriteriaTypeDroplist
Gets find criteria as HPMFindCriteriaTypeDroplist.
HPMError CriteriaDataDecode_HPMTaskFindCriteriaTypeDroplist (
    void * _pSession,
    const HPMFindCriteriaData * _pCriteriaData,
    const HPMFindCriteriaTypeDroplist * * _pData
    );
Parameters
_pSession
[in] A connected session. See SessionOpen.
_pCriteriaData
[in] Pointer to the criteria data to decode. See HPMFindCriteriaData.
_pData
[out] Pointer to a pointer of a HPMFindCriteriaTypeDroplist object, representing the returned data.
Return Value
Returns an error code. See EHPMError. If the data cannot be converted to the requested format EHPMError_ConversionNotSupported is returned.
Comments
The returned object must be freed with ObjectFree or a memory leak will result.
See Also
HPMSdkFunctions, ObjectFree, HPMFindCriteriaData, HPMFindCriteriaTypeDroplist
CriteriaDataDecode_HPMTaskFindCriteriaTypeMultiSelectDroplist
Gets find criteria as HPMFindCriteriaTypeMultiSelectDroplist.
HPMError CriteriaDataDecode_HPMTaskFindCriteriaTypeMultiSelectDroplist (
    void * _pSession,
    const HPMFindCriteriaData * _pCriteriaData,
    const HPMFindCriteriaTypeMultiSelectDroplist * * _pData
    );
Parameters
_pSession
[in] A connected session. See SessionOpen.
_pCriteriaData
[in] Pointer to the criteria data to decode. See HPMFindCriteriaData.
_pData
[out] Pointer to a pointer of a HPMFindCriteriaTypeMultiSelectDroplist object, representing the returned data.
Return Value
Returns an error code. See EHPMError. If the data cannot be converted to the requested format EHPMError_ConversionNotSupported is returned.
Comments
The returned object must be freed with ObjectFree or a memory leak will result.
See Also
HPMSdkFunctions, ObjectFree, HPMFindCriteriaData, HPMFindCriteriaTypeMultiSelectDroplist
CriteriaDataEncode_HPMTaskFindCriteriaTypeText
Encodes HPMFindCriteriaTypeText as criteria data.
HPMError CriteriaDataEncode_HPMTaskFindCriteriaTypeText (
    void * _pSession,
    const HPMFindCriteriaTypeText * _pData,
    const HPMFindCriteriaData * * _pCriteriaData
    );
Parameters
_pSession
[in] A connected session. See SessionOpen.
_pData
[in] The HPMFindCriteriaTypeText object to encode as criteria data.
_pCriteriaData
[out] Pointer to a pointer of a HPMFindCriteriaData object, representing the returned data.
Return Value
Returns an error code. See EHPMError.
Comments
The returned object must be freed with ObjectFree or a memory leak will result.
See Also
HPMSdkFunctions, ObjectFree, HPMFindCriteriaData, HPMFindCriteriaTypeText
CriteriaDataEncode_HPMTaskFindCriteriaTypeInteger
Encodes HPMFindCriteriaTypeInteger as criteria data.
HPMError CriteriaDataEncode_HPMTaskFindCriteriaTypeInteger (
    void * _pSession,
    const HPMFindCriteriaTypeInteger * _pData,
    const HPMFindCriteriaData * * _pCriteriaData
    );
Parameters
_pSession
[in] A connected session. See SessionOpen.
_pData
[in] The HPMFindCriteriaTypeInteger object to encode as criteria data.
_pCriteriaData
[out] Pointer to a pointer of a HPMFindCriteriaData object, representing the returned data.
Return Value
Returns an error code. See EHPMError.
Comments
The returned object must be freed with ObjectFree or a memory leak will result.
See Also
HPMSdkFunctions, ObjectFree, HPMFindCriteriaData, HPMFindCriteriaTypeInteger
CriteriaDataEncode_HPMTaskFindCriteriaTypeFloat
Encodes HPMFindCriteriaTypeFloat as criteria data.
HPMError CriteriaDataEncode_HPMTaskFindCriteriaTypeFloat (
    void * _pSession,
    const HPMFindCriteriaTypeFloat * _pData,
    const HPMFindCriteriaData * * _pCriteriaData
    );
Parameters
_pSession
[in] A connected session. See SessionOpen.
_pData
[in] The HPMFindCriteriaTypeFloat object to encode as criteria data.
_pCriteriaData
[out] Pointer to a pointer of a HPMFindCriteriaData object, representing the returned data.
Return Value
Returns an error code. See EHPMError.
Comments
The returned object must be freed with ObjectFree or a memory leak will result.
See Also
HPMSdkFunctions, ObjectFree, HPMFindCriteriaData, HPMFindCriteriaTypeFloat
CriteriaDataEncode_HPMTaskFindCriteriaTypeGeneralCondition
Encodes HPMFindCriteriaTypeGeneralCondition as criteria data.
HPMError CriteriaDataEncode_HPMTaskFindCriteriaTypeGeneralCondition (
    void * _pSession,
    const HPMFindCriteriaTypeGeneralCondition * _pData,
    const HPMFindCriteriaData * * _pCriteriaData
    );
Parameters
_pSession
[in] A connected session. See SessionOpen.
_pData
[in] The HPMFindCriteriaTypeGeneralCondition object to encode as criteria data.
_pCriteriaData
[out] Pointer to a pointer of a HPMFindCriteriaData object, representing the returned data.
Return Value
Returns an error code. See EHPMError.
Comments
The returned object must be freed with ObjectFree or a memory leak will result.
See Also
HPMSdkFunctions, ObjectFree, HPMFindCriteriaData, HPMFindCriteriaTypeGeneralCondition
CriteriaDataEncode_HPMTaskFindCriteriaTypeDate
Encodes HPMFindCriteriaTypeDate as criteria data.
HPMError CriteriaDataEncode_HPMTaskFindCriteriaTypeDate (
    void * _pSession,
    const HPMFindCriteriaTypeDate * _pData,
    const HPMFindCriteriaData * * _pCriteriaData
    );
Parameters
_pSession
[in] A connected session. See SessionOpen.
_pData
[in] The HPMFindCriteriaTypeDate object to encode as criteria data.
_pCriteriaData
[out] Pointer to a pointer of a HPMFindCriteriaData object, representing the returned data.
Return Value
Returns an error code. See EHPMError.
Comments
The returned object must be freed with ObjectFree or a memory leak will result.
See Also
HPMSdkFunctions, ObjectFree, HPMFindCriteriaData, HPMFindCriteriaTypeDate
CriteriaDataEncode_HPMTaskFindCriteriaTypeDroplist
Encodes HPMFindCriteriaTypeDroplist as criteria data.
HPMError CriteriaDataEncode_HPMTaskFindCriteriaTypeDroplist (
    void * _pSession,
    const HPMFindCriteriaTypeDroplist * _pData,
    const HPMFindCriteriaData * * _pCriteriaData
    );
Parameters
_pSession
[in] A connected session. See SessionOpen.
_pData
[in] The HPMFindCriteriaTypeDroplist object to encode as criteria data.
_pCriteriaData
[out] Pointer to a pointer of a HPMFindCriteriaData object, representing the returned data.
Return Value
Returns an error code. See EHPMError.
Comments
The returned object must be freed with ObjectFree or a memory leak will result.
See Also
HPMSdkFunctions, ObjectFree, HPMFindCriteriaData, HPMFindCriteriaTypeDroplist
CriteriaDataEncode_HPMTaskFindCriteriaTypeMultiSelectDroplist
Encodes HPMFindCriteriaTypeMultiSelectDroplist criteria data.
HPMError CriteriaDataEncode_HPMTaskFindCriteriaTypeMultiSelectDroplist (
    void * _pSession,
    const HPMFindCriteriaTypeMultiSelectDroplist * _pData,
    const HPMFindCriteriaData * * _pCriteriaData
    );
Parameters
_pSession
[in] A connected session. See SessionOpen.
_pData
[in] The HPMFindCriteriaTypeMultiSelectDroplist object to encode as criteria data.
_pCriteriaData
[out] Pointer to a pointer of a HPMFindCriteriaData object, representing the returned data.
Return Value
Returns an error code. See EHPMError.
Comments
The returned object must be freed with ObjectFree or a memory leak will result.
See Also
HPMSdkFunctions, ObjectFree, HPMFindCriteriaData, HPMFindCriteriaTypeMultiSelectDroplist
CommunicationChannelRegister
Registers communication channel.
HPMError CommunicationChannelRegister (
    void * _pSession,
    const HPMChar * _pChannelName,
    HPMUInt32 _Flags,
    const HPMCommunicationChannelData * _pChannelData,
    const HPMChar * _pDescription
    );
Parameters
_pSession
[in] A connected session. See SessionOpen.
_pChannelName
[in] The name to uniquely identify the communication channel.
_Flags
[in] Settings for the channel. Can be any combination of EHPMChannelFlag.
_pChannelData
[in] The pre-authentication channel data for the channel.
_pDescription
[in] A description of the channel's database's domain, for example the name of the organization or department owning it.
Return Value
Returns an error code. See EHPMError.
Comments
All packets sent by SDK clients to the named channel will be forwarded to this SDK session, until this session unregisters the channel (or terminates) or some other SDK client registers the same channel name. If the caller passes in a pointer to channel data then that data becomes the Channel Data associated with the channel and can be retrieved using CommunicationChannelEnum. If registering the channel fails, a EHPMChangeCallbackOperation_CommunicationChannelRegisterFailed callback results.
See Also
HPMSdkFunctions, CommunicationChannelUnregister, CommunicationChannelEnum, EHPMChannelFlag.
CommunicationChannelUnregister
Unregisters a previously registered communication channel.
HPMError CommunicationChannelUnregister (
    void * _pSession,
    const HPMChar * _pChannelName
    );
Parameters
_pSession
[in] A connected session. See SessionOpen.
_pChannelName
[in] The name uniquely identifying the communication channel.
Return Value
Returns an error code. See EHPMError.
Comments
Packets sent by SDK clients to the named channel will no longer be be forwared to this session.
See Also
HPMSdkFunctions, CommunicationChannelRegister
CommunicationChannelEnum
Retrieves the names and properties of channels registered at the SDK session's server at the start of the login sequence.
HPMError CommunicationChannelEnum (
    void * _pSession,
    const HPMChar * _pChannelName,
    const HPMCommunicationChannelEnum * * _pEnum
    );
Parameters
_pSession
[in] A connected session. See SessionOpen.
_pChannelName
[in] The name of the channel(s) to return, or NULL or the empty string for all channels.
_pEnum
[out] Pointer to a pointer of a HPMCommunicationChannelEnum object, representing the returned data.
Return Value
Returns an error code. See EHPMError.
Comments
Channel data is sent before the login authentication process completes and is therefore transmitted unencrypted without protection against tampering by intruders. It should therefore be decoded and interpreted with the utmost care. Note that channel names are not unique, while the combination of a channel name and its owner's session ID is. The returned object must be freed with ObjectFree or a memory leak will result.
See Also
HPMSdkFunctions, CommunicationChannelRegister, HPMCommunicationChannelEnum
CommunicationChannelSendPacket
Sends a packet to a communication channel.
HPMError CommunicationChannelSendPacket (
    void * _pSession,
    const HPMChar * _pChannelName,
    HPMUInt64 _SessionID,
    const HPMCommunicationChannelPacket * _pPacket
    );
Parameters
_pSession
[in] A connected session. See SessionOpen.
_pChannelName
[in] A name uniquely identifying the communication channel on which the packet should be sent.
_SessionID
[in] The identifier of the SDK client session to which the packet should be sent. Identifier 0 sends it to the channel's current owner, that is: the session that last registered the channel.
_pPacket
[in] The packet to send to the communication channel.
Return Value
Returns an error code. See EHPMError.
Comments
The packet can be sent either to the SDK client session that currently has the channel registered or a specific session that had previously sent a packet to the channel.
See Also
HPMSdkFunctions, RegisterChangeCallback
UtilGetHelixPlanURL
Gets the Helix Plan URL.
HPMError UtilGetHelixPlanURL (
    void * _pSession,
    const HPMChar * _pURLSuffix,
    const HPMString * * _pData
    );
Parameters
_pSession
[in] A connected session. See SessionOpen.
_pURLSuffix
[in] A suffix that will be added to the constructed URL. Could e.g. be a task id.
_pData
[out] Pointer to a pointer of a HPMString object, representing the returned data.
Return Value
Returns an error code. See EHPMError.
Comments
The returned object must be freed with ObjectFree or a memory leak will result.
See Also
HPMSdkFunctions, ObjectFree, HPMString, EHPMError
UtilGetFindCriteriaDataTypeFromData
Gets the type of a HPMFindCriteriaData.
HPMError UtilGetFindCriteriaDataTypeFromData (
    void * _pSession,
    const HPMFindCriteriaData * _pCriteriaData,
    HPMInt32 * _pCriteriaDataType
    );
Parameters
_pSession
[in] A connected session. See SessionOpen.
_pCriteriaData
[in] The criteria data to check the type for.
_pCriteriaDataType
[out] Pointer to a variable that receive the criteria data type. Will be one of EHPMFindCriteriaDataType.
Return Value
Returns an error code. See EHPMError.
Comments
The returned type determines which of the CriteriaDataDecode_* functions should be used.
See Also
HPMSdkFunctions, HPMFindCriteriaData, EHPMFindCriteriaDataType.
UtilGetFindCriteriaDataTypeFromColumn
Gets the type of a HPMColumn.
HPMError UtilGetFindCriteriaDataTypeFromColumn (
    void * _pSession,
    const HPMColumn * _pColumn,
    HPMInt32 * _pCriteriaDataType
    );
Parameters
_pSession
[in] A connected session. See SessionOpen.
_pColumn
[in] The column to check the type for.
_pCriteriaDataType
[out] Pointer to a variable that receive the criteria data type. Will be one of EHPMFindCriteriaDataType.
Return Value
Returns an error code. See EHPMError.
Comments
The returned type determines which of the CriteriaDataEncode_* functions should be used.
See Also
HPMSdkFunctions, HPMFindCriteriaData, EHPMFindCriteriaDataType.
UtilConvertFindStringToReport
Converts a text string into a report.
HPMError UtilConvertFindStringToReport (
    void * _pSession,
    const HPMChar * _pFindString,
    HPMUniqueID _ProjectID,
    HPMUInt32 _FindViewType,
    const HPMReport * * _pReport
    );
Parameters
_pSession
[in] A connected session. See SessionOpen.
_pFindString
[in] The find string that will be converted into a report.
_ProjectID
[in] The unique identifier of the project to create the report in.
_FindViewType
[in] The type that specifies what kind of search will be done. Can be one of EHPMReportViewType. Note that the QA view type only can be used in a QA project and that the global types do not need a project id.
_pReport
[out] Pointer to a pointer of a HPMReport object, representing the returned data.
Return Value
Returns an error code. See EHPMError.
Comments
The returned object must be freed with ObjectFree or a memory leak will result.
See Also
UtilConvertReportToFindString
Converts a report to a text string.
HPMError UtilConvertReportToFindString (
    void * _pSession,
    const HPMReport * _pReport,
    HPMUniqueID _ProjectID,
    HPMUInt32 _FindViewType,
    const HPMString * * _pFindString
    );
Parameters
_pSession
[in] A connected session. See SessionOpen.
_pReport
[in] The report to convert to a fins string.
_ProjectID
[in] The unique identifier of the project the report was created in.
_FindViewType
[in] The type that specifies what kind of search will be done. Can be one of EHPMReportViewType. Note that the QA view type only can be used in a QA project and that the global types do not need a project id.
_pFindString
[out] Pointer to a pointer of a HPMString object, representing the returned data.
Return Value
Returns an error code. See EHPMError.
Comments
The returned object must be freed with ObjectFree or a memory leak will result.
See Also
UtilGetColumnName
Gets the header string for a column
HPMError UtilGetColumnName (
    void * _pSession,
    HPMUInt32 _ColumnType,
    const HPMUntranslatedString * * _pColumnName
    );
Parameters
_pSession
[in] A connected session. See SessionOpen.
_ColumnType
[in] The type of the column to get the name for. Can be one of EHPMProjectDefaultColumn.
_pColumnName
[out] Pointer to a pointer of a HPMUntranslatedString object, representing the returned data.
Return Value
Returns an error code. See EHPMError.
Comments
The returned object must be freed with ObjectFree or a memory leak will result.
See Also
UtilPrepareFindContext
Prepares a find context to be used TaskFind and TaskRefUtilIsInFindContext.
HPMError UtilPrepareFindContext (
    void * _pSession,
    const HPMChar * _pFindString,
    HPMUniqueID _ProjectID,
    HPMUInt32 _FindViewType,
    const HPMFindContext * _pFindContext,
    const HPMFindContextData * * _pData
    );
Parameters
_pSession
[in] A connected session. See SessionOpen.
_pFindString
[in] The find string to create a find context for. This string uses the same syntax as the find in the Helix Plan client.
_ProjectID
[in] The unique identifier of project to search in. If set to -1 the find will be global.
_FindViewType
[in] The type that specifies what kind of search will be done. Can be one of EHPMReportViewType. Note that the QA view types only can be used in a QA project and that the global types do not need a project id.
_pFindContext
[in] The find context that contain options for the resulting find context.
_pData
[out] Pointer to a pointer of a HPMFindContextData object, representing the returned data.
Return Value
Returns an error code. See EHPMError.
Comments
The returned object must be freed with ObjectFree or a memory leak will result. To use a HPMReport as input you can convert the report to a string with UtilConvertReportToFindString.
See Also
HPMSdkFunctions, ObjectFree, TaskFind, TaskRefUtilIsInFindContext, HPMFindContext, HPMFindContextData
UtilUpdateFindContext
Updates a prepared find context with a new find string.
HPMError UtilUpdateFindContext (
    void * _pSession,
    const HPMChar * _pFindString,
    const HPMFindContextData * _pFindContext
    );
Parameters
_pSession
[in] A connected session. See SessionOpen.
_pFindString
[in] The new find string.
_pFindContext
[in] The find context to update.
Return Value
Returns an error code. See EHPMError.
See Also
HPMSdkFunctions, ObjectFree, HPMFindContextData
UtilGetColumnDescription
Gets the description of a column.
HPMError UtilGetColumnDescription (
    void * _pSession,
    const HPMColumn * _pColumn,
    const HPMColumnDescription * * _pColumnDescription
    );
Parameters
_pSession
[in] A connected session. See SessionOpen.
_pColumn
[in] The column to get the type for.
_pColumnDescription
[out] Pointer to a pointer of a HPMColumnDescription object, representing the returned data.
Return Value
Returns an error code. See EHPMError.
Comments
The returned object must be freed with ObjectFree or a memory leak will result.
See Also
HPMSdkFunctions, HPMColumnDescription
UtilColumnToTaskField
Converts a column to a taskfield.
HPMError UtilColumnToTaskField (
    void * _pSession,
    const HPMColumn * _pColumn,
    const HPMTaskField * * _pTaskField
    );
Parameters
_pSession
[in] A connected session. See SessionOpen.
_pColumn
[in] The column to to convert to a taskfield.
_pTaskField
[out] Pointer to a pointer of a HPMTaskField object, representing the returned data.
Return Value
Returns an error code. See EHPMError.
Comments
The returned object must be freed with ObjectFree or a memory leak will result.
See Also
HPMSdkFunctions, ObjectFree, HPMColumn, HPMTaskField
UtilTaskFieldToColumn
Converts a taskfield to a column.
HPMError UtilTaskFieldToColumn (
    void * _pSession,
    const HPMTaskField * _pTaskField,
    const HPMColumn * * _pColumn
    );
Parameters
_pSession
[in] A connected session. See SessionOpen.
_pTaskField
[in] The task field to convert to a column.
_pColumn
[out] Pointer to a pointer of a HPMColumn object, representing the returned data.
Return Value
Returns an error code. See EHPMError.
Comments
The returned object must be freed with ObjectFree or a memory leak will result.
See Also
HPMSdkFunctions, ObjectFree, HPMColumn, HPMTaskField
UtilGetColumnDataItemFormatted
Gets the formatted string version of data in a column.
HPMError UtilGetColumnDataItemFormatted (
    void * _pSession,
    HPMUniqueID _ProjectID,
    HPMUInt32 _ColumnID,
    HPMUInt32 _Data,
    const HPMUntranslatedString * * _pColumnFormatted
    );
Parameters
_pSession
[in] A connected session. See SessionOpen.
_ProjectID
[in] The unique id of the project to get formatted column data item for. Only used if _ColumnID is EHPMProjectDefaultColumn_BugStatus, EHPMProjectDefaultColumn_MilestoneTag or EHPMProjectDefaultColumn_CommittedToSprint.
_ColumnID
[in] The column id of the column. Can be one of EHPMProjectDefaultColumn.
_Data
[in] The data in the column. The value depends on the type of _ColumnID.
_pColumnFormatted
[out] Pointer to a pointer of a HPMUntranslatedString object, representing the returned data.
Return Value
Returns an error code. See EHPMError.
Comments
The returned object must be freed with ObjectFree or a memory leak will result.
See Also
HPMSdkFunctions, ObjectFree, EHPMProjectDefaultColumn
UtilIsColumnReadOnly
Checks if a column is read only.
HPMError UtilIsColumnReadOnly (
    void * _pSession,
    HPMUInt32 _ColumnID,
    HPMInt32 * _pReturn
    );
Parameters
_pSession
[in] A connected session. See SessionOpen.
_ColumnID
[in] The column id of the column. Can be one of EHPMProjectDefaultColumn.
_pReturn
[out] Returns 1 if the column is read only, 0 otherwise.
Return Value
Returns an error code. See EHPMError.
See Also
UtilGetColumnData
Gets all the data values for a EHPMProjectDefaultColumn that has the the type EHPMFindCriteriaDataType_List.
HPMError UtilGetColumnData (
    void * _pSession,
    HPMUniqueID _ProjectID,
    HPMUInt32 _ColumnID,
    const HPMColumnData * * _pColumnData
    );
Parameters
_pSession
[in] A connected session. See SessionOpen.
_ProjectID
[in] The unique id of the project to get column data for. Only used if _ColumnID is EHPMProjectDefaultColumn_BugStatus, EHPMProjectDefaultColumn_MilestoneTag or EHPMProjectDefaultColumn_CommittedToSprint.
_ColumnID
[in] The column id of the column. Can be one of EHPMProjectDefaultColumn.
_pColumnData
[out] Pointer to a pointer of a HPMColumnData object, representing the returned data.
Return Value
Returns an error code. See EHPMError.
Comments
The returned object must be freed with ObjectFree or a memory leak will result.
See Also
HPMSdkFunctions, ObjectFree, EHPMProjectDefaultColumn, EHPMFindCriteriaDataType, HPMColumnData, UtilGetColumnDataItemFormatted
UtilGetWorkflowObjectName
Gets the name of a workflow step.
HPMError UtilGetWorkflowObjectName (
    void * _pSession,
    HPMUniqueID _ProjectID,
    HPMInt32 _WorkflowID,
    HPMInt32 _ObjectID,
    const HPMUntranslatedString * * _pObjectName
    );
Parameters
_pSession
[in] A connected session. See SessionOpen.
_ProjectID
[in] The unique id of the project to get the workflow from. If getting the QA workflow this needs to be the QA project, otherwise the main project.
_WorkflowID
[in] The identifier of the workflow to get in the project. For QA only 0 is valid here as QA only have one workflow.
_ObjectID
[in] The ojbect id of the workflow status to get name for.
_pObjectName
[out] Pointer to a pointer of a HPMUntranslatedString object, representing the returned data. The name of the workflow object.
Return Value
Returns an error code. See EHPMError.
Comments
The returned object must be freed with ObjectFree or a memory leak will result.
See Also
UtilGetWorkflowObjectIDFromName
Gets the ID of a workflow step.
HPMError UtilGetWorkflowObjectIDFromName (
    void * _pSession,
    HPMUniqueID _ProjectID,
    HPMInt32 _WorkflowID,
    const HPMLanguage * _pLanguage,
    const HPMChar * _pName,
    HPMInt32 * _pObjectID
    );
Parameters
_pSession
[in] A connected session. See SessionOpen.
_ProjectID
[in] The unique id of the project to get the workflow from. If getting the QA workflow this needs to be the QA project, otherwise the main project.
_WorkflowID
[in] The identifier of the workflow to get in the project. For QA only 0 is valid here as QA only have one workflow.
_pLanguage
[in] The language that the _pName string is in.
_pName
[in] The name of the object to get the ID for.
_pObjectID
[out] Pointer to a variable representing the returned data. The returned object ID. -1 represents a failure.
Return Value
Returns an error code. See EHPMError.
See Also
UtilGetWorkflowName
Gets the name of a workflow.
HPMError UtilGetWorkflowName (
    void * _pSession,
    HPMUniqueID _ProjectID,
    HPMInt32 _WorkflowID,
    const HPMString * * _pWorkflowName
    );
Parameters
_pSession
[in] A connected session. See SessionOpen.
_ProjectID
[in] The unique id of the project to get the workflow from. If getting the QA workflow this needs to be the QA project, otherwise the main project.
_WorkflowID
[in] The identifier of the workflow to get in the project. For QA only 0 is valid here as QA only have one workflow.
_pWorkflowName
[out] Pointer to a pointer of a HPMString object, representing the returned data. The name of the workflow object.
Return Value
Returns an error code. See EHPMError.
Comments
The returned object must be freed with ObjectFree or a memory leak will result.
See Also
UtilTaskCommentExists
Checks if a comment exists.
HPMError UtilTaskCommentExists (
    void * _pSession,
    HPMUniqueID _TaskID,
    HPMInt32 _PostID,
    HPMInt32 * _pExists
    );
Parameters
_pSession
[in] A connected session. See SessionOpen.
_TaskID
[in] The unique id of the task to check if a comment exists on.
_PostID
[in] The post id of the comment to check existance for.
_pExists
[out] Set to 1 if the comment exists.
Return Value
Returns an error code. See EHPMError.
See Also
UtilGlobalReportExists
Checks if a global report exists.
HPMError UtilGlobalReportExists (
    void * _pSession,
    HPMUniqueID _ResourceID,
    HPMUniqueID _ReportID,
    HPMInt32 * _pExists
    );
Parameters
_pSession
[in] A connected session. See SessionOpen.
_ResourceID
[in] The resource ID to check report existance for.
_ReportID
[in] The report ID to check report existance for.
_pExists
[out] Set to 1 if the report exists.
Return Value
Returns an error code. See EHPMError.
See Also
UtilProjectReportExists
Checks if a project report exists.
HPMError UtilProjectReportExists (
    void * _pSession,
    HPMUniqueID _ProjectID,
    HPMUniqueID _ResourceID,
    HPMUniqueID _ReportID,
    HPMInt32 * _pExists
    );
Parameters
_pSession
[in] A connected session. See SessionOpen.
_ProjectID
[in] The project ID to check report existance for.
_ResourceID
[in] The resource ID to check report existance for.
_ReportID
[in] The report ID to check report existance for.
_pExists
[out] Set to 1 if the report exists.
Return Value
Returns an error code. See EHPMError.
See Also
UtilWorkflowObjectExists
Checks if a workflow object exists.
HPMError UtilWorkflowObjectExists (
    void * _pSession,
    HPMUniqueID _ProjectID,
    HPMInt32 _WorkflowID,
    HPMInt32 _ObjectID,
    HPMInt32 * _pExists
    );
Parameters
_pSession
[in] A connected session. See SessionOpen.
_ProjectID
[in] The project ID to check workflow object existance for.
_WorkflowID
[in] The workflow ID to check workflow object existance for.
_ObjectID
[in] The workflow object ID to check workflow object existance for.
_pExists
[out] Set to 1 if the workflow object exists.
Return Value
Returns an error code. See EHPMError.
See Also
UtilWorkflowExists
Checks if a workflow exists.
HPMError UtilWorkflowExists (
    void * _pSession,
    HPMUniqueID _ProjectID,
    HPMInt32 _WorkflowID,
    HPMInt32 * _pExists
    );
Parameters
_pSession
[in] A connected session. See SessionOpen.
_ProjectID
[in] The project ID to check workflow existance for.
_WorkflowID
[in] The worklow ID to check workflow existance for.
_pExists
[out] Set to 1 if the workflow exists.
Return Value
Returns an error code. See EHPMError.
See Also
UtilGetWorkflowIDFromName
Gets the ID of a workflow name.
HPMError UtilGetWorkflowIDFromName (
    void * _pSession,
    HPMUniqueID _ProjectID,
    const HPMChar * _pName,
    HPMUInt32 _WorkflowReturnType,
    HPMInt32 * _pWorkflowID
    );
Parameters
_pSession
[in] A connected session. See SessionOpen.
_ProjectID
[in] The unique id of the project to get the workflow from. If getting the QA workflow this needs to be the QA project, otherwise the main project.
_pName
[in] The name of the workflow to get the ID for.
_WorkflowReturnType
[in] The type of the workflow matching the workflow name. Can be one of EHPMWorkflowReturnType.
_pWorkflowID
[out] Pointer to a variable representing the returned data. The returned object ID. -1 represents a failure.
Return Value
Returns an error code. See EHPMError.
See Also
UtilGetWorkflowType
Gets the ID of a workflow.
HPMError UtilGetWorkflowType (
    void * _pSession,
    HPMUniqueID _ProjectID,
    HPMInt32 _WorkflowID,
    HPMInt32 * _pWorkflowType
    );
Parameters
_pSession
[in] A connected session. See SessionOpen.
_ProjectID
[in] The unique id of the project to get the workflow from. If getting the QA workflow this needs to be the QA project, otherwise the main project.
_WorkflowID
[in] The identifier of the workflow to get in the project. For QA only 0 is valid here as QA only have one workflow.
_pWorkflowType
[out] Pointer to a variable that receive the workflow type. Will be one of EHPMWorkflowType.
Return Value
Returns an error code. See EHPMError.
See Also
UtilGetWorkflowContainerFlags
Gets the container flags of a workflow.
HPMError UtilGetWorkflowContainerFlags (
    void * _pSession,
    HPMUniqueID _ProjectID,
    HPMInt32 _WorkflowID,
    HPMUInt32 * _pFlags
    );
Parameters
_pSession
[in] A connected session. See SessionOpen.
_ProjectID
[in] The unique id of the project to get the workflow from. If getting the QA workflow this needs to be the QA project, otherwise the main project.
_WorkflowID
[in] The identifier of the workflow to get in the project. For QA only 0 is valid here as QA only have one workflow.
_pFlags
[out] Pointer to a variable that receive the workflow container flags. Will be one of EHPMProjectWorkflowContainerFlag.
Return Value
Returns an error code. See EHPMError.
See Also
DebugCheckHeap
Checks the integrity of the heap in debug mode.
HPMError DebugCheckHeap (
    void * _pSession
    );
Parameters
_pSession
[in] A connected session. See SessionOpen.
Return Value
Returns an error code. See EHPMError.
Comments
If an error is found in the heap a debug break will be issued.
See Also
TimesheetRowSetActivityID
Sets the activity id for a timesheet row.
HPMError TimesheetRowSetActivityID (
    void * _pSession,
    HPMUniqueID _DayID,
    HPMUInt32 _RowID,
    HPMInt32 _ActivityID
    );
Parameters
_pSession
[in] A connected session. See SessionOpen.
_DayID
[in] The unique identifier of timesheet day. See ResourceGetTimesheetDay.
_RowID
[in] The identifier of the timesheet row.
_ActivityID
[in] The activity id to set on the timesheet row.
Return Value
Returns an error code. See EHPMError.
See Also
HPMSdkFunctions, ResourceGetTimesheetDay
TimesheetRowSetProjectID
Sets the project id for a timesheet row.
HPMError TimesheetRowSetProjectID (
    void * _pSession,
    HPMUniqueID _DayID,
    HPMUInt32 _RowID,
    HPMUniqueID _ProjectID
    );
Parameters
_pSession
[in] A connected session. See SessionOpen.
_DayID
[in] The unique identifier of timesheet day. See ResourceGetTimesheetDay.
_RowID
[in] The identifier of the timesheet row.
_ProjectID
[in] The unique project id to set on the timesheet row.
Return Value
Returns an error code. See EHPMError.
See Also
HPMSdkFunctions, ResourceGetTimesheetDay
TimesheetRowSetTaskID
Sets the task id for a timesheet row.
HPMError TimesheetRowSetTaskID (
    void * _pSession,
    HPMUniqueID _DayID,
    HPMUInt32 _RowID,
    HPMUniqueID _TaskID
    );
Parameters
_pSession
[in] A connected session. See SessionOpen.
_DayID
[in] The unique identifier of timesheet day. See ResourceGetTimesheetDay.
_RowID
[in] The identifier of the timesheet row.
_TaskID
[in] The unique task id to set on the timesheet row.
Return Value
Returns an error code. See EHPMError.
See Also
HPMSdkFunctions, ResourceGetTimesheetDay
TimesheetRowSetStartedTime
Sets the started time for a timesheet row.
HPMError TimesheetRowSetStartedTime (
    void * _pSession,
    HPMUniqueID _DayID,
    HPMUInt32 _RowID,
    HPMUInt32 _StartedTime
    );
Parameters
_pSession
[in] A connected session. See SessionOpen.
_DayID
[in] The unique identifier of timesheet day. See ResourceGetTimesheetDay.
_RowID
[in] The identifier of the timesheet row.
_StartedTime
[in] The started time to set on the timesheet row. Expressed as seconds from midnight. The max value is 86340.
Return Value
Returns an error code. See EHPMError.
See Also
HPMSdkFunctions, ResourceGetTimesheetDay
TimesheetRowSetDurationTime
Sets the duration time for a timesheet row.
HPMError TimesheetRowSetDurationTime (
    void * _pSession,
    HPMUniqueID _DayID,
    HPMUInt32 _RowID,
    HPMUInt32 _DurationTime
    );
Parameters
_pSession
[in] A connected session. See SessionOpen.
_DayID
[in] The unique identifier of timesheet day. See ResourceGetTimesheetDay.
_RowID
[in] The identifier of the timesheet row.
_DurationTime
[in] The duration time to set on the timesheet row. Expressed as seconds. The max value is 86340.
Return Value
Returns an error code. See EHPMError.
See Also
HPMSdkFunctions, ResourceGetTimesheetDay
TimesheetRowSetComment
Sets the comment for a timesheet row.
HPMError TimesheetRowSetComment (
    void * _pSession,
    HPMUniqueID _DayID,
    HPMUInt32 _RowID,
    const HPMChar * _pComment
    );
Parameters
_pSession
[in] A connected session. See SessionOpen.
_DayID
[in] The unique identifier of timesheet day. See ResourceGetTimesheetDay.
_RowID
[in] The identifier of the timesheet row.
_pComment
[in] The comment to set on the timesheet row.
Return Value
Returns an error code. See EHPMError.
See Also
HPMSdkFunctions, ResourceGetTimesheetDay, HPMString
TimesheetRowDelete
Deletes a timesheet row.
HPMError TimesheetRowDelete (
    void * _pSession,
    HPMUniqueID _DayID,
    HPMUInt32 _RowID
    );
Parameters
_pSession
[in] A connected session. See SessionOpen.
_DayID
[in] The unique identifier of timesheet day. See ResourceGetTimesheetDay.
_RowID
[in] The identifier of the timesheet row to be deleted.
Return Value
Returns an error code. See EHPMError.
See Also
HPMSdkFunctions, ResourceGetTimesheetDay
TimesheetGetDateRange
Gets a timesheet period report.
HPMError TimesheetGetDateRange (
    void * _pSession,
    HPMInt32 _Type,
    const HPMUniqueEnum * _pIDs,
    HPMUInt64 _StartDate,
    HPMUInt64 _FinishDate,
    const HPMChangeCallbackData_TimesheetGetDateRangeResponse * * _pResult
    );
Parameters
_pSession
[in] A connected session. See SessionOpen.
_Type
[in] The type to request timesheets for. Can be one of EHPMTimesheetRequestType.
_pIDs
[in] The resource to get the timesheet report for for.
_StartDate
[in] The day to get the timesheet report for. Expressed as the number of microseconds since 1970 UTC.
_FinishDate
[in] The day to get the timesheet report for. Expressed as the number of microseconds since 1970 UTC.
_pResult
[out] Pointer to a pointer of a HPMChangeCallbackData_TimesheetGetDateRangeResponse object, representing the returned data. This function will block even in non-blocking mode if this parameter is not NULL.
Return Value
Returns an error code. See EHPMError.
Comments
If you specify a non-NULL pointer to the _pResult parameter this function will block and the result of the operation will be returned. The returned result must be freed with ObjectFree or a memory leak will result. If you specify a NULL pointer to the _pResult parameter this function will not block and when the operation is finished you will receive a EHPMChangeCallbackOperationimesheetGetDateRangeResponse callback.
See Also
HPMSdkFunctions, ObjectFree, HPMChangeCallbackData_TimesheetGetDateRangeResponse
TimesheetCreateTaskTimeSpentRow
Creates new timesheet rows for task for specific user and date.
HPMError TimesheetCreateTaskTimeSpentRow (
    void * _pSession,
    HPMUniqueID _ResourceID,
    HPMUInt64 _Day,
    HPMUniqueID _TaskID,
    HPMUInt32 _DurationTime
    );
Parameters
_pSession
[in] A connected session. See SessionOpen.
_ResourceID
[in] ResourceID to create the row for.
_Day
[in] The day to create the row on. Expressed as the number of microseconds since 1970 UTC.
_TaskID
[in] The unique task id to set on the row.
_DurationTime
[in] The duration time to set on the row. Expressed as seconds. Max duration time for row is 86340. If value more than 86340 - more than one row will be created.
Return Value
Returns an error code. See EHPMError.
See Also
HPMSdkFunctions, ResourceGetTimesheetDay
SessionSetConnectionLostTimeout
Sets the connection lost timeout value. The session will return a connection lost error if it cannot use the session connection during the specified timeout time.
HPMError SessionSetConnectionLostTimeout (
    void * _pSession,
    HPMFP64 _Timeout
    );
Parameters
_pSession
[in] A connected session. See SessionOpen.
_Timeout
[in] The connection lost timeout value in seconds.
Return Value
Returns an error code. See EHPMError.
See Also
SessionGetDisconnectReason
Gets a more detailed disconnect reason after a EHPMError_ConnectionLost. is EHPMProjectCustomColumnsColumnType_DateTime.
HPMError SessionGetDisconnectReason (
    void * _pSession,
    const HPMString * * _pDisconnectReason
    );
Parameters
_pSession
[in] A connected session. See SessionOpen.
_pDisconnectReason
[out] Pointer to a pointer of a HPMString object, containing the disconnect reason.
Return Value
Returns an error code. See EHPMError.
Comments
The returned object must be freed with ObjectFree or a memory leak will result.
See Also
UtilDecodeCustomColumnCalculatedValue
Decodes custom column value to a function column value.
HPMError UtilDecodeCustomColumnCalculatedValue (
    void * _pSession,
    HPMChar const * _pCustomColumnStrValue,
    HPMCalculatedColumnValue const * * _pValue
    );
Parameters
_pSession
[in] A connected session. See SessionOpen.
_pCustomColumnStrValue
[in] Custom column value to decode
_pValue
[out] Pointer to a pointer of a HPMCalculatedColumnValue containing the calculated column value.
Return Value
Returns an error code. See EHPMError.
Comments
The returned object must be freed with ObjectFree or a memory leak will result.
See Also
HPMSdkFunctions, HPMCalculatedColumnValue
DebugSetFlags
Sets debug flags if in debug mode.
HPMError DebugSetFlags (
    void * _pSession,
    HPMUInt32 _DebugFlags
    );
Parameters
_pSession
[in] A connected session. See SessionOpen.
_DebugFlags
[in] Debug flags. Can be bit combination of EHPMDebugFlag.
Return Value
Returns an error code. See EHPMError.
Comments
With this function it's possible to turn off some SDK errors.
See Also
UtilGetTaskInfoFromHelixPlanURL
Gets information for a task from a Helix Plan URL.
HPMError UtilGetTaskInfoFromHelixPlanURL (
    void * _pSession,
    HPMChar const * _pHelixPlanURL,
    HPMTaskInformation const * * _pData
    );
Parameters
_pSession
[in] A connected session. See SessionOpen.
_pHelixPlanURL
[in] The Helix Plan URL to get task information for.
_pData
[out] Pointer to a pointer of a HPMTaskInformation object, representing the returned data.
Return Value
Returns an error code. See EHPMError.
Comments
The returned object must be freed with ObjectFree or a memory leak will result.
See Also
HPMSdkFunctions, ObjectFree, HPMTaskInformation
DebugFlushWatchNotifications
Flushes watch notification emails.
HPMError DebugFlushWatchNotifications (
    void * _pSession,
    HPMDebugFlushWatchNotification const * * _pData
    );
Parameters
_pSession
[in] A connected session. See SessionOpen.
_pData
[out] Pointer to a pointer of a HPMDebugFlushWatchNotification object, representing the returned data.
Return Value
Returns an error code. See EHPMError.
Comments
See Also
SessionTryLock
Used to lock the session from receiving server updates if another thread does not already hold a lock at the time of invocation. If the current thread was locked, the lock hold count is incremented. Use SessionDidTryLockSucceed to check if the call was succesful.
HPMError SessionTryLock (
    void * _pSession,
    HPMSessionTryLock const * * _pLockReference
    );
Parameters
_pSession
[in] A connected session. See SessionOpen.
_pLockReference
[out] Pointer to a pointer of a HPMSessionTryLock object, representing the returned data.
Return Value
Returns an error code. See EHPMError.
Comments
The returned object must be freed with ObjectFree or a memory leak will result. When the object is freed, the lock hold count is decremented and if it is 0 the session is unlocked and can receive updates from the server again. Try to lock the session as little time as possible to allow the processing of messages from the server. If you call a blocking function while having the session lock it will temporarily be unlocked and updates from the server will be received until the blocking command has been returned from the server. Keep in mind that if you call this function from a client dll session the client will hang until you unlock the session.
See Also
HPMSdkFunctions, SessionDidTryLockSucceed, HPMSessionTryLock
SessionDidTryLockSucceed
Checks if a try lock SessionTryLock call was successful.
HPMError SessionDidTryLockSucceed (
    void * _pSession,
    HPMSessionTryLock const * _pLockReference,
    HPMInt32 * _pSuccess
    );
Parameters
_pSession
[in] A connected session. See SessionOpen.
_pLockReference
[in] The try lock to test.
_pSuccess
[out] Returns 1 if the try lock succeeded and the current thread acquired the lock, 0 otherwise.
Return Value
Returns an error code. See EHPMError.
See Also
HPMSdkFunctions, SessionTryLock, HPMSessionTryLock
UtilGetCustomColumnName
Gets the name of a custom column
HPMError UtilGetCustomColumnName (
    void * _pSession,
    HPMUInt32 _ColumnHash,
    HPMString const * * _pColumnName
    );
Parameters
_pSession
[in] A connected session. See SessionOpen.
_ColumnHash
[in] The hash of the custom column.
_pColumnName
[out] Pointer to a pointer of a HPMString object, representing the returned data.
Return Value
Returns an error code. See EHPMError.
Comments
The returned object must be freed with ObjectFree or a memory leak will result.
See Also
UtilGetCustomColumnType
Gets the type of a custom column
HPMError UtilGetCustomColumnType (
    void * _pSession,
    HPMUInt32 _ColumnHash,
    HPMUInt32 * _pType
    );
Parameters
_pSession
[in] A connected session. See SessionOpen.
_ColumnHash
[in] The hash of the custom column.
_pType
[out] Pointer to a variable that receive the type. Will be one of EHPMProjectCustomColumnsColumnType.
Return Value
Returns an error code. See EHPMError.
See Also
HPMSdkFunctions, EHPMProjectCustomColumnsColumnType
SessionOpenVirtualImpersonated
Opens a virtual session with fixed impersonation. The impersonated user will be used for all calls on the returned virtual session. Otherwise it behaves like SessionOpenVirtual
HPMError SessionOpenVirtualImpersonated (
    void * _pSession,
    HPMUniqueID _ResourceIDToImpersonate,
    HPMInt32 _ClientOrigin,
    HPMUntranslatedString const * _pCustomClientOrigin,
    void * * _pSessionReturn
    );
Parameters
_pSession
[in] A connected session. See SessionOpen.
_ResourceIDToImpersonate
[in] The resource that you want to impersonate. Set to -1 to disable impersonation.
_ClientOrigin
[in] Defines a origin that will explain the origin of the operations in task history. Can be one of EHPMDataHistoryClientOrigin.
_pCustomClientOrigin
[in] Defines a custom string that will explain the origin of the operations in task history.
_pSessionReturn
[out] Pointer to a pointer of new virtual session object, representing the returned data.
Return Value
Returns a virtual session identifier. This identifier is used in all other functions of the SDK to identify the session to perform an operation on. If no session pool has been created by SessionOpen the return value will be NULL. Note that you can use virtual sessions even if only one session was created by SessionOpen, i.e. the number of session parameter in SessionOpen is set to zero.
See Also
HPMSdkFunctions, SessionOpen, SessionOpenVirtual
UtilNormaliseCustomSettings
Gets a normalised version of a custom settings string to enable comparison.
HPMError UtilNormaliseCustomSettings (
    void * _pSession,
    HPMChar const * _pCustomSettings,
    HPMString const * * _pNormalisedCustomSettings
    );
Parameters
_pSession
[in] A connected session. See SessionOpen.
_pCustomSettings
[in] The custom settings to normalise.
_pNormalisedCustomSettings
[out] Pointer to a pointer of a HPMString object, representing the returned data.
Return Value
Returns an error code. See EHPMError.
Comments
The returned object must be freed with ObjectFree or a memory leak will result.
See Also
UtilGetReport
Gets a report for a report GUID.
HPMError UtilGetReport (
    void * _pSession,
    HPMUniqueID _ResourceID,
    HPMUInt64 _ReportGUID,
    HPMReport const * * _pSettings
    );
Parameters
_pSession
[in] A connected session. See SessionOpen.
_ResourceID
[in] The unique identifier of the resource that created the report to get.
_ReportGUID
[in] The unique GUID of the report to get.
_pSettings
[out] Pointer to a pointer of a HPMReport object, representing the returned data.
Return Value
Returns an error code. See EHPMError.
Comments
The returned object must be freed with ObjectFree or a memory leak will result.
See Also
HPMSdkFunctions, ObjectFree, HPMReport
EHPMAuthenticationGlobalParameters
Global static parameters for SDK authentication framework.
enum EHPMAuthenticationGlobalParameters {
EHPMAuthenticationGlobalParameters_MinimumSessionKeyBits = 128,
EHPMAuthenticationGlobalParameters_MaximumSessionKeyBits = 16384,
};
Values
EHPMAuthenticationGlobalParameters_MinimumSessionKeyBits
The minimum length of session keys that custom authentication methods may generate.
EHPMAuthenticationGlobalParameters_MaximumSessionKeyBits
The maximum length of session keys that custom authentication methods may generate.
See Also
AuthenticationClientPluginRegister
EHPMAuthenticationPropertiesFlag
Used in AuthenticationClientProtocolEnded to specify the properties of a custom authentication method.
enum EHPMAuthenticationPropertiesFlag {
EHPMAuthenticationPropertiesFlag_None = 0,
EHPMAuthenticationPropertiesFlag_AllowUserNameSave = 1,
EHPMAuthenticationPropertiesFlag_AllowActiveDirectory = 2,
EHPMAuthenticationPropertiesFlag_AllowLDAP = 4,
};
Values
EHPMAuthenticationPropertiesFlag_None
TBD
EHPMAuthenticationPropertiesFlag_AllowUserNameSave
If successful, allow the user name just authenticated to be saved in the local registry?
EHPMAuthenticationPropertiesFlag_AllowActiveDirectory
Allow AD client side plugin features
EHPMAuthenticationPropertiesFlag_AllowLDAP
Allow direct authentication with the client side plugin sending the auth integration the username & password.
See Also
AuthenticationClientProtocolEnded, AuthenticationClientPluginRegister
EHPMAuthenticationLoginNameFlag
Used in HPMAuthenticationLoginNameEntry::m_Flags to specify how a particular user login name should be displayed and handed.
enum EHPMAuthenticationLoginNameFlag {
EHPMAuthenticationLoginNameFlag_None = 0,
EHPMAuthenticationLoginNameFlag_CanLoginWithoutPassword = 1,
};
Values
EHPMAuthenticationLoginNameFlag_None
TBD
EHPMAuthenticationLoginNameFlag_CanLoginWithoutPassword
This user is currently logged on, that is: authenticated credentials already exist for this user account and no password is needed.
See Also
HPMAuthenticationLoginNameEntry, AuthenticationClientPluginRegister
HPMAuthenticationLoginNameEntry
User login information used in AuthenticationClientPluginRegister.
struct HPMAuthenticationLoginNameEntry {
const HPMChar * m_pDisplayName;
HPMUInt32 m_NameFlags;
} HPMAuthenticationLoginNameEntry;
Members
m_pDisplayName
The name to show to the user, which the authentication method can use to uniquely identify a user.
m_NameFlags
Any combination of EHPMAuthenticationLoginNameFlag.
See Also
TBD
HPMAuthenticationClientPluginProperties
User login information used in AuthenticationClientPluginRegister.
struct HPMAuthenticationClientPluginProperties {
const HPMChar * m_pName;
HPMUInt32 m_nLoginNames;
const HPMAuthenticationLoginNameEntry * m_pLoginNames;
const HPMUntranslatedString * m_pNoPasswordText;
} HPMAuthenticationClientPluginProperties;
Members
m_pName
The human-readable name of the authentication method
m_nLoginNames
The number of user login names.
m_pLoginNames
Pointer to a list of HPMAuthenticationLoginNameEntry that specify login names to display
m_pNoPasswordText
Descriptive text to show for login names that do not require a password (optional).
See Also
AuthenticationClientPluginRegister
HPMAuthenticationSessionKey
Session key information used in AuthenticationClientProtocolEnded and AuthenticationIntegrationProtocolEnded.
struct HPMAuthenticationSessionKey {
HPMUInt32 m_nBytes;
const HPMUInt8 * m_pBytes;
} HPMAuthenticationSessionKey;
Members
m_nBytes
The number of bytes in the session key, or 0 for no key
m_pBytes
The bytes of the session key.
Comments
Session keys must be between EHPMAuthenticationGlobalParameters_MinimumSessionKeyBits and EHPMAuthenticationGlobalParameters_MaximumSessionKeyBits bits in length.
See Also
AuthenticationClientPluginRegister, AuthenticationClientProtocolEnded, AuthenticationIntegrationProtocolEnded
HPMAuthenticationErrorDescription
Error description information used in AuthenticationClientProtocolEnded.
struct HPMAuthenticationErrorDescription {
const HPMUntranslatedString * m_pOrigin;
const HPMUntranslatedString * m_pErrorText;
} HPMAuthenticationErrorDescription;
Members
m_pOrigin
The origin or source of the error.
m_pErrorText
A textural description of the error.
See Also
AuthenticationClientProtocolEnded
HPMAuthenticationErrorDescriptions
Error description information used in AuthenticationClientProtocolEnded.
struct HPMAuthenticationErrorDescriptions {
HPMUInt32 m_nDescriptions;
const HPMAuthenticationErrorDescription * m_pDescriptions;
} HPMAuthenticationErrorDescriptions;
Members
m_nDescriptions
The number of descriptions available.
m_pDescriptions
The error descriptions.
See Also
AuthenticationClientProtocolEnded
AuthenticationClientPluginRegister
Registers a client Plugin as an authentication Plugin.
HPMError AuthenticationClientPluginRegister (
    void * _pSession,
    const HPMChar * _pChannelName,
    const HPMAuthenticationClientPluginProperties * _pMethodProperties
    );
Parameters
_pSession
[in] A connected session. See SessionOpen.
_pChannelName
[in] Identifier of the Channel the Plugin uses for authentication communication.
_pMethodProperties
[in] Authentication method properties.
Return Value
Returns an error code. See EHPMError.
Comments
An Authentication Client PlugIn calls this function to notify its SDK Session that it provides Authentication Services, typically just after opening the session. The Plugin may later receive EHPMChangeCallbackOperation_AuthenticationProtocolBegin callbacks, signaling it to start its authentication protocol. Note that if another Client PlugIn has already registered using the same channel, this registration will fail.
See Also
HPMSdkFunctions, AuthenticationClientPluginUnregister
AuthenticationClientPluginUnregister
Unregisters a previously registered client authentication Plugin.
HPMError AuthenticationClientPluginUnregister (
    void * _pSession,
    const HPMChar * _pChannelName
    );
Parameters
_pSession
[in] A connected session. See SessionOpen.
_pChannelName
[in] Identifier of the Channel the Plugin uses for authentication communication.
Return Value
Returns an error code. See EHPMError.
See Also
HPMSdkFunctions, AuthenticationClientPluginRegister
AuthenticationClientProtocolEnded
Notifies that an previously started authentication protocol instance has terminated.
HPMError AuthenticationClientProtocolEnded (
    void * _pSession,
    const HPMChar * _pChannelName,
    HPMUInt64 _SessionID,
    const HPMAuthenticationSessionKey * _pSessionKey,
    const HPMChar * _pUserName,
    const HPMAuthenticationErrorDescriptions * _pErrorDescriptions,
    HPMUInt32 _Flags
    );
Parameters
_pSession
[in] A connected session. See SessionOpen.
_pChannelName
[in] The Channel name identifying the Plugin whose protocol has terminated.
_SessionID
[in] If the protocol terminated successfully: the Session ID of the Authentication Integration Client the PlugIn interacted with to complete the protocol.
_pSessionKey
[in] If the protocol terminated successfully: the key that should be used to encrypt communication with the server from now on. If the protocol was unsuccessful: an empty key or NULL pointer.
_pUserName
[in] If the protocol terminated successfully: the user name of the Hansoft user account that was successfully authenticated.
_pErrorDescriptions
[in] If the protocol was unsuccessful: A structure containing an array of error descriptions that will be displayed to the user.
_Flags
[in] Any combination of EHPMAuthenticationPropertiesFlag.
Return Value
Returns an error code. See EHPMError.
Comments
Only client-side custom authentication Plugins may call this function, authentication integration SDK client use the AuthenticationIntegrationProtocolEnded function instead.
See Also
HPMSdkFunctions, AuthenticationClientPluginRegister, AuthenticationIntegrationProtocolEnded
AuthenticationIntegrationProtocolEnded
Notifies that an authentication protocol with a remote client authentication protocol has terminated.
HPMError AuthenticationIntegrationProtocolEnded (
    void * _pSession,
    const HPMChar * _pChannelName,
    const HPMAuthenticationSessionKey * _pSessionKey,
    HPMUniqueID _UserID,
    HPMUInt64 _SessionID
    );
Parameters
_pSession
[in] A connected session. See SessionOpen.
_pChannelName
[in] The Channel name used by the protocol that has terminated. The session must have registered this channel.
_pSessionKey
[in] If the protocol terminated successfully: the key that should be used to encrypt communication with the server from now on. If the protocol was unsuccessful: an empty key or NULL pointer.
_UserID
[in] If the protocol terminated successfully: the User (resource) ID of the Hansoft user account that was successfully authenticated.
_SessionID
[in] The Session ID of the Authentication PlugIn the Authentication Integration interacted with to complete the protocol.
Return Value
Returns an error code. See EHPMError.
Comments
Only authentication integration SDK clients may call this function, client-side authentication Plugins use the AuthenticationClientProtocolEnded function instead.
See Also
HPMSdkFunctions, CommunicationChannelRegister
AuthenticationResolveCredentials
Determines the Hansoft user account associated with user credentials, if the credentials are valid. The caller passes in a list containing the Session IDs of the SDK client sessions and servers to which the request should be forwarded. If any of them succeed, the User's User ID is returned. If the user is a guest user through a share then its local/guest User ID is returned. Session IDs are obtained via CommunicationChannelEnum. Only Session IDs of channels with the EHPMChannelFlag_SupportsResolveCredentials flag set may be used. If any of the sessions passed in are invalid, the call fails. If you specify a non-NULL pointer to the _pResult parameter this function will block and the result of the operation will be returned. The returned result must be freed with ObjectFree or a memory leak will result. If you specify a NULL pointer to the _pResult parameter this function will not block and when the operation is finished you will receive a EHPMChangeCallbackOperation_AuthenticationResolveCredentialsResponse callback. If you specify _pSource different from empty string the result will contain an authenticate token which could be used instead of password in order to save it in untrusted source and reuse it in future. The token will not depend on any user data and it totally random.
HPMError AuthenticationResolveCredentials (
    void * _pSession,
    const HPMChar * _pUserName,
    const HPMChar * _pPassword,
    const HPMCredentialResolutionSessionIDsEnum * _pSessionIDs,
    const HPMChar * _pSource,
    HPMUInt64 _Context,
    const HPMChangeCallbackData_AuthenticationResolveCredentialsResponse * * _pResult
    );
Parameters
_pSession
[in] A connected session. See SessionOpen.
_pUserName
[in] The user name to check.
_pPassword
[in] The password to check.
_pSessionIDs
[in] The session(s) that should perform the check
_pSource
[in] The source name which is initiate this call. Based on it we will register a new token which will be returned in response.
_Context
[in] This value will be set in the m_Context field of the HPMChangeCallbackData_AuthenticationResolveCredentialsResponse object resulting from this call.
_pResult
[out] Pointer to a pointer of a HPMChangeCallbackData_AuthenticationResolveCredentialsResponse object specifying the result of this operation. See comments section.
Return Value
Returns an error code. See EHPMError.
See Also
HPMSdkFunctions, CommunicationChannelEnum, AuthenticationResolveCredentialsEnded, HPMChangeCallbackData_AuthenticationResolveCredentialsResponse::m_pAuthToken
AuthenticationResolveCredentialsEnded
Called by a custom authentication integration client to notify that credentials resolution processing has terminated.
HPMError AuthenticationResolveCredentialsEnded (
    void * _pSession,
    HPMUInt64 _FromSessionID,
    const HPMChar * _pUserName,
    HPMUniqueID _UserID,
    HPMUInt64 _Context,
    const HPMChar * _pChannelName,
    const HPMChar * _pErrorMessage
    );
Parameters
_pSession
[in] A connected session. See SessionOpen.
_FromSessionID
[in] The identifier of the SDK session that requested the credentials resolution.
_pUserName
[in] The user name that was checked.
_UserID
[in] If the credentials were successfully validated: the User (resource) ID of the credential's Hansoft user account. Otherwise, zero (0).
_Context
[in] This value will be set in the m_Context field of the HPMChangeCallbackData_AuthenticationResolveCredentialsResponse object resulting from this call.
_pChannelName
[in] The Channel name used by the protocol that has resolved. The session must have registered this channel.
_pErrorMessage
[in] If the credentials were not validated: an explanation of the failure or NULL.
Return Value
Returns an error code. See EHPMError.
See Also
HPMSdkFunctions, EHPMChangeCallbackOperation_AuthenticationResolveCredentials
AuthenticationResolveCredentialsHelixAuth
Determines the Hansoft user account associated with SSO using Helix Authentication Service. This function is asyncronous only and will not block. When the operation is finished you will receive a EHPMChangeCallbackOperation_AuthenticationResolveCredentialsResponse callback. An intermdiate response callback of type EHPMChangeCallbackOperation_AuthenticationResolveCredentialsHelixAuthUrl will contain the URL that the client most open in a web browser in order complete the 3rd party authentication operation. If you specify _pSource different from empty string the result will contain an authenticate token which could be used instead of password in order to save it in untrusted source and reuse it in future. The token will not depend on any user data and it totally random.
HPMError AuthenticationResolveCredentialsHelixAuth (
    void * _pSession,
    const HPMChar * _pSource,
    HPMUInt64 _Context
    );
Parameters
_pSession
[in] A connected session. See SessionOpen.
_pSource
[in] The source name which is initiate this call. Based on it we will register a new token which will be returned in response.
_Context
[in] This value will be set in the m_Context field of the HPMChangeCallbackData_AuthenticationResolveCredentialsResponse object resulting from this call.
Return Value
Returns an error code. See EHPMError.
See Also
HPMSdkFunctions, EHPMChangeCallbackOperation_AuthenticationResolveCredentialsHelixAuthUrl HPMChangeCallbackData_AuthenticationResolveCredentialsResponse::m_pAuthToken GlobalGetSecurityOptions
HPMGlobalStatisticsSettings
Used to define settings for global statistics.
struct HPMGlobalStatisticsSettings {
HPMUInt32 m_SamplingFrequency;
HPMUInt32 m_SecondOfDaySample;
HPMUInt32 m_SamplingFrequencyResource;
HPMUInt32 m_SecondOfDaySampleResource;
HPMUInt32 m_SamplingFrequencyResourceGroup;
HPMUInt32 m_SecondOfDaySampleResourceGroup;
} HPMGlobalStatisticsSettings;
Members
m_SamplingFrequency
The number of seconds between samplings of global statistics.
m_SecondOfDaySample
The number of seconds past midnight that sampling of global statistics should start.
m_SamplingFrequencyResource
The number of seconds between samplings of global statistics for a resources.
m_SecondOfDaySampleResource
The number of seconds past midnight that sampling of global statistics for resources should start.
m_SamplingFrequencyResourceGroup
The number of seconds between samplings of global statistics for a resource groups.
m_SecondOfDaySampleResourceGroup
The number of seconds past midnight that sampling of global statistics for resource groups should start.
See Also
GlobalGetStatisticsSettings, GlobalSetStatisticsSettings
HPMGlobalEmailSettings
Used to define global email settings.
struct HPMGlobalEmailSettings {
const HPMChar * m_pServer;
HPMInt32 m_Port;
const HPMChar * m_pName;
const HPMChar * m_pEmail;
HPMInt32 m_bAuthentication;
const HPMChar * m_pUserName;
const HPMChar * m_pUserPassword;
HPMInt32 m_SecurityProtocol;
} HPMGlobalEmailSettings;
Members
m_pServer
Outgoing SMTP server name.
m_Port
Outgoing SMTP server port.
m_pName
Name appearing on sent email.
m_pEmail
Email address appearing on sent email.
m_bAuthentication
If 1 the SMTP server used for outgoing email requires authentication, 0 otherwise.
m_pUserName
The username used for SMTP authentication.
m_pUserPassword
The user password used for authentication.
m_SecurityProtocol
The security protocol used for authentication. See EHPMEmailSecurityProtocol.
See Also
GlobalSetEmailSettings, ProjectGetEmailSettings
HPMSecurityPolicySettings
Security policy settings.
struct HPMSecurityPolicySettings {
HPMUInt32 m_MinPasswordLength;
HPMUInt32 m_MinPasswordAlpha;
HPMUInt32 m_MinPasswordNumeric;
HPMUInt32 m_MinPasswordNonAlphaNumeric;
HPMUInt32 m_MinPasswordUpperCase;
HPMUInt32 m_MinPasswordLowerCase;
HPMUInt32 m_PasswordExpireDays;
HPMUInt32 m_TokensExpireDays;
HPMUInt32 m_PasswordsInHistory;
HPMInt32 m_bAdminsCanChangePolicy;
} HPMSecurityPolicySettings;
Members
m_MinPasswordLength
Minimum password length
m_MinPasswordAlpha
Minimum number of alphabetic characters in passwords
m_MinPasswordNumeric
Minimum number of numeric characters in passwords
m_MinPasswordNonAlphaNumeric
Minimum number of symbol characters in passwords
m_MinPasswordUpperCase
Minimum number of upper case characters in passwords
m_MinPasswordLowerCase
Minimum number of lower case characters in passwords
m_PasswordExpireDays
Number of days until passwords expire
m_TokensExpireDays
Number of days until tokens expire
m_PasswordsInHistory
Number of passwords to save in history
m_bAdminsCanChangePolicy
Set to 1 of users with administration rights can change security policy
See Also
HPMDatabaseGUIDs
Used to define GUIDs for a database.
struct HPMDatabaseGUIDs {
const HPMChar * m_pGUID;
HPMUInt64 m_ID64;
HPMUInt32 m_ID32;
} HPMDatabaseGUIDs;
Members
m_pGUID
The full GUID for the database.
m_ID64
A 64 bit integer derived from the full GUID. Not guaranteed to be unique, but extremely unlikely not to be.
m_ID32
A 32 bit integer derived from the full GUID. Not guaranteed to be unique, but highly unlikely not to be.
See Also
HPMNotificationSubscription
Used to keep a subscription notifications
struct HPMNotificationSubscription {
HPMInt32 m_Dummy;
} HPMNotificationSubscription;
Members
m_Dummy
Unused dummy member
See Also
GlobalRegisterForDynamicCustomSettingsNotifications, GlobalRegisterForRightClickNotifications
HPMDisallowedFileTypes
Disallowed file types
struct HPMDisallowedFileTypes {
HPMInt32 m_nFileTypes;
const HPMString * m_pFileTypes;
} HPMDisallowedFileTypes;
Members
m_nFileTypes
Number of disallowed file types.
m_pFileTypes
List of disallowed file types.
See Also
GlobalSetDisallowedFileTypes, GlobalGetDisallowedFileTypes
GlobalGetStatisticsSettings
Gets statistics settings for global statistics.
HPMError GlobalGetStatisticsSettings (
    void * _pSession,
    const HPMGlobalStatisticsSettings * * _pSettings
    );
Parameters
_pSession
[in] A connected session. See SessionOpen.
_pSettings
[out] Pointer to a pointer of a HPMGlobalStatisticsSettings object, representing the returned data.
Return Value
Returns an error code. See EHPMError.
Comments
The returned object must be freed with ObjectFree or a memory leak will result.
See Also
HPMSdkFunctions, ObjectFree, HPMGlobalStatisticsSettings
GlobalSetStatisticsSettings
Sets statistics settings for global statistics.
HPMError GlobalSetStatisticsSettings (
    void * _pSession,
    const HPMGlobalStatisticsSettings * _pSettings
    );
Parameters
_pSession
[in] A connected session. See SessionOpen.
_pSettings
[in] The statistics settings to set on the project. See HPMGlobalStatisticsSettings.
Return Value
Returns an error code. See EHPMError.
See Also
HPMSdkFunctions, HPMGlobalStatisticsSettings
GlobalRegisterCustomSettings
Registers custom settings for an integration.
HPMError GlobalRegisterCustomSettings (
    void * _pSession,
    const HPMChar * _pIdentifier,
    const HPMChar * _pData
    );
Parameters
_pSession
[in] A connected session. See SessionOpen.
_pIdentifier
[in] The identifier of the integration. This value is used to isolate the custom settings of different integrations.
_pData
[in] The registry describing the custom settings. See the CustomSettings sample for syntax description.
Return Value
Returns an error code. See EHPMError.
Comments
The settings are registered with a string containing a registry describing different settings to be customized. For documentation of the format see the CustomSettings sample.
See Also
HPMSdkFunctions, GlobalUnregisterCustomSettings, GlobalGetRegisteredCustomSettings
GlobalUnregisterCustomSettings
Unregister custom settings for an integration.
HPMError GlobalUnregisterCustomSettings (
    void * _pSession,
    const HPMChar * _pIdentifier
    );
Parameters
_pSession
[in] A connected session. See SessionOpen.
_pIdentifier
[in] The identifier of the integration. This value is used to isolate the custom settings of different integrations.
Return Value
Returns an error code. See EHPMError.
Comments
When custom settings for an integration are unregistered all settings values saved for the integration identifier are deleted as well.
See Also
HPMSdkFunctions, ObjectFree, GlobalRegisterCustomSettings
GlobalGetRegisteredCustomSettings
Gets the registered custom settings for an integration.
HPMError GlobalGetRegisteredCustomSettings (
    void * _pSession,
    const HPMChar * _pIdentifier,
    const HPMString * * _pData
    );
Parameters
_pSession
[in] A connected session. See SessionOpen.
_pIdentifier
[in] The identifier of the integration. This value is used to isolate the custom settings of different integrations.
_pData
[out] Pointer to a pointer of a HPMString object, representing the returned data.
Return Value
Returns an error code. See EHPMError.
Comments
The returned object must be freed with ObjectFree or a memory leak will result. The settings are registered with a string containing a registry describing different settings to be customized. For documentation of the format see the CustomSettings sample.
See Also
HPMSdkFunctions, ObjectFree, HPMString, GlobalRegisterCustomSettings
GlobalGetCustomSettingsIdentifierHash
Returns the identifier hash for a custom settings integration identifier. This identifier can be used to match identifier hashes in the change callbacks.
HPMError GlobalGetCustomSettingsIdentifierHash (
    void * _pSession,
    const HPMChar * _pIdentifier,
    HPMUInt32 * _pReturn
    );
Parameters
_pSession
[in] A connected session. See SessionOpen.
_pIdentifier
[in] The identifier of the integration. This value is used to isolate the custom settings of different integrations.
_pReturn
[out] The identifier hash.
Return Value
Returns an error code. See EHPMError.
See Also
HPMSdkFunctions, GlobalRegisterCustomSettings, HPMChangeCallbackData_GlobalCustomSettingsChange, HPMChangeCallbackData_GlobalCustomSettingsUnregister, HPMChangeCallbackData_GlobalCustomSettingsValueChange, HPMChangeCallbackData_ProjectCustomSettingsValueChange, HPMChangeCallbackData_ResourceCustomSettingsValueChange, HPMChangeCallbackData_ProjectResourceCustomSettingsValueChange
GlobalGetCustomSettingsValue
Gets the value of a global custom setting.
HPMError GlobalGetCustomSettingsValue (
    void * _pSession,
    HPMInt32 _SettingType,
    const HPMChar * _pIdentifier,
    const HPMChar * _pSettingPath,
    const HPMCustomSettingValue * * _pData
    );
Parameters
_pSession
[in] A connected session. See SessionOpen.
_SettingType
[in] The type of the setting. Can be one of EHPMCustomSettingsType. Currently only EHPMCustomSettingsType_Admin is valid for this function.
_pIdentifier
[in] The identifier of the integration. This value is used to isolate the custom settings of different integrations.
_pSettingPath
[in] The setting path to get the setting for.
_pData
[out] Pointer to a pointer of a HPMCustomSettingValue object, representing the returned data.
Return Value
Returns an error code. See EHPMError.
Comments
The returned object must be freed with ObjectFree or a memory leak will result.
See Also
HPMSdkFunctions, ObjectFree, HPMCustomSettingValue, GlobalRegisterCustomSettings, GlobalSetCustomSettingsValue, EHPMCustomSettingsType
GlobalSetCustomSettingsValue
Sets the value of a global custom setting.
HPMError GlobalSetCustomSettingsValue (
    void * _pSession,
    HPMInt32 _SettingType,
    const HPMChar * _pIdentifier,
    const HPMChar * _pSettingPath,
    const HPMCustomSettingValue * _pData
    );
Parameters
_pSession
[in] A connected session. See SessionOpen.
_SettingType
[in] The type of the setting. Can be one of EHPMCustomSettingsType. Currently only EHPMCustomSettingsType_Admin is valid for this function.
_pIdentifier
[in] The identifier of the integration. This value is used to isolate the custom settings of different integrations.
_pSettingPath
[in] The setting path to get the setting for.
_pData
[in] The custom settings value to set. If set to NULL the value will be set to its default value. See HPMCustomSettingValue.
Return Value
Returns an error code. See EHPMError.
See Also
HPMSdkFunctions, ObjectFree, HPMCustomSettingValue, GlobalRegisterCustomSettings, GlobalGetCustomSettingsValue, EHPMCustomSettingsType
GlobalRegisterForDynamicCustomSettingsNotifications
Registers custom settings notifications for an integration.
HPMError GlobalRegisterForDynamicCustomSettingsNotifications (
    void * _pSession,
    const HPMChar * _pPathPrefix,
    HPMUserContext _UserContext,
    const HPMNotificationSubscription * * _pSubscription
    );
Parameters
_pSession
[in] A connected session. See SessionOpen.
_pPathPrefix
[in] The prefix of the path that you are interested in notifications from
_UserContext
[in] The user context that will be sent along with any notifications received
_pSubscription
[out] Pointer to a pointer of a HPMNotificationSubscription object, representing the held subscription. To stop subscribing to the notificatinos, free the returned object.
Return Value
Returns an error code. See EHPMError.
Comments
The returned object must be freed with ObjectFree or a memory leak will result. Only a client DLL plugin can register for custom settings notifications. When a value changes in the custom settings GUI a HPMChangeCallbackData_DynamicCustomSettingsValueChanged will be sent asynchronously. The notification subscription is only valid as long as the received HPMNotificationSubscription stays in allocated memory. The ClientPluginCpp sample contains a demo of the functionality.
See Also
HPMSdkFunctions, GlobalRegisterCustomSettings, HPMChangeCallbackData_DynamicCustomSettingsValueChanged.
GlobalAddRightClickMenuItem
Adds a right click menu item to a selection right click menu for the main schedule, backlog, QA and My Work sections or to the workflow steps in the workflow editor depending on the HPMRightClickContext.
HPMError GlobalAddRightClickMenuItem (
    void * _pSession,
    HPMRightClickContext const * _pRightClickContext,
    HPMChar const * _pParentUniqueName,
    HPMChar const * _pUniqueName,
    HPMUntranslatedString const * _pItemName,
    HPMUserContext _UserContext
    );
Parameters
_pSession
[in] A connected session. See SessionOpen.
_pRightClickContext
[in] The right click menu context.
_pParentUniqueName
[in] The unique name of the parent menu item where this item should be added under.
_pUniqueName
[in] The unique name of this right click menu item.
_pItemName
[in] The display name for this menu item.
_UserContext
[in] The user context sent to HPMChangeCallbackData_RightClickMenuItemSelected
Return Value
Returns an error code. See EHPMError.
Comments
Only a client DLL plugin can add right click items. The ClientPluginCpp sample contains a demo of the functionality.
See Also
GlobalRegisterForRightClickNotifications
Registers right click notifications for an integration.
HPMError GlobalRegisterForRightClickNotifications (
    void * _pSession,
    HPMUserContext _UserContext,
    const HPMNotificationSubscription * * _pSubscription
    );
Parameters
_pSession
[in] A connected session. See SessionOpen.
_UserContext
[in] The user context that will be sent along with any notifications received
_pSubscription
[out] Pointer to a pointer of a HPMNotificationSubscription object, representing the held subscription. To stop subscribing to the notificatinos, free the returned object.
Return Value
Returns an error code. See EHPMError.
Comments
The returned object must be freed with ObjectFree or a memory leak will result. Only a client DLL plugin can register for right click notifications. On right click a HPMChangeCallbackData_RightClickDisplayTaskMenu or a HPMChangeCallbackData_RightClickDisplayWorkflowStepMenu will be sent depending on the context. A new menu item can then be added with GlobalAddRightClickMenuItem. When a menu item is selected a HPMChangeCallbackData_RightClickMenuItemSelected notification will be sent asynchronously. The notification subscription is only valid as long as the received HPMNotificationSubscription stays in allocated memory. The ClientPluginCpp sample contains a demo of the functionality.
See Also
HPMSdkFunctions, HPMChangeCallbackData_RightClickMenuItemSelected, HPMChangeCallbackData_RightClickDisplayTaskMenu, HPMChangeCallbackData_RightClickDisplayWorkflowStepMenu, GlobalAddRightClickMenuItem
GlobalDisplayCustomSettingsDialog
Displays a custom settings dialog.
HPMError GlobalDisplayCustomSettingsDialog (
    void * _pSession,
    HPMUniqueID _ProjectID,
    HPMUniqueID _ResourceID,
    HPMChar const * _pDialogSpec,
    HPMChar const * _pInitialValues
    );
Parameters
_pSession
[in] A connected session. See SessionOpen.
_ProjectID
[in] The project that this dialog should be displayed for. Can be unset.
_ResourceID
[in] The resource this dialog should be displayed for. Can be unset.
_pDialogSpec
[in] The format of the settings are in the same format as for GlobalRegisterCustomSettings.
_pInitialValues
[in] The initial values for the settings.
Return Value
Returns an error code. See EHPMError.
Comments
The returned object must be freed with ObjectFree or a memory leak will result. Only a client DLL plugin can display a custom settings dialog. The ClientPluginCpp sample contains a demo of the functionality.
See Also
GlobalCancelCustomSettingsDialog
Cancels a custom settings dialog.
HPMError GlobalCancelCustomSettingsDialog (
    void * _pSession,
    HPMDynamicCustomSettingsContext const * _pDynamicContext
    );
Parameters
_pSession
[in] A connected session. See SessionOpen.
_pDynamicContext
[in] The dynamic context of the dialog to close
Return Value
Returns an error code. See EHPMError.
Comments
Only a client DLL plugin can display a custom settings dialog.
See Also
HPMSdkFunctions, GlobalDisplayCustomSettingsDialog, HPMChangeCallbackData_DynamicCustomSettingsNotification
GlobalRegisterForCustomTaskStatusNotifications
Registers custom task status notifications for an integration.
HPMError GlobalRegisterForCustomTaskStatusNotifications (
    void * _pSession,
    const HPMChar * _pPathPrefix,
    HPMUserContext _UserContext,
    const HPMNotificationSubscription * * _pSubscription
    );
Parameters
_pSession
[in] A connected session. See SessionOpen.
_pPathPrefix
[in] The prefix of the path that you are interested in notifications from
_UserContext
[in] The user context that will be sent along with any notifications received
_pSubscription
[out] Pointer to a pointer of a HPMNotificationSubscription object, representing the held subscription. To stop subscribing to the notificatinos, free the returned object.
Return Value
Returns an error code. See EHPMError.
Comments
The returned object must be freed with ObjectFree or a memory leak will result. Only a client DLL plugin can register for custom task status notifications. The notification subscription is only valid as long as the received HPMNotificationSubscription stays in allocated memory.
See Also
GlobalDisplayCustomTaskStatusDialog
Displays a custom task status dialog.
HPMError GlobalDisplayCustomTaskStatusDialog (
    void * _pSession,
    HPMCustomTaskStatusDialogValues const * _pDialogValues,
    HPMInt32 _bAddToDoTasks,
    HPMProjectEnum const * _pProjects
    );
Parameters
_pSession
[in] A connected session. See SessionOpen.
_pDialogValues
[in] Dialog values.
_bAddToDoTasks
[in] If set all tasks from the currently logged in user's To Do list will be added to the dialog. Only tasks from projects that are not in the _pProjects will be added
_pProjects
[in] List of allowed projects in the dialog, i.e. To Do tasks from other projects will not be added to dialog. If empty all To Do tasks will be added.
Return Value
Returns an error code. See EHPMError.
Comments
The returned object must be freed with ObjectFree or a memory leak will result. Only a client DLL plugin can display a custom task status dialog. The ClientPluginCpp sample contains a demo of the functionality.
See Also
GlobalCancelCustomTaskStatusDialog
Cancels a custom task status dialog.
HPMError GlobalCancelCustomTaskStatusDialog (
    void * _pSession,
    HPMDynamicCustomSettingsContext const * _pDynamicContext
    );
Parameters
_pSession
[in] A connected session. See SessionOpen.
_pDynamicContext
[in] The dynamic context of the dialog to close
Return Value
Returns an error code. See EHPMError.
Comments
Only a client DLL plugin can display a custom task status dialog.
See Also
HPMSdkFunctions, GlobalDisplayCustomTaskStatusDialog, HPMChangeCallbackData_CustomTaskStatusNotification
GlobalAddTasksCustomTaskStatusDialog
Add tasks to a custom task status dialog.
HPMError GlobalAddTasksCustomTaskStatusDialog (
    void * _pSession,
    HPMDynamicCustomSettingsContext const * _pDynamicContext,
    HPMTaskEnum const * _pTasks
    );
Parameters
_pSession
[in] A connected session. See SessionOpen.
_pDynamicContext
[in] The dynamic context of the dialog to close
_pTasks
[in] The list of task ids to add to the dialog.
Return Value
Returns an error code. See EHPMError.
Comments
Only a client DLL plugin can display a custom task status dialog.
See Also
HPMSdkFunctions, GlobalDisplayCustomTaskStatusDialog, HPMChangeCallbackData_CustomTaskStatusNotification
GlobalRequestDynamicCustomSettingsValues
Requests the dynamic value of a custom setting.
HPMError GlobalRequestDynamicCustomSettingsValues (
    void * _pSession,
    HPMDynamicCustomSettingsContext const * _pDynamicContext,
    HPMUserContext _UserContext,
    const HPMDynamicCustomSettingsPaths * _pSettingPaths
    );
Parameters
_pSession
[in] A connected session. See SessionOpen.
_pDynamicContext
[in] The dynamic custom settings context obtained through HPMChangeCallbackData_DynamicCustomSettingsNotification::m_pDynamicContext or HPMChangeCallbackData_DynamicCustomSettingsValueChanged::m_pDynamicContext.
_UserContext
[in] The user context that will be sent along with any notifications received.
_pSettingPaths
[in] The paths to request custom settings for.
Return Value
Returns an error code. See EHPMError.
Comments
Requests the dynamic value of a custom setting. This value will be returned asynchronously through HPMChangeCallbackData_DynamicCustomSettingsValuesRequestResponse
See Also
HPMSdkFunctions, ObjectFree, HPMCustomSettingValue, HPMChangeCallbackData_DynamicCustomSettingsValuesRequestResponse, HPMChangeCallbackData_DynamicCustomSettingsNotification
GlobalSetDynamicCustomSettingsValues
Sets the value of a global custom setting.
HPMError GlobalSetDynamicCustomSettingsValues (
    void * _pSession,
    HPMDynamicCustomSettingsContext const * _pDynamicContext,
    const HPMDynamicCustomSettingsValues * _pData
    );
Parameters
_pSession
[in] A connected session. See SessionOpen.
_pDynamicContext
[in] The dynamic custom settings context obtained through HPMChangeCallbackData_DynamicCustomSettingsNotification::m_pDynamicContext or HPMChangeCallbackData_DynamicCustomSettingsValueChanged::m_pDynamicContext.
_pData
[in] The custom settings values to set.
Return Value
Returns an error code. See EHPMError.
Comments
The ClientPluginCpp sample contains a demo of the functionality.
See Also
HPMSdkFunctions, ObjectFree, HPMCustomSettingValue,
GlobalGetSDKInternalDataIdentifierHash
Returns the identifier hash for a SDK internal data identifier. This identifier can be used to match identifier hashes in the change callbacks.
HPMError GlobalGetSDKInternalDataIdentifierHash (
    void * _pSession,
    const HPMChar * _pIdentifier,
    HPMUInt32 * _pReturn
    );
Parameters
_pSession
[in] A connected session. See SessionOpen.
_pIdentifier
[in] The identifier of the SDK internal data. This value is used to isolate the SDK internal data of different integrations.
_pReturn
[out] The identifier hash.
Return Value
Returns an error code. See EHPMError.
See Also
HPMSdkFunctions, HPMChangeCallbackData_GlobalSDKInternalDataChange, HPMChangeCallbackData_ProjectSDKInternalDataChange, HPMChangeCallbackData_ResourceSDKInternalDataChange, HPMChangeCallbackData_ProjectResourceSDKInternalDataChange, HPMChangeCallbackData_TaskSDKInternalDataChange, HPMChangeCallbackData_TaskRefSDKInternalDataChange,
GlobalGetSDKInternalData
Gets global SDK internal data.
HPMError GlobalGetSDKInternalData (
    void * _pSession,
    const HPMChar * _pIdentifier,
    const HPMSDKInternalData * * _pData
    );
Parameters
_pSession
[in] A connected session. See SessionOpen.
_pIdentifier
[in] The identifier of SDK internal data. This value is used to isolate the SDK internal data of different integrations.
_pData
[out] Pointer to a pointer of a HPMCustomSettingValue object, representing the returned data.
Return Value
Returns an error code. See EHPMError.
Comments
The returned object must be freed with ObjectFree or a memory leak will result.
See Also
HPMSdkFunctions, ObjectFree, HPMSDKInternalData, GlobalSetSDKInternalData
GlobalSetSDKInternalData
Sets the value of a global custom setting.
HPMError GlobalSetSDKInternalData (
    void * _pSession,
    const HPMChar * _pIdentifier,
    const HPMSDKInternalData * _pData
    );
Parameters
_pSession
[in] A connected session. See SessionOpen.
_pIdentifier
[in] The identifier of SDK internal data. This value is used to isolate the SDK internal data of different integrations.
_pData
[in] The SDK internal data to set. See HPMSDKInternalData.
Return Value
Returns an error code. See EHPMError.
See Also
HPMSdkFunctions, ObjectFree, HPMSDKInternalData, GlobalGetSDKInternalData
GlobalGetServerInternetName
Gets the server internet name.
HPMError GlobalGetServerInternetName (
    void * _pSession,
    const HPMString * * _pData
    );
Parameters
_pSession
[in] A connected session. See SessionOpen.
_pData
[out] Pointer to a pointer of a HPMString object, representing the returned data.
Return Value
Returns an error code. See EHPMError.
Comments
The returned object must be freed with ObjectFree or a memory leak will result. The server internet name is used to generate URLs that point to the server.
See Also
HPMSdkFunctions, ObjectFree, HPMString
GlobalGetWebServiceHostname
Gets the Helix Plan web service hostname.
HPMError GlobalGetWebServiceHostname (
    void * _pSession,
    const HPMString * * _pData
    );
Parameters
_pSession
[in] A connected session. See SessionOpen.
_pData
[out] Pointer to a pointer of a HPMString object, representing the returned data.
Return Value
Returns an error code. See EHPMError.
Comments
The returned object must be freed with ObjectFree or a memory leak will result.
See Also
HPMSdkFunctions, ObjectFree, HPMString, EHPMError
GlobalSetServerInternetName
Sets the server internet name.
HPMError GlobalSetServerInternetName (
    void * _pSession,
    const HPMChar * _pData
    );
Parameters
_pSession
[in] A connected session. See SessionOpen.
_pData
[in] The internet name to set for the server.
Return Value
Returns an error code. See EHPMError.
Comments
The server internet name is used to generate URLs that point to the server.
See Also
GlobalGetDatabaseGUIDs
Gets the GUIDs for the database. Useful to uniquely identify a database in i.e. integrations.
HPMError GlobalGetDatabaseGUIDs (
    void * _pSession,
    const HPMDatabaseGUIDs * * _pData
    );
Parameters
_pSession
[in] A connected session. See SessionOpen.
_pData
[out] Pointer to a pointer of a HPMDatabaseGUIDs object, representing the returned data.
Return Value
Returns an error code. See EHPMError.
Comments
The returned object must be freed with ObjectFree or a memory leak will result.
See Also
HPMSdkFunctions, ObjectFree, HPMDatabaseGUIDs
GlobalWorkflowsRemoveDeleted
Removes all workflows in all projects that have been deleted.
HPMError GlobalWorkflowsRemoveDeleted (
    void * _pSession
    );
Parameters
_pSession
[in] A connected session. See SessionOpen.
Return Value
Returns an error code. See EHPMError.
See Also
GlobalGetReport
Gets global report for report id.
HPMError GlobalGetReport (
    void * _pSession,
    HPMUniqueID _ResourceID,
    HPMUniqueID _ReportID,
    const HPMReport * * _pReport
    );
Parameters
_pSession
[in] A connected session. See SessionOpen.
_ResourceID
[in] The unique identifier of the resource that created the report to get.
_ReportID
[in] The unique identifier of the report to get.
_pReport
[out] Pointer to a pointer of a HPMReport object, representing the returned data.
Return Value
Returns an error code. See EHPMError.
Comments
The returned object must be freed with ObjectFree or a memory leak will result.
See Also
HPMSdkFunctions, ObjectFree, HPMReport
GlobalGetReports
Gets global reports.
HPMError GlobalGetReports (
    void * _pSession,
    HPMUniqueID _ResourceID,
    const HPMReports * * _pSettings
    );
Parameters
_pSession
[in] A connected session. See SessionOpen.
_ResourceID
[in] The unique identifier of the resource to get reports for.
_pSettings
[out] Pointer to a pointer of a HPMReports object, representing the returned data.
Return Value
Returns an error code. See EHPMError.
Comments
The returned object must be freed with ObjectFree or a memory leak will result.
See Also
HPMSdkFunctions, ObjectFree, HPMReports
GlobalSetReports
Sets global reports.
HPMError GlobalSetReports (
    void * _pSession,
    HPMUniqueID _ResourceID,
    const HPMReports * _pSettings
    );
Parameters
_pSession
[in] A connected session. See SessionOpen.
_ResourceID
[in] The unique identifier of the resource to set reports for.
_pSettings
[in] The reports to set on the resource. See HPMReports.
Return Value
Returns an error code. See EHPMError.
Comments
Changes made in submitted reports will not show up in the Helix Plan client for users that are logged in. This will be fixed in a later release.
See Also
GlobalSetDocumentAttachmentLimit
Sets the document attachment file size limit.
HPMError GlobalSetDocumentAttachmentLimit (
    void * _pSession,
    HPMInt64 _SizeLimitInBytes
    );
Parameters
_pSession
[in] A connected session. See SessionOpen.
_SizeLimitInBytes
[in] The size limit in bytes.
Return Value
Returns an error code. See EHPMError.
See Also
GlobalGetDocumentAttachmentLimit
Gets the document attachment file size limit.
HPMError GlobalGetDocumentAttachmentLimit (
    void * _pSession,
    HPMInt64 * _pSizeLimitInBytes
    );
Parameters
_pSession
[in] A connected session. See SessionOpen.
_pSizeLimitInBytes
[out] The size limit in bytes.
Return Value
Returns an error code. See EHPMError.
See Also
GlobalSetDisallowedFileTypes
Sets the document attachment disallowed file types.
HPMError GlobalSetDisallowedFileTypes (
    void * _pSession,
    HPMDisallowedFileTypes const * _pDisallowedFileTypes
    );
Parameters
_pSession
[in] A connected session. See SessionOpen.
_pDisallowedFileTypes
[in] Pointer of a HPMDisallowedFileTypes object holding the disallowed file types.
Return Value
Returns an error code. See EHPMError.
See Also
GlobalGetDisallowedFileTypes
Gets the document attachment disallowed file types.
HPMError GlobalGetDisallowedFileTypes (
    void * _pSession,
    HPMDisallowedFileTypes const * * _pDisallowedFileTypes
    );
Parameters
_pSession
[in] A connected session. See SessionOpen.
_pDisallowedFileTypes
[out] Pointer to a pointer of a HPMDisallowedFileTypes object holding the disallowed file types.
Return Value
Returns an error code. See EHPMError.
See Also
GlobalSetCommentThumbnailDimensionInPixels
Sets the maximum height and width (in pixels) of thumbnails for images in comments.
HPMError GlobalSetCommentThumbnailDimensionInPixels (
    void * _pSession,
    HPMInt32 _MaxPixel
    );
Parameters
_pSession
[in] A connected session. See SessionOpen.
_MaxPixel
[in] Max height and width of pixels. Zero means no thumbnails are generated
Return Value
Returns an error code. See EHPMError.
See Also
GlobalGetCommentThumbnailDimensionInPixels
Gets the comment images thumbnail max size.
HPMError GlobalGetCommentThumbnailDimensionInPixels (
    void * _pSession,
    HPMInt32 * _pMaxPixel
    );
Parameters
_pSession
[in] A connected session. See SessionOpen.
_pMaxPixel
[out] Max height and width of pixels.
Return Value
Returns an error code. See EHPMError.
See Also
GlobalGetChatMessageLastID
Gets the last chat message id in a chat room.
HPMError GlobalGetChatMessageLastID (
    void * _pSession,
    HPMChatRoom const * _pChatRoom,
    HPMInt64 * _pMessageID
    );
Parameters
_pSession
[in] A connected session. See SessionOpen.
_pChatRoom
[in] The chat room identifier to get last chat id for. See HPMChatRoom.
_pMessageID
[out] The last message id in the chat room.
Return Value
Returns an error code. See EHPMError.
See Also
GlobalSetTimesheetConfig
Sets the timesheet configuration.
HPMError GlobalSetTimesheetConfig (
    void * _pSession,
    const HPMTimesheetConfig * _pData
    );
Parameters
_pSession
[in] A connected session. See SessionOpen.
_pData
[in] The timesheet configuration to set. See HPMTimesheetConfig.
Return Value
Returns an error code. See EHPMError.
See Also
GlobalGetTimesheetConfig
Gets the timesheet configuration.
HPMError GlobalGetTimesheetConfig (
    void * _pSession,
    const HPMTimesheetConfig * * _pData
    );
Parameters
_pSession
[in] A connected session. See SessionOpen.
_pData
[out] Pointer to a pointer of a HPMTimesheetConfig object, representing the returned data.
Return Value
Returns an error code. See EHPMError.
Comments
The returned object must be freed with ObjectFree or a memory leak will result.
See Also
GlobalGetEmailSettings
Gets the global email settings.
HPMError GlobalGetEmailSettings (
    void * _pSession,
    const HPMGlobalEmailSettings * * _pSettings
    );
Parameters
_pSession
[in] A connected session. See SessionOpen.
_pSettings
[out] Pointer to a pointer of a HPMGlobalEmailSettings object, representing the returned data.
Return Value
Returns an error code. See EHPMError.
Comments
The returned object must be freed with ObjectFree or a memory leak will result.
See Also
HPMSdkFunctions, ObjectFree, HPMGlobalEmailSettings
GlobalSetEmailSettings
Sets the global email settings.
HPMError GlobalSetEmailSettings (
    void * _pSession,
    const HPMGlobalEmailSettings * _pSettings
    );
Parameters
_pSession
[in] A connected session. See SessionOpen.
_pSettings
[in] The global email settings. See HPMGlobalEmailSettings.
Return Value
Returns an error code. See EHPMError.
See Also
HPMSdkFunctions, HPMGlobalEmailSettings
GlobalGetDocumentAttachmentCommentRequired
Gets the attachment comment required policy.
HPMError GlobalGetDocumentAttachmentCommentRequired (
    void * _pSession,
    HPMInt32 * _pbCommentRequired
    );
Parameters
_pSession
[in] A connected session. See SessionOpen.
_pbCommentRequired
[out] Pointer to a variable that will receive the attachment comment required policy in the database. 1 if a comment is required when attaching a document to a task, 0 otherwise.
Return Value
Returns an error code. See EHPMError.
See Also
GlobalSetDocumentAttachmentCommentRequired
Sets the attachment comment required policy.
HPMError GlobalSetDocumentAttachmentCommentRequired (
    void * _pSession,
    HPMInt32 _bCommentRequired
    );
Parameters
_pSession
[in] A connected session. See SessionOpen.
_bCommentRequired
[in] The attachment comment required policy in the database. Set to 1 if a comment is required when attaching a document to a task, 0 otherwise.
Return Value
Returns an error code. See EHPMError.
See Also
HPMSdkFunctions, HPMGlobalEmailSettings
GlobalGetSecurityPolicy
Gets the security policy settings.
HPMError GlobalGetSecurityPolicy (
    void * _pSession,
    HPMSecurityPolicySettings const * * _pSettings
    );
Parameters
_pSession
[in] A connected session. See SessionOpen.
_pSettings
[out] Pointer to a pointer of a HPMSecurityPolicySettings object, representing the returned data.
Return Value
Returns an error code. See EHPMError.
Comments
The returned object must be freed with ObjectFree or a memory leak will result.
See Also
HPMSdkFunctions, ObjectFree, HPMSecurityPolicySettings
GlobalGetSecurityOptions
Gets the security options for authentication.
HPMError GlobalGetSecurityOptions (
    void * _pSession,
    HPMGlobalSecurityOptions const * * _pOptions
    );
Parameters
_pSession
[in] A connected session. See SessionOpen.
_pOptions
[out] Pointer to a pointer of a HPMGlobalSecurityOptions object, representing the returned data.
Return Value
Returns an error code. See EHPMError.
Comments
The returned object must be freed with ObjectFree or a memory leak will result.
See Also
HPMSdkFunctions, ObjectFree, HPMGlobalSecurityOptions
HPMSdkFunctions
Defines the SDK interface.
struct HPMSdkFunctions {
void * m_hDll;
HPMFunctionSessionOpen SessionOpen;
HPMFunctionSessionStop SessionStop;
HPMFunctionSessionClose SessionClose;
HPMFunctionSessionProcess SessionProcess;
HPMFunctionSessionGetInfo SessionGetInfo;
HPMFunctionRegisterChangeCallback RegisterChangeCallback;
HPMFunctionUnregisterChangeCallback UnregisterChangeCallback;
HPMFunctionObjectFree ObjectFree;
HPMFunctionObjectAddRef ObjectAddRef;
HPMFunctionObjectGetRef ObjectGetRef;
HPMFunctionObjectCompare ObjectCompare;
HPMFunctionMemoryFree MemoryFree;
HPMFunctionSessionOpenVirtual SessionOpenVirtual;
HPMFunctionSessionSetConnectionLostTimeout SessionSetConnectionLostTimeout;
HPMFunctionSessionGetDisconnectReason SessionGetDisconnectReason;
HPMFunctionGlobalSetStatisticsSettings GlobalSetStatisticsSettings;
HPMFunctionGlobalGetStatisticsSettings GlobalGetStatisticsSettings;
HPMFunctionGlobalSetServerInternetName GlobalSetServerInternetName;
HPMFunctionGlobalGetServerInternetName GlobalGetServerInternetName;
HPMFunctionGlobalGetDatabaseGUIDs GlobalGetDatabaseGUIDs;
HPMFunctionGlobalRegisterCustomSettings GlobalRegisterCustomSettings;
HPMFunctionGlobalUnregisterCustomSettings GlobalUnregisterCustomSettings;
HPMFunctionGlobalGetCustomSettingsIdentifierHash GlobalGetCustomSettingsIdentifierHash;
HPMFunctionGlobalGetRegisteredCustomSettings GlobalGetRegisteredCustomSettings;
HPMFunctionGlobalGetCustomSettingsValue GlobalGetCustomSettingsValue;
HPMFunctionGlobalSetCustomSettingsValue GlobalSetCustomSettingsValue;
HPMFunctionGlobalRegisterForDynamicCustomSettingsNotifications GlobalRegisterForDynamicCustomSettingsNotifications;
HPMFunctionGlobalRegisterForRightClickNotifications GlobalRegisterForRightClickNotifications;
HPMFunctionGlobalAddRightClickMenuItem GlobalAddRightClickMenuItem;
HPMFunctionGlobalDisplayCustomSettingsDialog GlobalDisplayCustomSettingsDialog;
HPMFunctionGlobalCancelCustomSettingsDialog GlobalCancelCustomSettingsDialog;
HPMFunctionGlobalRegisterForCustomTaskStatusNotifications GlobalRegisterForCustomTaskStatusNotifications;
HPMFunctionGlobalDisplayCustomTaskStatusDialog GlobalDisplayCustomTaskStatusDialog;
HPMFunctionGlobalCancelCustomTaskStatusDialog GlobalCancelCustomTaskStatusDialog;
HPMFunctionGlobalAddTasksCustomTaskStatusDialog GlobalAddTasksCustomTaskStatusDialog;
HPMFunctionGlobalRequestDynamicCustomSettingsValues GlobalRequestDynamicCustomSettingsValues;
HPMFunctionGlobalSetDynamicCustomSettingsValues GlobalSetDynamicCustomSettingsValues;
HPMFunctionGlobalGetSDKInternalDataIdentifierHash GlobalGetSDKInternalDataIdentifierHash;
HPMFunctionGlobalGetSDKInternalData GlobalGetSDKInternalData;
HPMFunctionGlobalSetSDKInternalData GlobalSetSDKInternalData;
HPMFunctionGlobalWorkflowsRemoveDeleted GlobalWorkflowsRemoveDeleted;
HPMFunctionGlobalGetReport GlobalGetReport;
HPMFunctionGlobalGetReports GlobalGetReports;
HPMFunctionGlobalSetReports GlobalSetReports;
HPMFunctionGlobalSetDocumentAttachmentLimit GlobalSetDocumentAttachmentLimit;
HPMFunctionGlobalGetDocumentAttachmentLimit GlobalGetDocumentAttachmentLimit;
HPMFunctionGlobalSetDisallowedFileTypes GlobalSetDisallowedFileTypes;
HPMFunctionGlobalGetDisallowedFileTypes GlobalGetDisallowedFileTypes;
HPMFunctionGlobalSetCommentThumbnailDimensionInPixels GlobalSetCommentThumbnailDimensionInPixels;
HPMFunctionGlobalGetCommentThumbnailDimensionInPixels GlobalGetCommentThumbnailDimensionInPixels;
HPMFunctionGlobalGetChatMessageLastID GlobalGetChatMessageLastID;
HPMFunctionGlobalSetTimesheetConfig GlobalSetTimesheetConfig;
HPMFunctionGlobalGetTimesheetConfig GlobalGetTimesheetConfig;
HPMFunctionGlobalSetEmailSettings GlobalSetEmailSettings;
HPMFunctionGlobalGetEmailSettings GlobalGetEmailSettings;
HPMFunctionGlobalSetDocumentAttachmentCommentRequired GlobalSetDocumentAttachmentCommentRequired;
HPMFunctionGlobalGetDocumentAttachmentCommentRequired GlobalGetDocumentAttachmentCommentRequired;
HPMFunctionResourceCreate ResourceCreate;
HPMFunctionResourceDelete ResourceDelete;
HPMFunctionResourceImpersonate ResourceImpersonate;
HPMFunctionResourceEnum ResourceEnum;
HPMFunctionResourceGetProperties ResourceGetProperties;
HPMFunctionResourceSetProperties ResourceSetProperties;
HPMFunctionResourceGetGlobalSettings ResourceGetGlobalSettings;
HPMFunctionResourceSetGlobalSettings ResourceSetGlobalSettings;
HPMFunctionResourceGetCustomSettingsValue ResourceGetCustomSettingsValue;
HPMFunctionResourceSetCustomSettingsValue ResourceSetCustomSettingsValue;
HPMFunctionResourceGetSDKInternalData ResourceGetSDKInternalData;
HPMFunctionResourceSetSDKInternalData ResourceSetSDKInternalData;
HPMFunctionResourceGroupCreate ResourceGroupCreate;
HPMFunctionResourceGroupDelete ResourceGroupDelete;
HPMFunctionResourceGroupEnum ResourceGroupEnum;
HPMFunctionResourceGroupGetProperties ResourceGroupGetProperties;
HPMFunctionResourceGroupSetProperties ResourceGroupSetProperties;
HPMFunctionResourceGroupNewCreate ResourceGroupNewCreate;
HPMFunctionResourceGroupNewEdit ResourceGroupNewEdit;
HPMFunctionResourceGroupNewDelete ResourceGroupNewDelete;
HPMFunctionResourceGroupGetNextID ResourceGroupGetNextID;
HPMFunctionResourceGetLoggedIn ResourceGetLoggedIn;
HPMFunctionResourceGroupGetResources ResourceGroupGetResources;
HPMFunctionResourceGetResourceFromName ResourceGetResourceFromName;
HPMFunctionResourceGetNameFromResource ResourceGetNameFromResource;
HPMFunctionResourceGroupGetNameFromResourceGroup ResourceGroupGetNameFromResourceGroup;
HPMFunctionResourceGroupUtilResourceGroupExists ResourceGroupUtilResourceGroupExists;
HPMFunctionResourceGetImpersonate ResourceGetImpersonate;
HPMFunctionResourceGetLockFlags ResourceGetLockFlags;
HPMFunctionResourceChangeLockFlags ResourceChangeLockFlags;
HPMFunctionResourceSetPreferredLanguage ResourceSetPreferredLanguage;
HPMFunctionResourceGetPreferredLanguage ResourceGetPreferredLanguage;
HPMFunctionResourceSetLastUsedLanguage ResourceSetLastUsedLanguage;
HPMFunctionResourceGetLastUsedLanguage ResourceGetLastUsedLanguage;
HPMFunctionResourceGetEffectiveLanguage ResourceGetEffectiveLanguage;
HPMFunctionResourceTimesheetPeriodDataDelete ResourceTimesheetPeriodDataDelete;
HPMFunctionResourceUtilExpandResources ResourceUtilExpandResources;
HPMFunctionResourceSetChatOnlineStatus ResourceSetChatOnlineStatus;
HPMFunctionResourceGetChatOnlineStatus ResourceGetChatOnlineStatus;
HPMFunctionResourceSetDoNotDisturb ResourceSetDoNotDisturb;
HPMFunctionResourceGetDoNotDisturb ResourceGetDoNotDisturb;
HPMFunctionResourceSendChatMessage ResourceSendChatMessage;
HPMFunctionResourceSetLastReadChatID ResourceSetLastReadChatID;
HPMFunctionResourceGetLastReadChatID ResourceGetLastReadChatID;
HPMFunctionResourceUploadAvatar ResourceUploadAvatar;
HPMFunctionResourceGetTimesheetDay ResourceGetTimesheetDay;
HPMFunctionResourceGetDashboardPage ResourceGetDashboardPage;
HPMFunctionResourceReplaceGuestResourceWithHomeResource ResourceReplaceGuestResourceWithHomeResource;
HPMFunctionResourceMakeGuestResourceAHomeResource ResourceMakeGuestResourceAHomeResource;
HPMFunctionTimesheetRowSetActivityID TimesheetRowSetActivityID;
HPMFunctionTimesheetRowSetProjectID TimesheetRowSetProjectID;
HPMFunctionTimesheetRowSetTaskID TimesheetRowSetTaskID;
HPMFunctionTimesheetRowSetStartedTime TimesheetRowSetStartedTime;
HPMFunctionTimesheetRowSetDurationTime TimesheetRowSetDurationTime;
HPMFunctionTimesheetRowSetComment TimesheetRowSetComment;
HPMFunctionTimesheetRowDelete TimesheetRowDelete;
HPMFunctionTimesheetGetDateRange TimesheetGetDateRange;
HPMFunctionTimesheetCreateTaskTimeSpentRow TimesheetCreateTaskTimeSpentRow;
HPMFunctionProjectCreate ProjectCreate;
HPMFunctionProjectClone ProjectClone;
HPMFunctionProjectDelete ProjectDelete;
HPMFunctionProjectEnum ProjectEnum;
HPMFunctionProjectEnumNonArchived ProjectEnumNonArchived;
HPMFunctionProjectGetProperties ProjectGetProperties;
HPMFunctionProjectSetProperties ProjectSetProperties;
HPMFunctionProjectGetSettings ProjectGetSettings;
HPMFunctionProjectSetSettings ProjectSetSettings;
HPMFunctionProjectGetEmailSettings ProjectGetEmailSettings;
HPMFunctionProjectSetEmailSettings ProjectSetEmailSettings;
HPMFunctionProjectGetHistoryAutoSaveSettings ProjectGetHistoryAutoSaveSettings;
HPMFunctionProjectSetHistoryAutoSaveSettings ProjectSetHistoryAutoSaveSettings;
HPMFunctionProjectGetCompletionStyle ProjectGetCompletionStyle;
HPMFunctionProjectWorkflowEnum ProjectWorkflowEnum;
HPMFunctionProjectWorkflowEnumWorkflow ProjectWorkflowEnumWorkflow;
HPMFunctionProjectWorkflowEnumObject ProjectWorkflowEnumObject;
HPMFunctionProjectWorkflowCreate ProjectWorkflowCreate;
HPMFunctionProjectWorkflowDelete ProjectWorkflowDelete;
HPMFunctionProjectWorkflowGetObject ProjectWorkflowGetObject;
HPMFunctionProjectWorkflowGetSettings ProjectWorkflowGetSettings;
HPMFunctionProjectWorkflowSetSettings ProjectWorkflowSetSettings;
HPMFunctionProjectWorkflowSetLatestVersion ProjectWorkflowSetLatestVersion;
HPMFunctionProjectWorkflowGetNewestVersion ProjectWorkflowGetNewestVersion;
HPMFunctionProjectGetStatisticsSettings ProjectGetStatisticsSettings;
HPMFunctionProjectSetStatisticsSettings ProjectSetStatisticsSettings;
HPMFunctionProjectGetWallSettings ProjectGetWallSettings;
HPMFunctionProjectSetWallSettings ProjectSetWallSettings;
HPMFunctionProjectGetWallGroups ProjectGetWallGroups;
HPMFunctionProjectSetWallGroups ProjectSetWallGroups;
HPMFunctionProjectGetDetailedAccessRules ProjectGetDetailedAccessRules;
HPMFunctionProjectSetDetailedAccessRules ProjectSetDetailedAccessRules;
HPMFunctionProjectGetReport ProjectGetReport;
HPMFunctionProjectGetReports ProjectGetReports;
HPMFunctionProjectSetReports ProjectSetReports;
HPMFunctionProjectEnumReportResources ProjectEnumReportResources;
HPMFunctionProjectGetCustomStatisticsSettings ProjectGetCustomStatisticsSettings;
HPMFunctionProjectSetCustomStatisticsSettings ProjectSetCustomStatisticsSettings;
HPMFunctionProjectGetWorkflowStatusStats ProjectGetWorkflowStatusStats;
HPMFunctionProjectUtilGetWorkflowProgression ProjectUtilGetWorkflowProgression;
HPMFunctionProjectCustomColumnsGet ProjectCustomColumnsGet;
HPMFunctionProjectCustomColumnsSet ProjectCustomColumnsSet;
HPMFunctionProjectGetDefaultActivatedColumns ProjectGetDefaultActivatedColumns;
HPMFunctionProjectSetDefaultActivatedColumns ProjectSetDefaultActivatedColumns;
HPMFunctionProjectGetCustomSettingsValue ProjectGetCustomSettingsValue;
HPMFunctionProjectSetCustomSettingsValue ProjectSetCustomSettingsValue;
HPMFunctionProjectGetSDKInternalData ProjectGetSDKInternalData;
HPMFunctionProjectSetSDKInternalData ProjectSetSDKInternalData;
HPMFunctionProjectUtilGetWorkflowStructure ProjectUtilGetWorkflowStructure;
HPMFunctionProjectResourceAdd ProjectResourceAdd;
HPMFunctionProjectResourceRemove ProjectResourceRemove;
HPMFunctionProjectResourceEnum ProjectResourceEnum;
HPMFunctionProjectResourceGetProperties ProjectResourceGetProperties;
HPMFunctionProjectResourceSetProperties ProjectResourceSetProperties;
HPMFunctionProjectResourceGetCustomSettingsValue ProjectResourceGetCustomSettingsValue;
HPMFunctionProjectResourceSetCustomSettingsValue ProjectResourceSetCustomSettingsValue;
HPMFunctionProjectResourceGetParentTaskDisplayDepth ProjectResourceGetParentTaskDisplayDepth;
HPMFunctionProjectResourceSetParentTaskDisplayDepth ProjectResourceSetParentTaskDisplayDepth;
HPMFunctionProjectResourceGroupAdd ProjectResourceGroupAdd;
HPMFunctionProjectResourceGroupRemove ProjectResourceGroupRemove;
HPMFunctionProjectResourceGroupEnum ProjectResourceGroupEnum;
HPMFunctionProjectResourceGetSDKInternalData ProjectResourceGetSDKInternalData;
HPMFunctionProjectResourceSetSDKInternalData ProjectResourceSetSDKInternalData;
HPMFunctionProjectResourceUtilIsMember ProjectResourceUtilIsMember;
HPMFunctionProjectViewPresetApply ProjectViewPresetApply;
HPMFunctionProjectUtilGetBacklog ProjectUtilGetBacklog;
HPMFunctionProjectUtilGetQA ProjectUtilGetQA;
HPMFunctionProjectUtilIsArchived ProjectUtilIsArchived;
HPMFunctionProjectGetAgilePriorityCustomColumn ProjectGetAgilePriorityCustomColumn;
HPMFunctionProjectSetAgilePriorityCustomColumn ProjectSetAgilePriorityCustomColumn;
HPMFunctionProjectGetCustomColumn ProjectGetCustomColumn;
HPMFunctionProjectGetOldCustomColumn ProjectGetOldCustomColumn;
HPMFunctionProjectGetCustomColumnAncestry ProjectGetCustomColumnAncestry;
HPMFunctionProjectGetDefaultActivatedNonHidableColumns ProjectGetDefaultActivatedNonHidableColumns;
HPMFunctionProjectGetDefaultAvailableColumns ProjectGetDefaultAvailableColumns;
HPMFunctionProjectCalendarGetWorkingDays ProjectCalendarGetWorkingDays;
HPMFunctionProjectCalendarSetWorkingDays ProjectCalendarSetWorkingDays;
HPMFunctionProjectCalendarGetCustomWorkingDays ProjectCalendarGetCustomWorkingDays;
HPMFunctionProjectCalendarSetCustomWorkingDays ProjectCalendarSetCustomWorkingDays;
HPMFunctionProjectCalendarGetWorkingHours ProjectCalendarGetWorkingHours;
HPMFunctionProjectCalendarSetWorkingHours ProjectCalendarSetWorkingHours;
HPMFunctionProjectCalendarGetCustomWorkingHours ProjectCalendarGetCustomWorkingHours;
HPMFunctionProjectCalendarSetCustomWorkingHours ProjectCalendarSetCustomWorkingHours;
HPMFunctionProjectCalendarGetHolidays ProjectCalendarGetHolidays;
HPMFunctionProjectCalendarSetHolidays ProjectCalendarSetHolidays;
HPMFunctionProjectGetCalendarDayInfo ProjectGetCalendarDayInfo;
HPMFunctionProjectGetViewPresets ProjectGetViewPresets;
HPMFunctionProjectSetTimesheetLock ProjectSetTimesheetLock;
HPMFunctionProjectGetTimesheetLock ProjectGetTimesheetLock;
HPMFunctionProjectDisplayUserMessage ProjectDisplayUserMessage;
HPMFunctionProjectSetBugReportResources ProjectSetBugReportResources;
HPMFunctionProjectGetBugReportResources ProjectGetBugReportResources;
HPMFunctionProjectSetDefaultQAWorkflow ProjectSetDefaultQAWorkflow;
HPMFunctionProjectGetDefaultQAWorkflow ProjectGetDefaultQAWorkflow;
HPMFunctionProjectGetConvertedQAWorkflow ProjectGetConvertedQAWorkflow;
HPMFunctionProjectCreateViewPreset ProjectCreateViewPreset;
HPMFunctionProjectChangeViewPreset ProjectChangeViewPreset;
HPMFunctionProjectDeleteViewPreset ProjectDeleteViewPreset;
HPMFunctionProjectGetColumnMetaData ProjectGetColumnMetaData;
HPMFunctionProjectSetColumnMetaData ProjectSetColumnMetaData;
HPMFunctionProjectGetFunctionColumnExpression ProjectGetFunctionColumnExpression;
HPMFunctionProjectGetFunctionColumnExpressionError ProjectGetFunctionColumnExpressionError;
HPMFunctionProjectGetAttachmentPath ProjectGetAttachmentPath;
HPMFunctionProjectSetOverviewText ProjectSetOverviewText;
HPMFunctionProjectGetOverviewText ProjectGetOverviewText;
HPMFunctionProjectExportXML ProjectExportXML;
HPMFunctionProjectUtilPrepareFunctionColumnLocalContext ProjectUtilPrepareFunctionColumnLocalContext;
HPMFunctionProjectUtilParseLocalContextFunctionColumnExpression ProjectUtilParseLocalContextFunctionColumnExpression;
HPMFunctionProjectUtilApplyLocalContextFunctionColumnChanges ProjectUtilApplyLocalContextFunctionColumnChanges;
HPMFunctionProjectUtilValidateLocalContextFunctionColumnExpressionChanges ProjectUtilValidateLocalContextFunctionColumnExpressionChanges;
HPMFunctionProjectUtilGetLocalContextFunctionColumnTokens ProjectUtilGetLocalContextFunctionColumnTokens;
HPMFunctionProjectUtilGetLocalContextCustomColumnName ProjectUtilGetLocalContextCustomColumnName;
HPMFunctionProjectUtilGetLocalContextFunctionColumnExpressionString ProjectUtilGetLocalContextFunctionColumnExpressionString;
HPMFunctionProjectUtilGetLocalContextCustomColumns ProjectUtilGetLocalContextCustomColumns;
HPMFunctionUtilDecodeStringPosition UtilDecodeStringPosition;
HPMFunctionUtilEncodeStringPosition UtilEncodeStringPosition;
HPMFunctionProjectUtilCompareCustomColumns ProjectUtilCompareCustomColumns;
HPMFunctionProjectWaitUntilFunctionColumnCalculated ProjectWaitUntilFunctionColumnCalculated;
HPMFunctionTaskCreateUnified TaskCreateUnified;
HPMFunctionTaskMoveProject TaskMoveProject;
HPMFunctionTaskDelete TaskDelete;
HPMFunctionTaskEnum TaskEnum;
HPMFunctionTaskEnumConnections TaskEnumConnections;
HPMFunctionTaskEnumReferences TaskEnumReferences;
HPMFunctionTaskChangeDisposition TaskChangeDisposition;
HPMFunctionTaskGetMainReference TaskGetMainReference;
HPMFunctionTaskGetProxy TaskGetProxy;
HPMFunctionTaskGetContainer TaskGetContainer;
HPMFunctionTaskEnumCustomColumnData TaskEnumCustomColumnData;
HPMFunctionTaskEnumComments TaskEnumComments;
HPMFunctionTaskSetBacklogCategory TaskSetBacklogCategory;
HPMFunctionTaskGetBacklogCategory TaskGetBacklogCategory;
HPMFunctionTaskSetColor TaskSetColor;
HPMFunctionTaskGetColor TaskGetColor;
HPMFunctionTaskSetWallItemColor TaskSetWallItemColor;
HPMFunctionTaskGetWallItemColor TaskGetWallItemColor;
HPMFunctionTaskSetComplexityPoints TaskSetComplexityPoints;
HPMFunctionTaskGetComplexityPoints TaskGetComplexityPoints;
HPMFunctionTaskSetConfidence TaskSetConfidence;
HPMFunctionTaskGetConfidence TaskGetConfidence;
HPMFunctionTaskSetEstimatedIdealDays TaskSetEstimatedIdealDays;
HPMFunctionTaskGetEstimatedIdealDays TaskGetEstimatedIdealDays;
HPMFunctionTaskSetRisk TaskSetRisk;
HPMFunctionTaskGetRisk TaskGetRisk;
HPMFunctionTaskSetStartOffset TaskSetStartOffset;
HPMFunctionTaskGetStartOffset TaskGetStartOffset;
HPMFunctionTaskSetDuration TaskSetDuration;
HPMFunctionTaskGetDuration TaskGetDuration;
HPMFunctionTaskSetForceSubProject TaskSetForceSubProject;
HPMFunctionTaskGetForceSubProject TaskGetForceSubProject;
HPMFunctionTaskSetBudgetedWork TaskSetBudgetedWork;
HPMFunctionTaskGetBudgetedWork TaskGetBudgetedWork;
HPMFunctionTaskGetLockedType TaskGetLockedType;
HPMFunctionTaskSetPercentComplete TaskSetPercentComplete;
HPMFunctionTaskGetPercentComplete TaskGetPercentComplete;
HPMFunctionTaskSetStatus TaskSetStatus;
HPMFunctionTaskGetStatus TaskGetStatus;
HPMFunctionTaskGetType TaskGetType;
HPMFunctionTaskSetVacationOptions TaskSetVacationOptions;
HPMFunctionTaskGetVacationOptions TaskGetVacationOptions;
HPMFunctionTaskCreateComment TaskCreateComment;
HPMFunctionTaskDeleteComment TaskDeleteComment;
HPMFunctionTaskNotifyCommentPosted TaskNotifyCommentPosted;
HPMFunctionTaskSetComment TaskSetComment;
HPMFunctionTaskGetComment TaskGetComment;
HPMFunctionTaskSetDescription TaskSetDescription;
HPMFunctionTaskGetDescription TaskGetDescription;
HPMFunctionTaskSetHyperlink TaskSetHyperlink;
HPMFunctionTaskGetHyperlink TaskGetHyperlink;
HPMFunctionTaskSetCommentsOptions TaskSetCommentsOptions;
HPMFunctionTaskGetCommentsOptions TaskGetCommentsOptions;
HPMFunctionTaskSetLockedBy TaskSetLockedBy;
HPMFunctionTaskGetLockedBy TaskGetLockedBy;
HPMFunctionTaskSetOriginallyCreatedBy TaskSetOriginallyCreatedBy;
HPMFunctionTaskGetOriginallyCreatedBy TaskGetOriginallyCreatedBy;
HPMFunctionTaskSetCustomColumnData TaskSetCustomColumnData;
HPMFunctionTaskGetCustomColumnData TaskGetCustomColumnData;
HPMFunctionTaskSetLastResourceCommentReadTime TaskSetLastResourceCommentReadTime;
HPMFunctionTaskGetLastResourceCommentReadTime TaskGetLastResourceCommentReadTime;
HPMFunctionTaskSetAttachedDocuments TaskSetAttachedDocuments;
HPMFunctionTaskGetAttachedDocuments TaskGetAttachedDocuments;
HPMFunctionTaskSetDelegateTo TaskSetDelegateTo;
HPMFunctionTaskGetDelegateTo TaskGetDelegateTo;
HPMFunctionTaskSetResourceAllocation TaskSetResourceAllocation;
HPMFunctionTaskGetResourceAllocation TaskGetResourceAllocation;
HPMFunctionTaskSetSprintAllocatedResources TaskSetSprintAllocatedResources;
HPMFunctionTaskGetSprintAllocatedResources TaskGetSprintAllocatedResources;
HPMFunctionTaskSetSprintResourceAllocation TaskSetSprintResourceAllocation;
HPMFunctionTaskGetSprintResourceAllocation TaskGetSprintResourceAllocation;
HPMFunctionTaskGetOldPercentResourceAllocation TaskGetOldPercentResourceAllocation;
HPMFunctionTaskSetCompleted TaskSetCompleted;
HPMFunctionTaskGetCompleted TaskGetCompleted;
HPMFunctionTaskSetTimeZones TaskSetTimeZones;
HPMFunctionTaskGetTimeZones TaskGetTimeZones;
HPMFunctionTaskGetTotalDuration TaskGetTotalDuration;
HPMFunctionTaskSetVisibleTo TaskSetVisibleTo;
HPMFunctionTaskGetVisibleTo TaskGetVisibleTo;
HPMFunctionTaskSetWorkRemaining TaskSetWorkRemaining;
HPMFunctionTaskGetWorkRemaining TaskGetWorkRemaining;
HPMFunctionTaskSetWorkRemainingHistory TaskSetWorkRemainingHistory;
HPMFunctionTaskGetWorkRemainingHistory TaskGetWorkRemainingHistory;
HPMFunctionTaskEnumWorkRemainingHistoryDays TaskEnumWorkRemainingHistoryDays;
HPMFunctionTaskSetIdealDaysHistory TaskSetIdealDaysHistory;
HPMFunctionTaskGetIdealDaysHistory TaskGetIdealDaysHistory;
HPMFunctionTaskEnumIdealDaysHistoryDays TaskEnumIdealDaysHistoryDays;
HPMFunctionTaskSetPointsHistory TaskSetPointsHistory;
HPMFunctionTaskGetPointsHistory TaskGetPointsHistory;
HPMFunctionTaskEnumPointsHistoryDays TaskEnumPointsHistoryDays;
HPMFunctionTaskSetSeverity TaskSetSeverity;
HPMFunctionTaskGetSeverity TaskGetSeverity;
HPMFunctionTaskSetWorkflowStatus TaskSetWorkflowStatus;
HPMFunctionTaskGetWorkflowStatus TaskGetWorkflowStatus;
HPMFunctionTaskSetUserStoryFlag TaskSetUserStoryFlag;
HPMFunctionTaskGetUserStoryFlag TaskGetUserStoryFlag;
HPMFunctionTaskSetEpicFlag TaskSetEpicFlag;
HPMFunctionTaskGetEpicFlag TaskGetEpicFlag;
HPMFunctionTaskSetLastUpdatedTime TaskSetLastUpdatedTime;
HPMFunctionTaskGetLastUpdatedTime TaskGetLastUpdatedTime;
HPMFunctionTaskSetLastUpdatedBy TaskSetLastUpdatedBy;
HPMFunctionTaskGetLastUpdatedBy TaskGetLastUpdatedBy;
HPMFunctionTaskSetDetailedDescription TaskSetDetailedDescription;
HPMFunctionTaskGetDetailedDescription TaskGetDetailedDescription;
HPMFunctionTaskSetStepsToReproduce TaskSetStepsToReproduce;
HPMFunctionTaskGetStepsToReproduce TaskGetStepsToReproduce;
HPMFunctionTaskSetSprintResourcesHaveFullRights TaskSetSprintResourcesHaveFullRights;
HPMFunctionTaskGetSprintResourcesHaveFullRights TaskGetSprintResourcesHaveFullRights;
HPMFunctionTaskGetAttachmentPath TaskGetAttachmentPath;
HPMFunctionTaskGetID TaskGetID;
HPMFunctionTaskSetLinkedToMilestones TaskSetLinkedToMilestones;
HPMFunctionTaskGetLinkedToMilestones TaskGetLinkedToMilestones;
HPMFunctionTaskGetLinkedToSprint TaskGetLinkedToSprint;
HPMFunctionTaskSetLinkedTo TaskSetLinkedTo;
HPMFunctionTaskGetLinkedTo TaskGetLinkedTo;
HPMFunctionTaskSetWallPositions TaskSetWallPositions;
HPMFunctionTaskGetWallPositions TaskGetWallPositions;
HPMFunctionTaskSetFullyCreated TaskSetFullyCreated;
HPMFunctionTaskGetFullyCreated TaskGetFullyCreated;
HPMFunctionTaskSetArchived TaskSetArchived;
HPMFunctionTaskGetArchived TaskGetArchived;
HPMFunctionTaskUpdatePipelineWorkflowToNewestVersion TaskUpdatePipelineWorkflowToNewestVersion;
HPMFunctionUtilPrepareFindContext UtilPrepareFindContext;
HPMFunctionUtilUpdateFindContext UtilUpdateFindContext;
HPMFunctionTaskFind TaskFind;
HPMFunctionTaskRefUtilIsInFindContext TaskRefUtilIsInFindContext;
HPMFunctionTaskSetWorkflow TaskSetWorkflow;
HPMFunctionTaskGetWorkflow TaskGetWorkflow;
HPMFunctionTaskGetLinkedToPipelineTask TaskGetLinkedToPipelineTask;
HPMFunctionTaskSetCreatedPipelineTasks TaskSetCreatedPipelineTasks;
HPMFunctionTaskGetCreatedPipelineTasks TaskGetCreatedPipelineTasks;
HPMFunctionTaskSetCreatedFromWorkflowObject TaskSetCreatedFromWorkflowObject;
HPMFunctionTaskGetCreatedFromWorkflowObject TaskGetCreatedFromWorkflowObject;
HPMFunctionTaskSetDefaultWorkflow TaskSetDefaultWorkflow;
HPMFunctionTaskGetDefaultWorkflow TaskGetDefaultWorkflow;
HPMFunctionTaskPipelineGetTaskRef TaskPipelineGetTaskRef;
HPMFunctionTaskRefGetColumnText TaskRefGetColumnText;
HPMFunctionTaskGetLastAssignedInWorkflowStatus TaskGetLastAssignedInWorkflowStatus;
HPMFunctionTaskGetLastAssignedInWorkflowStatuses TaskGetLastAssignedInWorkflowStatuses;
HPMFunctionTaskGetLastEnterWorkflowStatus TaskGetLastEnterWorkflowStatus;
HPMFunctionTaskGetLastExitWorkflowStatus TaskGetLastExitWorkflowStatus;
HPMFunctionTaskGetAgilePriorityCategory TaskGetAgilePriorityCategory;
HPMFunctionTaskSetAgilePriorityCategory TaskSetAgilePriorityCategory;
HPMFunctionTaskGetBacklogPriority TaskGetBacklogPriority;
HPMFunctionTaskSetBacklogPriority TaskSetBacklogPriority;
HPMFunctionTaskGetSprintPriority TaskGetSprintPriority;
HPMFunctionTaskSetSprintPriority TaskSetSprintPriority;
HPMFunctionTaskGetBugPriority TaskGetBugPriority;
HPMFunctionTaskSetBugPriority TaskSetBugPriority;
HPMFunctionTaskUtilGetWorkflowProgression TaskUtilGetWorkflowProgression;
HPMFunctionTaskUtilGetWorkflowProgressionFromTaskStatusChange TaskUtilGetWorkflowProgressionFromTaskStatusChange;
HPMFunctionTaskGetSDKInternalData TaskGetSDKInternalData;
HPMFunctionTaskSetSDKInternalData TaskSetSDKInternalData;
HPMFunctionTaskGetCommentSDKInternalData TaskGetCommentSDKInternalData;
HPMFunctionTaskSetCommentSDKInternalData TaskSetCommentSDKInternalData;
HPMFunctionTaskRefGetTask TaskRefGetTask;
HPMFunctionTaskRefGetContainer TaskRefGetContainer;
HPMFunctionTaskRefEnum TaskRefEnum;
HPMFunctionTaskRefConnect TaskRefConnect;
HPMFunctionTaskRefGetTreeLevel TaskRefGetTreeLevel;
HPMFunctionTaskRefGetPreviousID TaskRefGetPreviousID;
HPMFunctionTaskRefClearNewlyCreated TaskRefClearNewlyCreated;
HPMFunctionTaskRefGetNewlyCreated TaskRefGetNewlyCreated;
HPMFunctionTaskRefSetUIDHistory TaskRefSetUIDHistory;
HPMFunctionTaskRefGetUIDHistory TaskRefGetUIDHistory;
HPMFunctionTaskRefGetPreviousWorkPriorityID TaskRefGetPreviousWorkPriorityID;
HPMFunctionTaskRefGetSummary TaskRefGetSummary;
HPMFunctionTaskRefGetMilestoneSummary TaskRefGetMilestoneSummary;
HPMFunctionTaskRefConnectionsEnum TaskRefConnectionsEnum;
HPMFunctionTaskUtilSprintTaskRefEnum TaskUtilSprintTaskRefEnum;
HPMFunctionTaskUtilGetEffectiveLinkedToMilestones TaskUtilGetEffectiveLinkedToMilestones;
HPMFunctionTaskGetOriginallyCreatedOnTime TaskGetOriginallyCreatedOnTime;
HPMFunctionTaskRefGetSDKInternalData TaskRefGetSDKInternalData;
HPMFunctionTaskRefSetSDKInternalData TaskRefSetSDKInternalData;
HPMFunctionTaskRefUtilGetSubProjectPath TaskRefUtilGetSubProjectPath;
HPMFunctionTaskRefUtilEnumChildren TaskRefUtilEnumChildren;
HPMFunctionTaskRefUtilEnumPipelineProgression TaskRefUtilEnumPipelineProgression;
HPMFunctionTaskRefUtilGetParent TaskRefUtilGetParent;
HPMFunctionTaskRefUtilGetNext TaskRefUtilGetNext;
HPMFunctionTaskRefUtilGetNextSibling TaskRefUtilGetNextSibling;
HPMFunctionTaskRefUtilGetPrevSibling TaskRefUtilGetPrevSibling;
HPMFunctionTaskRefUtilGetNextAtSameOrLowerLevel TaskRefUtilGetNextAtSameOrLowerLevel;
HPMFunctionTaskRefUtilGetPrevAtSameOrLowerLevel TaskRefUtilGetPrevAtSameOrLowerLevel;
HPMFunctionTaskRefUtilMoveInTree TaskRefUtilMoveInTree;
HPMFunctionTaskRefUtilTraceTree TaskRefUtilTraceTree;
HPMFunctionTaskRefUtilIsCompleted TaskRefUtilIsCompleted;
HPMFunctionTaskRefUtilHasChildren TaskRefUtilHasChildren;
HPMFunctionTaskRefUtilCanStartNow TaskRefUtilCanStartNow;
HPMFunctionTaskUtilOneTaskRefHasChildren TaskUtilOneTaskRefHasChildren;
HPMFunctionTaskUtilUpdateAgilePriority TaskUtilUpdateAgilePriority;
HPMFunctionTaskRefGetWBSPath TaskRefGetWBSPath;
HPMFunctionTaskConnectionDelete TaskConnectionDelete;
HPMFunctionTaskConnectionSetConnectionType TaskConnectionSetConnectionType;
HPMFunctionTaskConnectionGetConnectionType TaskConnectionGetConnectionType;
HPMFunctionTaskConnectionSetLeadLagTime TaskConnectionSetLeadLagTime;
HPMFunctionTaskConnectionGetLeadLagTime TaskConnectionGetLeadLagTime;
HPMFunctionTaskConnectionGetConnectFrom TaskConnectionGetConnectFrom;
HPMFunctionTaskConnectionGetConnectTo TaskConnectionGetConnectTo;
HPMFunctionVersionControlRegisterCallback VersionControlRegisterCallback;
HPMFunctionVersionControlUnregisterCallback VersionControlUnregisterCallback;
HPMFunctionVersionControlInit VersionControlInit;
HPMFunctionVersionControlErrorToStr VersionControlErrorToStr;
HPMFunctionVersionControlEnumFiles VersionControlEnumFiles;
HPMFunctionVersionControlFileExists VersionControlFileExists;
HPMFunctionVersionControlOperationPending VersionControlOperationPending;
HPMFunctionVersionControlGetFileInfo VersionControlGetFileInfo;
HPMFunctionVersionControlGetFileHistory VersionControlGetFileHistory;
HPMFunctionVersionControlGetAccessRights VersionControlGetAccessRights;
HPMFunctionVersionControlAddFiles VersionControlAddFiles;
HPMFunctionVersionControlCreateDirectories VersionControlCreateDirectories;
HPMFunctionVersionControlSyncFiles VersionControlSyncFiles;
HPMFunctionVersionControlCheckOutFiles VersionControlCheckOutFiles;
HPMFunctionVersionControlCheckInFiles VersionControlCheckInFiles;
HPMFunctionVersionControlRenameFiles VersionControlRenameFiles;
HPMFunctionVersionControlRevertFiles VersionControlRevertFiles;
HPMFunctionVersionControlDeleteFiles VersionControlDeleteFiles;
HPMFunctionVersionControlRestoreDeletedFiles VersionControlRestoreDeletedFiles;
HPMFunctionVersionControlDeleteVersions VersionControlDeleteVersions;
HPMFunctionVersionControlRollbackFile VersionControlRollbackFile;
HPMFunctionVersionControlSetAccessRights VersionControlSetAccessRights;
HPMFunctionVersionControlUtilPathToFileID VersionControlUtilPathToFileID;
HPMFunctionVersionControlUtilFileIDToPath VersionControlUtilFileIDToPath;
HPMFunctionVersionControlUtilIsInitialized VersionControlUtilIsInitialized;
HPMFunctionVersionControlSetLocalPath VersionControlSetLocalPath;
HPMFunctionCommunicationChannelRegister CommunicationChannelRegister;
HPMFunctionCommunicationChannelUnregister CommunicationChannelUnregister;
HPMFunctionCommunicationChannelSendPacket CommunicationChannelSendPacket;
HPMFunctionCommunicationChannelEnum CommunicationChannelEnum;
HPMFunctionChatHistoryGetHistory ChatHistoryGetHistory;
HPMFunctionDataHistoryGetHistory DataHistoryGetHistory;
HPMFunctionDataHistoryGetEntryData DataHistoryGetEntryData;
HPMFunctionDataHistorySetMaxCacheEntries DataHistorySetMaxCacheEntries;
HPMFunctionVariantDecode_HPMInt32 VariantDecode_HPMInt32;
HPMFunctionVariantDecode_HPMUInt32 VariantDecode_HPMUInt32;
HPMFunctionVariantDecode_HPMInt64 VariantDecode_HPMInt64;
HPMFunctionVariantDecode_HPMUInt64 VariantDecode_HPMUInt64;
HPMFunctionVariantDecode_HPMFP32 VariantDecode_HPMFP32;
HPMFunctionVariantDecode_HPMFP64 VariantDecode_HPMFP64;
HPMFunctionVariantDecode_HPMUniqueID VariantDecode_HPMUniqueID;
HPMFunctionVariantDecode_HPMString VariantDecode_HPMString;
HPMFunctionVariantDecode_HPMTaskLinkedToMilestones VariantDecode_HPMTaskLinkedToMilestones;
HPMFunctionVariantDecode_HPMTaskDelegateTo VariantDecode_HPMTaskDelegateTo;
HPMFunctionVariantDecode_HPMTaskSprintAllocatedResources VariantDecode_HPMTaskSprintAllocatedResources;
HPMFunctionVariantDecode_HPMTaskVisibleTo VariantDecode_HPMTaskVisibleTo;
HPMFunctionVariantDecode_HPMTaskResourceAllocation VariantDecode_HPMTaskResourceAllocation;
HPMFunctionVariantDecode_HPMStatisticsMultiFrequency VariantDecode_HPMStatisticsMultiFrequency;
HPMFunctionVariantDecode_HPMStatisticsCustomStatisticsFrequency VariantDecode_HPMStatisticsCustomStatisticsFrequency;
HPMFunctionVariantDecode_HPMTaskAttachedDocuments VariantDecode_HPMTaskAttachedDocuments;
HPMFunctionVariantDecode_HPMTaskVacationOptions VariantDecode_HPMTaskVacationOptions;
HPMFunctionVariantDecode_HPMTaskCommentsOptions VariantDecode_HPMTaskCommentsOptions;
HPMFunctionVariantDecode_HPMTaskLinkedTo VariantDecode_HPMTaskLinkedTo;
HPMFunctionVariantDecode_HPMTaskSprintResourceAllocation VariantDecode_HPMTaskSprintResourceAllocation;
HPMFunctionVariantDecode_HPMDataHistoryTaskCreated VariantDecode_HPMDataHistoryTaskCreated;
HPMFunctionVariantDecode_HPMDataHistoryTaskRestoredFromHistory VariantDecode_HPMDataHistoryTaskRestoredFromHistory;
HPMFunctionVariantDecode_HPMDataHistoryTaskMoved VariantDecode_HPMDataHistoryTaskMoved;
HPMFunctionVariantDecode_HPMDataHistoryTaskRenameCustomColumn VariantDecode_HPMDataHistoryTaskRenameCustomColumn;
HPMFunctionVariantDecode_HPMDataHistoryTaskProxyCreated VariantDecode_HPMDataHistoryTaskProxyCreated;
HPMFunctionVariantDecode_HPMDataHistoryTaskProxyDeleted VariantDecode_HPMDataHistoryTaskProxyDeleted;
HPMFunctionVariantDecode_HPMDataHistoryTaskRenameBoardElementInfo VariantDecode_HPMDataHistoryTaskRenameBoardElementInfo;
HPMFunctionVariantDecode_HPMDataHistoryTaskBoardCardInfo VariantDecode_HPMDataHistoryTaskBoardCardInfo;
HPMFunctionVariantDecode_HPMTaskTimeZones VariantDecode_HPMTaskTimeZones;
HPMFunctionVariantDecode_HPMChatMessage VariantDecode_HPMChatMessage;
HPMFunctionVariantDecode_HPMProjectCustomColumns VariantDecode_HPMProjectCustomColumns;
HPMFunctionVariantDecode_HPMProjectCustomColumnsColumn VariantDecode_HPMProjectCustomColumnsColumn;
HPMFunctionVariantDecode_HPMProjectCustomColumnAncestry VariantDecode_HPMProjectCustomColumnAncestry;
HPMFunctionVariantDecode_HPMProjectWorkflowSettings VariantDecode_HPMProjectWorkflowSettings;
HPMFunctionVariantDecode_HPMHolidays VariantDecode_HPMHolidays;
HPMFunctionVariantDecode_HPMWorkingDays VariantDecode_HPMWorkingDays;
HPMFunctionVariantDecode_HPMCustomWorkingDays VariantDecode_HPMCustomWorkingDays;
HPMFunctionVariantDecode_HPMWorkingHours VariantDecode_HPMWorkingHours;
HPMFunctionVariantDecode_HPMCustomWorkingHours VariantDecode_HPMCustomWorkingHours;
HPMFunctionVariantDecode_HPMProjectDefaultColumns VariantDecode_HPMProjectDefaultColumns;
HPMFunctionVariantDecode_HPMUntranslatedString VariantDecode_HPMUntranslatedString;
HPMFunctionVariantDecode_HPMBinaryBuffer VariantDecode_HPMBinaryBuffer;
HPMFunctionVariantDecode_ProjectBugReportResources VariantDecode_ProjectBugReportResources;
HPMFunctionVariantDecode_HPMProjectColumnMetaData VariantDecode_HPMProjectColumnMetaData;
HPMFunctionVariantDecode_HPMProjectViewPreset VariantDecode_HPMProjectViewPreset;
HPMFunctionVariantDecode_HPMResourceDefinitionList VariantDecode_HPMResourceDefinitionList;
HPMFunctionVariantEncode_HPMResourceDefinitionList VariantEncode_HPMResourceDefinitionList;
HPMFunctionVariantEncode_HPMInt32 VariantEncode_HPMInt32;
HPMFunctionVariantEncode_HPMUInt32 VariantEncode_HPMUInt32;
HPMFunctionVariantEncode_HPMInt64 VariantEncode_HPMInt64;
HPMFunctionVariantEncode_HPMUInt64 VariantEncode_HPMUInt64;
HPMFunctionVariantEncode_HPMFP32 VariantEncode_HPMFP32;
HPMFunctionVariantEncode_HPMFP64 VariantEncode_HPMFP64;
HPMFunctionVariantEncode_HPMUniqueID VariantEncode_HPMUniqueID;
HPMFunctionVariantEncode_HPMString VariantEncode_HPMString;
HPMFunctionVariantEncode_HPMUntranslatedString VariantEncode_HPMUntranslatedString;
HPMFunctionVariantEncode_EHPMTaskStatus VariantEncode_EHPMTaskStatus;
HPMFunctionCriteriaDataDecode_HPMTaskFindCriteriaTypeText CriteriaDataDecode_HPMTaskFindCriteriaTypeText;
HPMFunctionCriteriaDataDecode_HPMTaskFindCriteriaTypeInteger CriteriaDataDecode_HPMTaskFindCriteriaTypeInteger;
HPMFunctionCriteriaDataDecode_HPMTaskFindCriteriaTypeFloat CriteriaDataDecode_HPMTaskFindCriteriaTypeFloat;
HPMFunctionCriteriaDataDecode_HPMTaskFindCriteriaTypeGeneralCondition CriteriaDataDecode_HPMTaskFindCriteriaTypeGeneralCondition;
HPMFunctionCriteriaDataDecode_HPMTaskFindCriteriaTypeDate CriteriaDataDecode_HPMTaskFindCriteriaTypeDate;
HPMFunctionCriteriaDataDecode_HPMTaskFindCriteriaTypeDroplist CriteriaDataDecode_HPMTaskFindCriteriaTypeDroplist;
HPMFunctionCriteriaDataDecode_HPMTaskFindCriteriaTypeMultiSelectDroplist CriteriaDataDecode_HPMTaskFindCriteriaTypeMultiSelectDroplist;
HPMFunctionCriteriaDataEncode_HPMTaskFindCriteriaTypeText CriteriaDataEncode_HPMTaskFindCriteriaTypeText;
HPMFunctionCriteriaDataEncode_HPMTaskFindCriteriaTypeInteger CriteriaDataEncode_HPMTaskFindCriteriaTypeInteger;
HPMFunctionCriteriaDataEncode_HPMTaskFindCriteriaTypeFloat CriteriaDataEncode_HPMTaskFindCriteriaTypeFloat;
HPMFunctionCriteriaDataEncode_HPMTaskFindCriteriaTypeGeneralCondition CriteriaDataEncode_HPMTaskFindCriteriaTypeGeneralCondition;
HPMFunctionCriteriaDataEncode_HPMTaskFindCriteriaTypeDate CriteriaDataEncode_HPMTaskFindCriteriaTypeDate;
HPMFunctionCriteriaDataEncode_HPMTaskFindCriteriaTypeDroplist CriteriaDataEncode_HPMTaskFindCriteriaTypeDroplist;
HPMFunctionCriteriaDataEncode_HPMTaskFindCriteriaTypeMultiSelectDroplist CriteriaDataEncode_HPMTaskFindCriteriaTypeMultiSelectDroplist;
HPMFunctionAuthenticationClientPluginRegister AuthenticationClientPluginRegister;
HPMFunctionAuthenticationClientPluginUnregister AuthenticationClientPluginUnregister;
HPMFunctionAuthenticationClientProtocolEnded AuthenticationClientProtocolEnded;
HPMFunctionAuthenticationIntegrationProtocolEnded AuthenticationIntegrationProtocolEnded;
HPMFunctionAuthenticationResolveCredentials AuthenticationResolveCredentials;
HPMFunctionAuthenticationResolveCredentialsEnded AuthenticationResolveCredentialsEnded;
HPMFunctionDashboardPageEnum DashboardPageEnum;
HPMFunctionDashboardPageGetName DashboardPageGetName;
HPMFunctionDashboardPageSetName DashboardPageSetName;
HPMFunctionDashboardPageGetTheme DashboardPageGetTheme;
HPMFunctionDashboardPageSetTheme DashboardPageSetTheme;
HPMFunctionDashboardThemeEnum DashboardThemeEnum;
HPMFunctionDashboardPageGetSharedToWithViewingRights DashboardPageGetSharedToWithViewingRights;
HPMFunctionDashboardPageSetSharedToWithViewingRights DashboardPageSetSharedToWithViewingRights;
HPMFunctionDashboardPageGetSharedToWithEditingRights DashboardPageGetSharedToWithEditingRights;
HPMFunctionDashboardPageSetSharedToWithEditingRights DashboardPageSetSharedToWithEditingRights;
HPMFunctionDashboardPageDelete DashboardPageDelete;
HPMFunctionDashboardPageCreate DashboardPageCreate;
HPMFunctionDashboardPageIsPersonal DashboardPageIsPersonal;
HPMFunctionDashboardPageGetCreatedBy DashboardPageGetCreatedBy;
HPMFunctionDashboardPageGetLayout DashboardPageGetLayout;
HPMFunctionDashboardPageSetLayout DashboardPageSetLayout;
HPMFunctionDashboardChartEnum DashboardChartEnum;
HPMFunctionDashboardChartCreate DashboardChartCreate;
HPMFunctionDashboardChartDelete DashboardChartDelete;
HPMFunctionDashboardChartSetName DashboardChartSetName;
HPMFunctionDashboardChartSetPresentationConfig DashboardChartSetPresentationConfig;
HPMFunctionDashboardChartSetComputationConfig DashboardChartSetComputationConfig;
HPMFunctionDashboardChartGetName DashboardChartGetName;
HPMFunctionDashboardChartGetPageID DashboardChartGetPageID;
HPMFunctionDashboardChartGetComputationConfig DashboardChartGetComputationConfig;
HPMFunctionDashboardChartGetPresentationConfig DashboardChartGetPresentationConfig;
HPMFunctionDashboardChartGetHistoricComputationConfigs DashboardChartGetHistoricComputationConfigs;
HPMFunctionDashboardChartGetLastSampledHistoricComputationConfig DashboardChartGetLastSampledHistoricComputationConfig;
HPMFunctionDashboardUtilGetMeasureAutoName DashboardUtilGetMeasureAutoName;
HPMFunctionDashboardUtilGetFilterAutoName DashboardUtilGetFilterAutoName;
HPMFunctionDashboardUtilColumnCanBeUsedForDimension DashboardUtilColumnCanBeUsedForDimension;
HPMFunctionDashboardUtilIsDimensionValidForResource DashboardUtilIsDimensionValidForResource;
HPMFunctionDashboardUtilIsMeasureValidForResource DashboardUtilIsMeasureValidForResource;
HPMFunctionDashboardUtilIsFilterValidForResource DashboardUtilIsFilterValidForResource;
HPMFunctionDashboardUtilIsComputationConfigValidForResource DashboardUtilIsComputationConfigValidForResource;
HPMFunctionDashboardSubscribeToChart DashboardSubscribeToChart;
HPMFunctionDashboardSubscriptionGetLastResultSetAsString DashboardSubscriptionGetLastResultSetAsString;
HPMFunctionDashboardSubscriptionGetLastResultSet DashboardSubscriptionGetLastResultSet;
HPMFunctionUtilGetColumnHash UtilGetColumnHash;
HPMFunctionUtilIsIDValid UtilIsIDValid;
HPMFunctionUtilIsIDTask UtilIsIDTask;
HPMFunctionUtilIsIDTaskRef UtilIsIDTaskRef;
HPMFunctionUtilIsIDProject UtilIsIDProject;
HPMFunctionUtilIsIDBacklogProject UtilIsIDBacklogProject;
HPMFunctionUtilIsIDQAProject UtilIsIDQAProject;
HPMFunctionUtilIsIDResource UtilIsIDResource;
HPMFunctionUtilDecodeCustomChoiceValue UtilDecodeCustomChoiceValue;
HPMFunctionUtilDecodeCustomColumnResourcesValue UtilDecodeCustomColumnResourcesValue;
HPMFunctionUtilEncodeCustomColumnResourcesValue UtilEncodeCustomColumnResourcesValue;
HPMFunctionUtilDecodeCustomColumnDateTimeValue UtilDecodeCustomColumnDateTimeValue;
HPMFunctionUtilEncodeCustomColumnDateTimeValue UtilEncodeCustomColumnDateTimeValue;
HPMFunctionUtilDecodeCustomColumnCalculatedValue UtilDecodeCustomColumnCalculatedValue;
HPMFunctionUtilGetRealProjectIDFromProjectID UtilGetRealProjectIDFromProjectID;
HPMFunctionUtilGetLastErrorDescription UtilGetLastErrorDescription;
HPMFunctionUtilGetHelixPlanURL UtilGetHelixPlanURL;
HPMFunctionUtilGetTaskInfoFromHelixPlanURL UtilGetTaskInfoFromHelixPlanURL;
HPMFunctionUtilGetFindCriteriaDataTypeFromData UtilGetFindCriteriaDataTypeFromData;
HPMFunctionUtilGetFindCriteriaDataTypeFromColumn UtilGetFindCriteriaDataTypeFromColumn;
HPMFunctionUtilConvertFindStringToReport UtilConvertFindStringToReport;
HPMFunctionUtilConvertReportToFindString UtilConvertReportToFindString;
HPMFunctionUtilGetColumnName UtilGetColumnName;
HPMFunctionUtilGetColumnDescription UtilGetColumnDescription;
HPMFunctionUtilColumnToTaskField UtilColumnToTaskField;
HPMFunctionUtilTaskFieldToColumn UtilTaskFieldToColumn;
HPMFunctionUtilGetColumnDataItemFormatted UtilGetColumnDataItemFormatted;
HPMFunctionUtilIsColumnReadOnly UtilIsColumnReadOnly;
HPMFunctionUtilGetColumnData UtilGetColumnData;
HPMFunctionLocalizationGetLanguages LocalizationGetLanguages;
HPMFunctionLocalizationGetLanguageName LocalizationGetLanguageName;
HPMFunctionUtilGetWorkflowObjectName UtilGetWorkflowObjectName;
HPMFunctionUtilGetWorkflowObjectIDFromName UtilGetWorkflowObjectIDFromName;
HPMFunctionUtilGetWorkflowName UtilGetWorkflowName;
HPMFunctionUtilGetWorkflowIDFromName UtilGetWorkflowIDFromName;
HPMFunctionUtilGetWorkflowType UtilGetWorkflowType;
HPMFunctionUtilGetWorkflowContainerFlags UtilGetWorkflowContainerFlags;
HPMFunctionUtilTaskCommentExists UtilTaskCommentExists;
HPMFunctionUtilGlobalReportExists UtilGlobalReportExists;
HPMFunctionUtilProjectReportExists UtilProjectReportExists;
HPMFunctionUtilWorkflowObjectExists UtilWorkflowObjectExists;
HPMFunctionUtilWorkflowExists UtilWorkflowExists;
HPMFunctionDebugCheckHeap DebugCheckHeap;
HPMFunctionLocalizationTranslateString LocalizationTranslateString;
HPMFunctionLocalizationGetDefaultLanguage LocalizationGetDefaultLanguage;
HPMFunctionLocalizationCreateUntranslatedStringFromString LocalizationCreateUntranslatedStringFromString;
HPMFunctionLocalizationCreateUntranslatedStringFromTranslationID LocalizationCreateUntranslatedStringFromTranslationID;
HPMFunctionLocalizationGetTranslationIDFromFullTranslationID LocalizationGetTranslationIDFromFullTranslationID;
HPMFunctionTaskBoardConvertSprintToBoard TaskBoardConvertSprintToBoard;
HPMFunctionTaskGetSprintIsBoard TaskGetSprintIsBoard;
HPMFunctionTaskBoardGetCardAttributeColumns TaskBoardGetCardAttributeColumns;
HPMFunctionTaskBoardGetColumnToStatusMapping TaskBoardGetColumnToStatusMapping;
HPMFunctionTaskBoardLaneEnum TaskBoardLaneEnum;
HPMFunctionTaskBoardLaneColumnEnum TaskBoardLaneColumnEnum;
HPMFunctionTaskBoardElementGetBoard TaskBoardElementGetBoard;
HPMFunctionTaskBoardElementGetName TaskBoardElementGetName;
HPMFunctionTaskBoardElementGetType TaskBoardElementGetType;
HPMFunctionTaskBoardColumnGetParentLane TaskBoardColumnGetParentLane;
HPMFunctionTaskBoardElementGetPosition TaskBoardElementGetPosition;
HPMFunctionTaskBoardUpdateAttributes TaskBoardUpdateAttributes;
HPMFunctionTaskBoardMapColumnToStatus TaskBoardMapColumnToStatus;
HPMFunctionTaskBoardCreateLane TaskBoardCreateLane;
HPMFunctionTaskBoardCreateColumn TaskBoardCreateColumn;
HPMFunctionTaskBoardUpdateElement TaskBoardUpdateElement;
HPMFunctionTaskBoardDeleteElement TaskBoardDeleteElement;
HPMFunctionTaskBoardGetMembershipInfo TaskBoardGetMembershipInfo;
HPMFunctionTaskBoardMove TaskBoardMove;
HPMFunctionTaskBoardHide TaskBoardHide;
HPMFunctionTaskBoardUnhide TaskBoardUnhide;
HPMFunctionTaskBoardElementGetCardLimit TaskBoardElementGetCardLimit;
HPMFunctionTaskBoardElementSetCardLimit TaskBoardElementSetCardLimit;
HPMFunctionSessionLock SessionLock;
HPMFunctionSessionReadLock SessionReadLock;
HPMFunctionSessionReadLockHeld SessionReadLockHeld;
HPMFunctionTaskCheckWorkflowTransitionRequirements TaskCheckWorkflowTransitionRequirements;
HPMFunctionDebugSetFlags DebugSetFlags;
HPMFunctionProjectGetMilestones ProjectGetMilestones;
HPMFunctionProjectGetSprints ProjectGetSprints;
HPMFunctionVersionControlUtilResourceHasRights VersionControlUtilResourceHasRights;
HPMFunctionTaskRefUtilHasLimitedVisibility TaskRefUtilHasLimitedVisibility;
HPMFunctionTaskRefUtilIsDelegatedTo TaskRefUtilIsDelegatedTo;
HPMFunctionTaskLinkToMilestones TaskLinkToMilestones;
HPMFunctionUtilGetNoMilestoneID UtilGetNoMilestoneID;
HPMFunctionVersionControlUtilFileIDToFileInfo VersionControlUtilFileIDToFileInfo;
HPMFunctionTaskGetLastUpdatedByResourceName TaskGetLastUpdatedByResourceName;
HPMFunctionGlobalGetWebServiceHostname GlobalGetWebServiceHostname;
HPMFunctionDebugFlushWatchNotifications DebugFlushWatchNotifications;
HPMFunctionSessionTryLock SessionTryLock;
HPMFunctionSessionDidTryLockSucceed SessionDidTryLockSucceed;
HPMFunctionProjectGetColumnResourcePermissionRules ProjectGetColumnResourcePermissionRules;
HPMFunctionProjectSetColumnResourcePermissionRules ProjectSetColumnResourcePermissionRules;
HPMFunctionGlobalGetSecurityPolicy GlobalGetSecurityPolicy;
HPMFunctionProjectGetName ProjectGetName;
HPMFunctionProjectGetSortName ProjectGetSortName;
HPMFunctionProjectGetNiceName ProjectGetNiceName;
HPMFunctionProjectGetProjectMethod ProjectGetProjectMethod;
HPMFunctionProjectGetDefaultEditorMode ProjectGetDefaultEditorMode;
HPMFunctionProjectGetAgileTemplate ProjectGetAgileTemplate;
HPMFunctionResourceGroupGetSortNameFromResourceGroup ResourceGroupGetSortNameFromResourceGroup;
HPMFunctionResourceGroupGetProjectFromResourceGroup ResourceGroupGetProjectFromResourceGroup;
HPMFunctionResourceGetSortNameFromResource ResourceGetSortNameFromResource;
HPMFunctionResourceUtilResourceIsDeleted ResourceUtilResourceIsDeleted;
HPMFunctionResourceUtilResourceIsLocked ResourceUtilResourceIsLocked;
HPMFunctionResourceGetEmailFromResource ResourceGetEmailFromResource;
HPMFunctionResourceUtilResourceIsActiveAccount ResourceUtilResourceIsActiveAccount;
HPMFunctionResourceUtilResourceHasAdminAccess ResourceUtilResourceHasAdminAccess;
HPMFunctionResourceUtilResourceHasResourceAllocationAccess ResourceUtilResourceHasResourceAllocationAccess;
HPMFunctionResourceUtilResourceHasDocumentManagementAccess ResourceUtilResourceHasDocumentManagementAccess;
HPMFunctionResourceUtilResourceIsAuthenticationProvider ResourceUtilResourceIsAuthenticationProvider;
HPMFunctionResourceUtilResourceIsCredentialCheckProvider ResourceUtilResourceIsCredentialCheckProvider;
HPMFunctionResourceUtilResourceHasAvatarManagementAccess ResourceUtilResourceHasAvatarManagementAccess;
HPMFunctionResourceUtilResourceIsSdkChatUser ResourceUtilResourceIsSdkChatUser;
HPMFunctionResourceUtilResourceHasChatAccess ResourceUtilResourceHasChatAccess;
HPMFunctionResourceUtilResourceHasDashboardAccess ResourceUtilResourceHasDashboardAccess;
HPMFunctionResourceUtilResourceCanShareDashboardPages ResourceUtilResourceCanShareDashboardPages;
HPMFunctionResourceUtilSdkResourceGetSyncMethod ResourceUtilSdkResourceGetSyncMethod;
HPMFunctionGlobalGetSecurityOptions GlobalGetSecurityOptions;
HPMFunctionAuthenticationResolveCredentialsHelixAuth AuthenticationResolveCredentialsHelixAuth;
HPMFunctionUtilGetCustomColumnName UtilGetCustomColumnName;
HPMFunctionUtilGetCustomColumnType UtilGetCustomColumnType;
HPMFunctionSessionOpenVirtualImpersonated SessionOpenVirtualImpersonated;
HPMFunctionUtilNormaliseCustomSettings UtilNormaliseCustomSettings;
HPMFunctionProjectUtilGetCustomColumnIsHidden ProjectUtilGetCustomColumnIsHidden;
HPMFunctionTaskRefReportFind TaskRefReportFind;
HPMFunctionUtilGetReport UtilGetReport;
HPMFunctionProjectGetCustomName ProjectGetCustomName;
HPMFunctionProjectUtilCustomColumnExistInProject ProjectUtilCustomColumnExistInProject;
} HPMSdkFunctions;
Members
m_hDll
For internal use only. Points to a DLL handle when the SDK is initialized
SessionOpen
Opens a session. See SessionOpen.
SessionStop
Stops a session. See SessionStop.
SessionClose
Closes a session. See SessionOpen.
SessionProcess
Performs processing such as callbacks on the session. See SessionProcess.
SessionGetInfo
Gets the information about a session. See SessionGetInfo.
RegisterChangeCallback
Registers a change callback on a session. See RegisterChangeCallback.
UnregisterChangeCallback
Unregisters a change callback on a session. See UnregisterChangeCallback.
ObjectFree
Frees an object returned by an interface function. See ObjectFree.
ObjectAddRef
Adds a reference to an object returned by an interface function. See ObjectAddRef.
ObjectGetRef
Get the reference count of an object returned by an interface function. See ObjectGetRef.
ObjectCompare
Compares two objects returned by interface functions. See ObjectCompare.
MemoryFree
Frees external allocated memory. See MemoryFree.
SessionOpenVirtual
Opens a virtual SDK session. See SessionOpenVirtual.
SessionSetConnectionLostTimeout
Sets the connection lost timeout value. See SessionSetConnectionLostTimeout.
SessionGetDisconnectReason
Gets a more detailed disconnect reason after a EHPMError_ConnectionLost. See SessionGetDisconnectReason.
GlobalSetStatisticsSettings
Sets statistics settings for global statistics. See GlobalSetStatisticsSettings.
GlobalGetStatisticsSettings
Gets statistics settings for global statistics. See GlobalGetStatisticsSettings.
GlobalSetServerInternetName
Sets the server internet name. See GlobalSetServerInternetName.
GlobalGetServerInternetName
Gets the server internet name. See GlobalGetServerInternetName.
GlobalGetDatabaseGUIDs
Gets the database guids. See GlobalGetDatabaseGUIDs.
GlobalRegisterCustomSettings
Registers custom settings. See GlobalRegisterCustomSettings.
GlobalUnregisterCustomSettings
Unregisters custom settings. See GlobalUnregisterCustomSettings.
GlobalGetCustomSettingsIdentifierHash
Gets the identifier hash for a custom settings identifier. See GlobalGetCustomSettingsIdentifierHash.
GlobalGetRegisteredCustomSettings
Gets registered custom settings. See GlobalGetRegisteredCustomSettings.
GlobalGetCustomSettingsValue
Gets the value of a global custom setting. See GlobalGetCustomSettingsValue.
GlobalSetCustomSettingsValue
Sets the value of a global custom setting. See GlobalSetCustomSettingsValue.
GlobalRegisterForDynamicCustomSettingsNotifications
Registers for custom settings notifications in client dll. See GlobalRegisterForDynamicCustomSettingsNotifications.
GlobalRegisterForRightClickNotifications
Registers for right click notifications in client dll. See GlobalRegisterForRightClickNotifications.
GlobalAddRightClickMenuItem
Adds a right click menu item. See GlobalAddRightClickMenuItem.
GlobalDisplayCustomSettingsDialog
Displays a custom settings dialog in client. See GlobalDisplayCustomSettingsDialog.
GlobalCancelCustomSettingsDialog
Cancels a custom settings dialog in client. See GlobalCancelCustomSettingsDialog.
GlobalRegisterForCustomTaskStatusNotifications
Registers for task status notifications in client dll. See GlobalRegisterForCustomTaskStatusNotifications.
GlobalDisplayCustomTaskStatusDialog
Displays a custom task status dialog in client. See GlobalDisplayCustomTaskStatusDialog.
GlobalCancelCustomTaskStatusDialog
Cancels a custom task status dialog in client. See GlobalCancelCustomTaskStatusDialog.
GlobalAddTasksCustomTaskStatusDialog
Add tasks to a custom task status dialog in client. See GlobalAddTasksCustomTaskStatusDialog.
GlobalRequestDynamicCustomSettingsValues
Requests dynamic custom settings values. See GlobalRequestDynamicCustomSettingsValues.
GlobalSetDynamicCustomSettingsValues
Sets dynamic custom settings values. See GlobalSetDynamicCustomSettingsValues.
GlobalGetSDKInternalDataIdentifierHash
Get the identifier hash for a SDK internal data identifier. See GlobalGetSDKInternalDataIdentifierHash.
GlobalGetSDKInternalData
Gets global SDK internal data. See GlobalGetSDKInternalData.
GlobalSetSDKInternalData
Sets global SDK internal data. See GlobalSetSDKInternalData.
GlobalWorkflowsRemoveDeleted
Removes all workflows in all projects that have been deleted.
GlobalGetReport
Gets global report for report id. See GlobalGetReport.
GlobalGetReports
Gets global reports. See GlobalGetReports.
GlobalSetReports
Sets global reports. See GlobalSetReports.
GlobalSetDocumentAttachmentLimit
Sets file size limit for attached files. See GlobalSetDocumentAttachmentLimit.
GlobalGetDocumentAttachmentLimit
Gets file size limit for attached files. See GlobalGetDocumentAttachmentLimit.
GlobalSetDisallowedFileTypes
Sets disallowed file types for attached files. See GlobalSetDisallowedFileTypes.
GlobalGetDisallowedFileTypes
Gets disallowed file types for attached files. See GlobalGetDisallowedFileTypes.
GlobalSetCommentThumbnailDimensionInPixels
Sets the comment thumbnail max size. See GlobalSetCommentThumbnailDimensionInPixels.
GlobalGetCommentThumbnailDimensionInPixels
Gets the comment thumbnail max size. See GlobalGetCommentThumbnailDimensionInPixels.
GlobalGetChatMessageLastID
Gets the last chat message id in a chat room. See GlobalGetChatMessageLastID.
GlobalSetTimesheetConfig
Sets configuration of timesheets. See GlobalSetTimesheetConfig.
GlobalGetTimesheetConfig
Gets configuration of timesheets. See GlobalGetTimesheetConfig.
GlobalSetEmailSettings
Sets global email settings. See GlobalSetEmailSettings.
GlobalGetEmailSettings
Gets global email settings. See GlobalGetEmailSettings.
GlobalSetDocumentAttachmentCommentRequired
Sets the attachment comment required policy. See GlobalSetDocumentAttachmentCommentRequired.
GlobalGetDocumentAttachmentCommentRequired
Gets the attachment comment required policy. See GlobalGetDocumentAttachmentCommentRequired.
ResourceCreate
Creates a resource. See ResourceCreate.
ResourceDelete
Deletes a resource. See ResourceDelete.
ResourceImpersonate
Impersonates a resource. See ResourceImpersonate.
ResourceEnum
Enumerates resources in a database. See ResourceEnum.
ResourceGetProperties
Gets properties of a resource. See ResourceGetProperties.
ResourceSetProperties
Sets properties of a resource. See ResourceSetProperties.
ResourceGetGlobalSettings
Gets global settings for a resource. See ResourceGetGlobalSettings.
ResourceSetGlobalSettings
Sets global settings for a resource. See ResourceSetGlobalSettings.
ResourceGetCustomSettingsValue
Gets the value of a resource custom setting. See ResourceGetCustomSettingsValue.
ResourceSetCustomSettingsValue
Sets the value of a resource custom setting. See ResourceSetCustomSettingsValue.
ResourceGetSDKInternalData
Gets resource SDK internal data. See ResourceGetSDKInternalData.
ResourceSetSDKInternalData
Sets resource SDK internal data. See ResourceSetSDKInternalData.
ResourceGroupCreate
Creates a resource group. See ResourceGroupCreate.
ResourceGroupDelete
Deletes a resource group. See ResourceGroupDelete.
ResourceGroupEnum
Enumerates resource groups. See ResourceGroupEnum.
ResourceGroupGetProperties
Gets properties of a resource group. See ResourceGroupGetProperties.
ResourceGroupSetProperties
Sets properties of a resource group. See ResourceGroupSetProperties.
ResourceGroupNewCreate
Creates a resource group with resources. See ResourceGroupNewCreate.
ResourceGroupNewEdit
Creates a resource group with resources. See ResourceGroupNewEdit.
ResourceGroupNewDelete
Creates a resource group with resources. See ResourceGroupNewDelete.
ResourceGroupGetNextID
Gets next unique number, that could be used as ID of new group. See ResourceGroupGetNextID
ResourceGetLoggedIn
Gets the currently logged in resource. See ResourceGetLoggedIn.
ResourceGroupGetResources
Gets resources that are members of a resource group. See ResourceGroupGetResources.
ResourceGetResourceFromName
Gets a resource from a name. See ResourceGetResourceFromName.
ResourceGetNameFromResource
Gets a name from a resource. See ResourceGetNameFromResource.
ResourceGroupGetNameFromResourceGroup
Gets a name from a resource group. See ResourceGroupGetNameFromResourceGroup.
ResourceGroupUtilResourceGroupExists
Checks if an identifier is a resource group. See ResourceGroupUtilResourceGroupExists.
ResourceGetImpersonate
Gets the currently impersonated resource. See ResourceGetImpersonate.
ResourceGetLockFlags
Gets the lock flags for a resource. See ResourceGetLockFlags.
ResourceChangeLockFlags
Changes the lock flags for a resource. See ResourceChangeLockFlags.
ResourceSetPreferredLanguage
Sets the preferred language of a resource. See ResourceSetPreferredLanguage.
ResourceGetPreferredLanguage
Gets the preferred language of a resource. See ResourceGetPreferredLanguage.
ResourceSetLastUsedLanguage
Sets the last used language of a resource. See ResourceSetLastUsedLanguage.
ResourceGetLastUsedLanguage
Gets the last used language of a resource. See ResourceGetLastUsedLanguage.
ResourceGetEffectiveLanguage
Gets the effective language of a resource. See ResourceGetEffectiveLanguage.
ResourceTimesheetPeriodDataDelete
Deletes timesheet period data for a resource. See ResourceTimesheetPeriodDataDelete.
ResourceUtilExpandResources
Expands a resources list into a list of resources. See ResourceUtilExpandResources.
ResourceSetChatOnlineStatus
Sets the chat online status for the currently logged in SDK resource. See ResourceSetChatOnlineStatus.
ResourceGetChatOnlineStatus
Gets the chat online status for a resource. See ResourceGetChatOnlineStatus.
ResourceSetDoNotDisturb
Sets the do not disturb flag for a resource. See ResourceSetDoNotDisturb.
ResourceGetDoNotDisturb
Gets the do not disturb flag for a resource. See ResourceGetDoNotDisturb.
ResourceSendChatMessage
Sets/submits a chat message for a resource. See ResourceSendChatMessage.
ResourceSetLastReadChatID
Sets the last read chat message id for a resource. See ResourceSetLastReadChatID.
ResourceGetLastReadChatID
Gets the last read chat message id for a resource. See ResourceGetLastReadChatID.
ResourceUploadAvatar
Uploads an avatar image for a resource. See ResourceUploadAvatar.
ResourceGetTimesheetDay
Gets a timesheet report day for a resource. See ResourceGetTimesheetDay.
ResourceGetDashboardPage
Gets the personal dashboard page for a resource. See ResourceGetDashboardPage.
ResourceReplaceGuestResourceWithHomeResource
Reploce remote guest share user with local user. See ResourceReplaceGuestResourceWithHomeResource.
ResourceMakeGuestResourceAHomeResource
Make remote guest share user a local user. See ResourceMakeGuestResourceAHomeResource.
TimesheetRowSetActivityID
Sets the activity id for a timesheet row. See TimesheetRowSetActivityID.
TimesheetRowSetProjectID
Sets the project id for a timesheet row. See TimesheetRowSetProjectID.
TimesheetRowSetTaskID
Sets the task id for a timesheet row. See TimesheetRowSetTaskID.
TimesheetRowSetStartedTime
Sets the started time for a timesheet row. See TimesheetRowSetStartedTime.
TimesheetRowSetDurationTime
Sets the duration time for a timesheet row. See TimesheetRowSetDurationTime.
TimesheetRowSetComment
Sets the comment for a timesheet row. See TimesheetRowSetComment.
TimesheetRowDelete
Deletes a timesheet row. See TimesheetRowDelete.
TimesheetGetDateRange
Gets a timesheet report for a date range. See TimesheetGetDateRange.
TimesheetCreateTaskTimeSpentRow
Creates new timesheet row for task for specific user and date.
ProjectCreate
Creates a project. See ProjectCreate.
ProjectClone
Clone a project. See ProjectClone.
ProjectDelete
Deletes a project. See ProjectDelete.
ProjectEnum
Enumerates projects in database. See ProjectEnum.
ProjectEnumNonArchived
Enumerates projects that are not archived in database. See ProjectEnumNonArchived.
ProjectGetProperties
Gets properties of a project. See ProjectGetProperties.
ProjectSetProperties
Sets properties of a project. See ProjectSetProperties.
ProjectGetSettings
Gets settings of a project. See ProjectGetSettings.
ProjectSetSettings
Sets settings of a project. See ProjectSetSettings.
ProjectGetEmailSettings
Gets email settings of a project. See ProjectGetEmailSettings.
ProjectSetEmailSettings
Sets email settings of a project. See ProjectSetEmailSettings.
ProjectGetHistoryAutoSaveSettings
Gets project history auto save settings of a project. See ProjectGetHistoryAutoSaveSettings.
ProjectSetHistoryAutoSaveSettings
Sets project history auto save settings of a project. See ProjectSetHistoryAutoSaveSettings.
ProjectGetCompletionStyle
Gets the project completion style. See ProjectGetCompletionStyle.
ProjectWorkflowEnum
Enumerates workflows in a project. See ProjectWorkflowEnum.
ProjectWorkflowEnumWorkflow
Enumerates workflows of a workflow in a project. See ProjectWorkflowEnumWorkflow.
ProjectWorkflowEnumObject
Enumerates workflow objects of a workflow in a project See ProjectWorkflowEnumObject.
ProjectWorkflowCreate
Creates a new workflow in a project. See ProjectWorkflowCreate.
ProjectWorkflowDelete
Deletes a workflow in a project. See ProjectWorkflowDelete.
ProjectWorkflowGetObject
Gets the a work flow object. See ProjectWorkflowGetObject.
ProjectWorkflowGetSettings
Gets the work flow settings for a project. See ProjectWorkflowGetSettings.
ProjectWorkflowSetSettings
Sets the work flow settings for a project. See ProjectWorkflowSetSettings.
ProjectWorkflowSetLatestVersion
Sets the latest version of a workflow in a project. See ProjectWorkflowSetLatestVersion.
ProjectWorkflowGetNewestVersion
Sets the newest workflow id of a workflow in a project. See ProjectWorkflowGetNewestVersion.
ProjectGetStatisticsSettings
Gets the statistics settings for a project. See ProjectGetStatisticsSettings.
ProjectSetStatisticsSettings
Sets the statistics settings for a project. See ProjectSetStatisticsSettings.
ProjectGetWallSettings
Gets wall settings of a project. See ProjectGetWallSettings.
ProjectSetWallSettings
Sets wall settings of a project. See ProjectSetWallSettings.
ProjectGetWallGroups
Gets wall groups of a project. See ProjectGetWallGroups.
ProjectSetWallGroups
Sets wall groups of a project. See ProjectSetWallGroups.
ProjectGetDetailedAccessRules
Gets detailed access rules of a project. See ProjectGetDetailedAccessRules.
ProjectSetDetailedAccessRules
Sets detailed access rules of a project. See ProjectSetDetailedAccessRules.
ProjectGetReport
Gets report for a report id in a project. See ProjectGetReport
ProjectGetReports
Gets reports for a project. See ProjectGetReports.
ProjectSetReports
Sets reports for a project. See ProjectSetReports.
ProjectEnumReportResources
Enumerates resources that have created reports. See ProjectEnumReportResources.
ProjectGetCustomStatisticsSettings
Gets custom statistics settings of a project. See ProjectGetCustomStatisticsSettings.
ProjectSetCustomStatisticsSettings
Sets custom statistics settings of a project. See ProjectSetCustomStatisticsSettings.
ProjectGetWorkflowStatusStats
Gets workflow status statistics for a bug status in a project. See ProjectGetWorkflowStatusStats
ProjectUtilGetWorkflowProgression
Generates list of possible progression states. See ProjectUtilGetWorkflowProgression
ProjectCustomColumnsGet
Gets custom columns in a project. See ProjectCustomColumnsGet.
ProjectCustomColumnsSet
Sets custom columns in a project. See ProjectCustomColumnsSet.
ProjectGetDefaultActivatedColumns
Gets activated default columns in project. See ProjectGetDefaultActivatedColumns.
ProjectSetDefaultActivatedColumns
Sets activated default columns in project. See ProjectSetDefaultActivatedColumns.
ProjectGetCustomSettingsValue
Gets the value of a project custom setting. See ProjectGetCustomSettingsValue.
ProjectSetCustomSettingsValue
Sets the value of a project custom setting. See ProjectSetCustomSettingsValue.
ProjectGetSDKInternalData
Gets project SDK internal data. See ProjectGetSDKInternalData.
ProjectSetSDKInternalData
Sets project SDK internal data. See ProjectSetSDKInternalData.
ProjectUtilGetWorkflowStructure
Gets the workflow structure for a workflow. See ProjectUtilGetWorkflowStructure.
ProjectResourceAdd
Adds a resource as a member of a project. See ProjectResourceAdd.
ProjectResourceRemove
Removes a resource from being a member of a project. See ProjectResourceRemove.
ProjectResourceEnum
Enumerates members of a project. See ProjectResourceEnum.
ProjectResourceGetProperties
Gets properties of a member in a project. See ProjectResourceGetProperties.
ProjectResourceSetProperties
Sets properties of a member in a project. See ProjectResourceEnum.
ProjectResourceGetCustomSettingsValue
Gets the value of a project resource custom setting. See ProjectResourceGetCustomSettingsValue.
ProjectResourceSetCustomSettingsValue
Sets the value of a project resource custom setting. See ProjectResourceSetCustomSettingsValue.
ProjectResourceGetParentTaskDisplayDepth
Gets the value of a project resource parent task display depth. See ProjectResourceGetParentTaskDisplayDepth.
ProjectResourceSetParentTaskDisplayDepth
Sets the value of a project resource parent task display depth. See ProjectResourceSetParentTaskDisplayDepth.
ProjectResourceGroupAdd
Adds a resource group as a member of a project. See ProjectResourceGroupAdd.
ProjectResourceGroupRemove
Removes a resource group from being a member of a project. See ProjectResourceGroupRemove.
ProjectResourceGroupEnum
Enumerates groups of a project. See ProjectResourceGroupEnum.
ProjectResourceGetSDKInternalData
Gets project resource SDK internal data. See ProjectResourceGetSDKInternalData.
ProjectResourceSetSDKInternalData
Sets project resource SDK internal data. See ProjectResourceSetSDKInternalData.
ProjectResourceUtilIsMember
Checks if a resource is member of a project. See ProjectResourceUtilIsMember.
ProjectViewPresetApply
Applies a view preset for a user in a project. See ProjectViewPresetApply.
ProjectUtilGetBacklog
Gets the unique identifier of the backlog project of a project. See ProjectUtilGetBacklog.
ProjectUtilGetQA
Gets the unique identifier of the QA project of a project. See ProjectUtilGetQA.
ProjectUtilIsArchived
Checks if a project is archived. See ProjectUtilIsArchived.
ProjectGetAgilePriorityCustomColumn
Gets the agile priority of a task. See ProjectGetAgilePriorityCustomColumn.
ProjectSetAgilePriorityCustomColumn
Sets the agile priority of a task. See ProjectSetAgilePriorityCustomColumn.
ProjectGetCustomColumn
Gets a custom column. See ProjectGetCustomColumn.
ProjectGetOldCustomColumn
Gets a custom column for a hash value of an old project column. See ProjectGetOldCustomColumn.
ProjectGetCustomColumnAncestry
Gets a ancestry for a custom column. See ProjectGetCustomColumnAncestry.
ProjectGetDefaultActivatedNonHidableColumns
Gets the default activated columns in a project. See ProjectGetDefaultActivatedNonHidableColumns.
ProjectGetDefaultAvailableColumns
Gets all available default columns in a project. See ProjectGetDefaultAvailableColumns.
ProjectCalendarGetWorkingDays
Gets the calendar working days in a project. See ProjectCalendarGetWorkingDays.
ProjectCalendarSetWorkingDays
Sets the calendar working days in a project. See ProjectCalendarSetWorkingDays.
ProjectCalendarGetCustomWorkingDays
Gets the calendar custom working days for specific days in a project. See ProjectCalendarGetCustomWorkingDays.
ProjectCalendarSetCustomWorkingDays
Sets the calendar custom working days for specific days in a project. See ProjectCalendarSetCustomWorkingDays.
ProjectCalendarGetWorkingHours
Gets the calendar working hours for a project. See ProjectCalendarGetWorkingHours.
ProjectCalendarSetWorkingHours
Sets the calendar working hours for a project. See ProjectCalendarSetWorkingHours.
ProjectCalendarGetCustomWorkingHours
Gets the calendar custom working hours for specific days in a project. See ProjectCalendarGetCustomWorkingHours.
ProjectCalendarSetCustomWorkingHours
Sets the calendar working hours for specific days in a project. See ProjectCalendarSetCustomWorkingHours.
ProjectCalendarGetHolidays
Gets the calendar holidays in a project. See ProjectCalendarGetHolidays.
ProjectCalendarSetHolidays
Sets the calendar holidays in a project. See ProjectCalendarSetHolidays.
ProjectGetCalendarDayInfo
Gets calendar info for a day in a project. See ProjectGetCalendarDayInfo.
ProjectGetViewPresets
Gets view presets for a project. See ProjectGetViewPresets.
ProjectSetTimesheetLock
Sets the timesheet lock for a project. See ProjectSetTimesheetLock.
ProjectGetTimesheetLock
Gets the timesheet lock for a project. See ProjectGetTimesheetLock.
ProjectDisplayUserMessage
Displays a message in the client if the specified user is logged in. See ProjectDisplayUserMessage.
ProjectSetBugReportResources
Sets resources that can report bugs. See ProjectSetBugReportResources.
ProjectGetBugReportResources
Gets resources that can report bugs. See ProjectGetBugReportResources.
ProjectSetDefaultQAWorkflow
Sets the default QA workflow. See ProjectSetDefaultQAWorkflow.
ProjectGetDefaultQAWorkflow
Gets the default QA workflow. See ProjectGetDefaultQAWorkflow.
ProjectGetConvertedQAWorkflow
Gets the current id of the old QA workflow. See ProjectGetConvertedQAWorkflow.
ProjectCreateViewPreset
Creates a view preset for a project. See ProjectCreateViewPreset.
ProjectChangeViewPreset
Changes a view preset for a project. See ProjectChangeViewPreset.
ProjectDeleteViewPreset
Deletes a view preset for a project. See ProjectGetViewPresets.
ProjectGetColumnMetaData
Get meta data for a column. See ProjectGetColumnMetaData.
ProjectSetColumnMetaData
Set meta data for a column. See ProjectSetColumnMetaData.
ProjectGetFunctionColumnExpression
Get expression for a function column. See ProjectGetFunctionColumnExpression.
ProjectGetFunctionColumnExpressionError
Get expression error for a function column in a project. See ProjectGetFunctionColumnExpressionError.
ProjectGetAttachmentPath
Gets the attachment path for a project. See ProjectGetAttachmentPath.
ProjectSetOverviewText
Sets the project overview text. See ProjectSetOverviewText.
ProjectGetOverviewText
Gets the project overview text. See ProjectGetOverviewText.
ProjectExportXML
Exports project as XML. See ProjectExportXML.
ProjectUtilPrepareFunctionColumnLocalContext
Prepares local changes context for function columns. See ProjectUtilPrepareFunctionColumnLocalContext
ProjectUtilParseLocalContextFunctionColumnExpression
Parses string to expression for a function column. See ProjectUtilParseLocalContextFunctionColumnExpression
ProjectUtilApplyLocalContextFunctionColumnChanges
Apply function column changes to local changes context. See ProjectUtilApplyLocalContextFunctionColumnChanges
ProjectUtilValidateLocalContextFunctionColumnExpressionChanges
Validates function column expression changes. See ProjectUtilValidateLocalContextFunctionColumnExpressionChanges
ProjectUtilGetLocalContextFunctionColumnTokens
Gets expression for a function column from local changes. See ProjectUtilGetLocalContextFunctionColumnTokens
ProjectUtilGetLocalContextCustomColumnName
Gets column name from local changes. See ProjectUtilGetLocalContextCustomColumnName
ProjectUtilGetLocalContextFunctionColumnExpressionString
Gets expression string for tokens from local changes. See ProjectUtilGetLocalContextFunctionColumnExpressionString
ProjectUtilGetLocalContextCustomColumns
Gets all columns from local changes. See ProjectUtilGetLocalContextCustomColumns
UtilDecodeStringPosition
Gets character position from string position. See UtilDecodeStringPosition
UtilEncodeStringPosition
Gets token string position from character position in corresponding string. See UtilEncodeStringPosition
ProjectUtilCompareCustomColumns
Gets the diff between two states of HPMProjectCustomColumns represented with HPMProjectCustomColumnChanges. See ProjectUtilCompareCustomColumns
ProjectWaitUntilFunctionColumnCalculated
Blocks the thread until the column is calculated. See ProjectWaitUntilFunctionColumnCalculated.
TaskCreateUnified
Creates tasks and proxies in a container. See TaskCreateUnified.
TaskMoveProject
Moves tasks into a new container. See TaskMoveProject.
TaskDelete
Deletes a task in a container. See TaskDelete.
TaskEnum
Enumerates tasks in a container. See TaskEnum.
TaskEnumConnections
Enumerates connected tasks in a container. See TaskEnumConnections.
TaskEnumReferences
Enumerates the references to a task. See TaskEnumReferences.
TaskChangeDisposition
Changes the disposition of tasks in a container. See TaskChangeDisposition.
TaskGetMainReference
Gets the main reference for a task. See TaskGetMainReference.
TaskGetProxy
Gets the proxy reference for a task. See TaskGetProxy.
TaskGetContainer
Get the parent container of a task. See TaskGetContainer.
TaskEnumCustomColumnData
Enumerates custom column data of a task. See TaskEnumCustomColumnData.
TaskEnumComments
Enumerates comments of a task. See TaskEnumComments.
TaskSetBacklogCategory
Sets the backlog category of a task. See TaskSetBacklogCategory.
TaskGetBacklogCategory
Gets the backlog category of a task. See TaskGetBacklogCategory.
TaskSetColor
Sets the color of a task. See TaskSetColor.
TaskGetColor
Gets the color of a task. See TaskGetColor.
TaskSetWallItemColor
Sets the wall item color of a task. See TaskSetWallItemColor.
TaskGetWallItemColor
Gets the wall item color of a task. See TaskGetWallItemColor.
TaskSetComplexityPoints
Sets complexity points of a task. See TaskSetComplexityPoints.
TaskGetComplexityPoints
Gets complexity points of a task. See TaskGetComplexityPoints.
TaskSetConfidence
Sets the confidence of a task. See TaskSetConfidence.
TaskGetConfidence
Gets the confidence of a task. See TaskGetConfidence.
TaskSetEstimatedIdealDays
Sets the estimated ideal days of a task. See TaskSetEstimatedIdealDays.
TaskGetEstimatedIdealDays
Gets the estimated ideal days of a task. See TaskGetEstimatedIdealDays.
TaskSetRisk
Sets the risk of a task. See TaskSetRisk.
TaskGetRisk
Gets the risk of a task. See TaskGetRisk.
TaskSetStartOffset
Sets the start offset of a task. See TaskSetStartOffset.
TaskGetStartOffset
Gets the start offset of a task. See TaskGetStartOffset.
TaskSetDuration
Sets the duration of a task. See TaskSetDuration.
TaskGetDuration
Gets the duration of a task. See TaskGetDuration.
TaskSetForceSubProject
Sets the force subproject flag of a task. See TaskSetForceSubProject.
TaskGetForceSubProject
Gets the force subproject flag of a task. See TaskGetForceSubProject.
TaskSetBudgetedWork
Sets the budgeted work of a task. See TaskSetBudgetedWork.
TaskGetBudgetedWork
Gets the budgeted work of a task. See TaskGetBudgetedWork.
TaskGetLockedType
Gets the locked type of a task. See TaskGetLockedType.
TaskSetPercentComplete
Sets the completed percent of a task. See TaskSetPercentComplete.
TaskGetPercentComplete
Gets the completed percent of a task. See TaskGetPercentComplete.
TaskSetStatus
Sets the status of a task. See TaskSetStatus.
TaskGetStatus
Gets the status of a task. See TaskGetStatus.
TaskGetType
Gets the type of a task. See TaskGetType.
TaskSetVacationOptions
Sets the vacation options of a task. See TaskSetVacationOptions.
TaskGetVacationOptions
Gets the vacation options of a task. See TaskGetVacationOptions.
TaskCreateComment
Creates a comment on a task. See TaskCreateComment.
TaskDeleteComment
Deletes a comment of a task. See TaskDeleteComment.
TaskNotifyCommentPosted
Sends notifications about a posted comment on a task. See TaskNotifyCommentPosted.
TaskSetComment
Sets the data of a comment of a task. See TaskSetComment.
TaskGetComment
Gets the data of a comment of a task. See TaskGetComment.
TaskSetDescription
Sets the description of a task. See TaskSetDescription.
TaskGetDescription
Gets the description of a task. See TaskGetDescription.
TaskSetHyperlink
Sets the hyper link of a task. See TaskSetHyperlink.
TaskGetHyperlink
Gets the hyper link of a task. See TaskGetHyperlink.
TaskSetCommentsOptions
Sets the comments options of a task. See TaskSetCommentsOptions.
TaskGetCommentsOptions
Gets the comments options of a task. See TaskGetCommentsOptions.
TaskSetLockedBy
Sets the resource a task is locked by. See TaskSetLockedBy.
TaskGetLockedBy
Gets the resource a task is locked by. See TaskGetLockedBy.
TaskSetOriginallyCreatedBy
Sets the originally created/reported by user of a task. See TaskSetOriginallyCreatedBy.
TaskGetOriginallyCreatedBy
Gets the originally created/reported by user of a task. See TaskGetOriginallyCreatedBy.
TaskSetCustomColumnData
Sets the custom column data of a custom column of a task. See TaskSetCustomColumnData.
TaskGetCustomColumnData
Gets the custom column data of a custom column of a task. See TaskGetCustomColumnData.
TaskSetLastResourceCommentReadTime
Sets the last resource comment read time of a resource and task. See TaskSetLastResourceCommentReadTime.
TaskGetLastResourceCommentReadTime
Gets the last resource comment read time of a resource and task. See TaskGetLastResourceCommentReadTime.
TaskSetAttachedDocuments
Sets the attached documents of a task. See TaskSetAttachedDocuments.
TaskGetAttachedDocuments
Gets the attached documents of a task. See TaskGetAttachedDocuments.
TaskSetDelegateTo
Sets the resources or groups a task is delegated to. See TaskSetDelegateTo.
TaskGetDelegateTo
Gets the resources of groups a task is delegated to. See TaskGetDelegateTo.
TaskSetResourceAllocation
Sets the resources allocated to a task. See TaskSetResourceAllocation.
TaskGetResourceAllocation
Gets the resources allocated to a task. See TaskGetResourceAllocation.
TaskSetSprintAllocatedResources
Sets the resources or groups allocated to a sprint. See TaskSetSprintAllocatedResources.
TaskGetSprintAllocatedResources
Gets the resources or groups allocated to a sprint. See TaskGetSprintAllocatedResources.
TaskSetSprintResourceAllocation
Sets the resource allocation of a sprint. See TaskSetSprintResourceAllocation.
TaskGetSprintResourceAllocation
Gets the resource allocation of a sprint. See TaskGetSprintResourceAllocation.
TaskGetOldPercentResourceAllocation
Gets all previous partial allocations of a task. See TaskGetOldPercentResourceAllocation.
TaskSetCompleted
Sets the completed flag of a task. See TaskSetCompleted.
TaskGetCompleted
Gets the completed flag of a task. See TaskGetCompleted.
TaskSetTimeZones
Sets the start and end dates of the zones of a scheduled task. See TaskSetTimeZones.
TaskGetTimeZones
Gets the start and end dates of the zones of a scheduled task. See TaskGetTimeZones.
TaskGetTotalDuration
Gets the total duration of a task. See TaskGetTotalDuration.
TaskSetVisibleTo
Sets the resources a task is visible to. See TaskSetVisibleTo.
TaskGetVisibleTo
Gets the resources a task is visible to. See TaskGetVisibleTo.
TaskSetWorkRemaining
Sets work remaining of a task. See TaskSetWorkRemaining.
TaskGetWorkRemaining
Gets work remaining of a task. See TaskGetWorkRemaining.
TaskSetWorkRemainingHistory
Sets work remaining history of a task. See TaskSetWorkRemainingHistory.
TaskGetWorkRemainingHistory
Gets work remaining history of a task. See TaskGetWorkRemainingHistory.
TaskEnumWorkRemainingHistoryDays
Enumerates work remaining history days on a task. See TaskSetIdealDaysHistory.
TaskSetIdealDaysHistory
Sets ideal days history of a task. See TaskSetWorkRemainingHistory.
TaskGetIdealDaysHistory
Gets ideal days history of a task. See TaskGetIdealDaysHistory.
TaskEnumIdealDaysHistoryDays
Enumerates ideal days history days on a task. See TaskEnumIdealDaysHistoryDays.
TaskSetPointsHistory
Sets points history of a task. See TaskSetPointsHistory.
TaskGetPointsHistory
Gets points history of a task. See TaskGetPointsHistory.
TaskEnumPointsHistoryDays
Enumerates points history days on a task. See TaskEnumPointsHistoryDays.
TaskSetSeverity
Sets severity of a task. See TaskSetSeverity.
TaskGetSeverity
Gets severity of a task. See TaskGetSeverity.
TaskSetWorkflowStatus
Sets workflow status of a task. See TaskSetWorkflowStatus.
TaskGetWorkflowStatus
Gets workflow status of a task. See TaskGetWorkflowStatus.
TaskSetUserStoryFlag
Sets the user story flag of a task. See TaskSetUserStoryFlag.
TaskGetUserStoryFlag
Gets the user story flag of a task. See TaskGetUserStoryFlag.
TaskSetEpicFlag
Sets the epic flag of a task. See TaskSetEpicFlag.
TaskGetEpicFlag
Gets the epic flag of a task. See TaskGetEpicFlag.
TaskSetLastUpdatedTime
Sets the last time a task was updated of a task. See TaskSetLastUpdatedTime.
TaskGetLastUpdatedTime
Gets the last time a task was updated of a task. See TaskGetLastUpdatedTime.
TaskSetLastUpdatedBy
Sets the last user that updated a task. See TaskSetLastUpdatedBy.
TaskGetLastUpdatedBy
Gets the last user that updated a task. See TaskSetLastUpdatedBy.
TaskSetDetailedDescription
Sets detailed description of a task. See TaskSetDetailedDescription.
TaskGetDetailedDescription
Gets detailed description of a task. See TaskGetDetailedDescription.
TaskSetStepsToReproduce
Sets steps to reproduce of a task. See TaskSetStepsToReproduce.
TaskGetStepsToReproduce
Gets steps to reproduce of a task. See TaskGetStepsToReproduce.
TaskSetSprintResourcesHaveFullRights
Sets sprint resources to have full rights on a task. See TaskSetSprintResourcesHaveFullRights.
TaskGetSprintResourcesHaveFullRights
Gets sprint resources to have full rights on a task. See TaskGetSprintResourcesHaveFullRights.
TaskGetAttachmentPath
Gets the attachment path in document management for a task. See TaskGetAttachmentPath.
TaskGetID
Gets the task or bug id. See TaskGetID.
TaskSetLinkedToMilestones
Sets the milestones a task is linked to. See TaskSetLinkedToMilestones.
TaskGetLinkedToMilestones
Gets the milestones a task is linked to. See TaskGetLinkedToMilestones.
TaskGetLinkedToSprint
Gets the sprint a task is linked to. See TaskGetLinkedToSprint.
TaskSetLinkedTo
Sets the objects a task is linked to. See TaskSetLinkedTo.
TaskGetLinkedTo
Gets the objects a task is linked to. See TaskGetLinkedTo.
TaskSetWallPositions
Sets the wall positions for a task. See TaskSetWallPositions.
TaskGetWallPositions
Gets the wall positions for a task. See TaskGetWallPositions.
TaskSetFullyCreated
Sets the fully created flag for a task. See TaskSetFullyCreated.
TaskGetFullyCreated
Gets the fully created flag for a task. See TaskGetFullyCreated.
TaskSetArchived
Sets the archived status of a sprint task. See TaskSetArchived.
TaskGetArchived
Gets the archived status of a sprint task. See TaskGetArchived.
TaskUpdatePipelineWorkflowToNewestVersion
Updates all tasks to the newest version of the workflow. See TaskUpdatePipelineWorkflowToNewestVersion.
UtilPrepareFindContext
Prepares a find context to be used in future finds. See UtilPrepareFindContext.
UtilUpdateFindContext
Updates find context with new search string. See UtilUpdateFindContext.
TaskFind
Find all the tasks given a find context. See TaskFind.
TaskRefUtilIsInFindContext
Checks if a task is included in a find context. See TaskRefUtilIsInFindContext.
TaskSetWorkflow
Sets the workflow of a task. See TaskSetWorkflow.
TaskGetWorkflow
Gets the workflow of a task. See TaskGetWorkflow.
TaskGetLinkedToPipelineTask
Gets the pipeline task that created the task. See TaskGetLinkedToPipelineTask.
TaskSetCreatedPipelineTasks
Sets the tasks that the pipeline task created. See TaskSetCreatedPipelineTasks.
TaskGetCreatedPipelineTasks
Gets the tasks that the pipeline task created. See TaskGetCreatedPipelineTasks.
TaskSetCreatedFromWorkflowObject
Sets the workflow object that the task was created from. See TaskSetCreatedFromWorkflowObject.
TaskGetCreatedFromWorkflowObject
Gets the workflow object that the task was created from. See TaskGetCreatedFromWorkflowObject.
TaskSetDefaultWorkflow
Sets the default workflow of a task. See TaskSetDefaultWorkflow.
TaskGetDefaultWorkflow
Gets the default workflow of a task. See TaskGetDefaultWorkflow.
TaskPipelineGetTaskRef
Gets the pipeline task reference of a task. See TaskPipelineGetTaskRef.
TaskRefGetColumnText
Gets the text representation of a columns content for a task. See TaskRefGetColumnText.
TaskGetLastAssignedInWorkflowStatus
Gets a list of resources that are assigned to a specific status in a workflow. See TaskGetLastAssignedInWorkflowStatus.
TaskGetLastAssignedInWorkflowStatuses
Gets a list of resources that are assigned for all workflows and statuses for a task. See TaskGetLastAssignedInWorkflowStatuses.
TaskGetLastEnterWorkflowStatus
Gets last entered info for a specific status in a workflow. See TaskGetLastEnterWorkflowStatus.
TaskGetLastExitWorkflowStatus
Gets last exit info for a specific status in a workflow. See TaskGetLastExitWorkflowStatus.
TaskGetAgilePriorityCategory
Gets the agile priority of a task. See TaskGetAgilePriorityCategory.
TaskSetAgilePriorityCategory
Sets the agile priority of a task. See TaskSetAgilePriorityCategory.
TaskGetBacklogPriority
Gets the backlog priority of a task. See TaskGetBacklogPriority.
TaskSetBacklogPriority
Sets the backlog priority of a task. See TaskSetBacklogPriority.
TaskGetSprintPriority
Gets the sprint priority of a task. See TaskGetSprintPriority.
TaskSetSprintPriority
Sets the sprint priority of a task. See TaskSetSprintPriority.
TaskGetBugPriority
Gets the bug priority of a task. See TaskGetBugPriority.
TaskSetBugPriority
Sets the bug priority of a task. See TaskSetBugPriority.
TaskUtilGetWorkflowProgression
Generates list of possible progression states. See TaskUtilGetWorkflowProgression
TaskUtilGetWorkflowProgressionFromTaskStatusChange
Gets workflow progression for workflow based on workflow and status. See TaskUtilGetWorkflowProgressionFromTaskStatusChange.
TaskGetSDKInternalData
Gets task SDK internal data. See TaskGetSDKInternalData.
TaskSetSDKInternalData
Sets task SDK internal data. See TaskSetSDKInternalData.
TaskGetCommentSDKInternalData
Gets task comment SDK internal data. See TaskGetCommentSDKInternalData.
TaskSetCommentSDKInternalData
Sets task comment SDK internal data. See TaskSetCommentSDKInternalData.
TaskRefGetTask
Gets the task a task reference refers to. See TaskRefGetTask.
TaskRefGetContainer
Gets the container of a task reference. See TaskRefGetContainer.
TaskRefEnum
Enumerates task references in a container. See TaskRefEnum.
TaskRefConnect
Connects two task references. See TaskRefConnect.
TaskRefGetTreeLevel
Gets the tree level of a task reference. See TaskRefGetTreeLevel.
TaskRefGetPreviousID
Gets the previous id of a task reference. See TaskRefGetPreviousID.
TaskRefClearNewlyCreated
Clears the newly created flag on a task reference. See TaskRefClearNewlyCreated.
TaskRefGetNewlyCreated
Gets the newly created flag on a task reference. See TaskRefGetNewlyCreated.
TaskRefSetUIDHistory
Sets the unique identifier history of a task reference. See TaskRefSetUIDHistory.
TaskRefGetUIDHistory
Gets the unique identifier history of a task reference. See TaskRefGetUIDHistory.
TaskRefGetPreviousWorkPriorityID
Gets the parent id of a task reference in the work priority list. See TaskRefGetPreviousWorkPriorityID.
TaskRefGetSummary
Gets the summary of a task ref. See TaskRefGetSummary.
TaskRefGetMilestoneSummary
Gets the summary of a milestone task ref. See TaskRefGetMilestoneSummary.
TaskRefConnectionsEnum
Gets all task references that are connected to/from a given task ref. See TaskRefConnectionsEnum.
TaskUtilSprintTaskRefEnum
Enumerates all task references that are are part of a sprint. See TaskUtilSprintTaskRefEnum.
TaskUtilGetEffectiveLinkedToMilestones
Returns the effective release tags for the task. See TaskUtilGetEffectiveLinkedToMilestones.
TaskGetOriginallyCreatedOnTime
Returns the time the task was created on. See TaskGetOriginallyCreatedOnTime.
TaskRefGetSDKInternalData
Gets task ref SDK internal data. See TaskRefGetSDKInternalData.
TaskRefSetSDKInternalData
Sets task ref SDK internal data. See TaskRefSetSDKInternalData.
TaskRefUtilGetSubProjectPath
Gets the sub project path. See TaskRefUtilGetSubProjectPath.
TaskRefUtilEnumChildren
Enumerates children task references of a parent task reference. See TaskRefUtilEnumChildren.
TaskRefUtilEnumPipelineProgression
Enumerates not completed pipeline task references of a parent task reference. See TaskRefUtilEnumPipelineProgression.
TaskRefUtilGetParent
Gets the parent task reference of a task reference id. See TaskRefUtilGetParent.
TaskRefUtilGetNext
Gets the successor task reference of a task reference id. See TaskRefUtilGetNext.
TaskRefUtilGetNextSibling
Gets the successor sibling task reference of a task reference id. See TaskRefUtilGetNextSibling.
TaskRefUtilGetPrevSibling
Gets the predecessor sibling task reference of a task reference id. See TaskRefUtilGetPrevSibling.
TaskRefUtilGetNextAtSameOrLowerLevel
Gets the successor task reference at the same or lower level as a task reference id. See TaskRefUtilGetNextAtSameOrLowerLevel.
TaskRefUtilGetPrevAtSameOrLowerLevel
Gets the predecessor task reference at the same or lower level as a task reference id. See TaskRefUtilGetPrevAtSameOrLowerLevel.
TaskRefUtilMoveInTree
Moves a task reference from one position to another in the task ref tree structure. See TaskRefUtilMoveInTree.
TaskRefUtilTraceTree
Traces the task tree. See TaskRefUtilTraceTree.
TaskRefUtilIsCompleted
Gets the completion status of a task. See TaskRefUtilIsCompleted.
TaskRefUtilHasChildren
Checks if task reference has children. See TaskRefUtilHasChildren.
TaskRefUtilCanStartNow
Checks if task reference has can be started now. See TaskRefUtilCanStartNow.
TaskUtilOneTaskRefHasChildren
Checks if any of the task refs of a task has children. See TaskUtilOneTaskRefHasChildren.
TaskUtilUpdateAgilePriority
Updates the priority order in a project according to the agile priority status. See TaskUtilUpdateAgilePriority.
TaskRefGetWBSPath
Gets task ref WBS path. See TaskRefGetWBSPath
TaskConnectionDelete
Deletes a task reference connection. See TaskConnectionDelete.
TaskConnectionSetConnectionType
Sets the type of a task reference connection. See TaskConnectionSetConnectionType.
TaskConnectionGetConnectionType
Gets the type of a task reference connection. See TaskConnectionGetConnectionType.
TaskConnectionSetLeadLagTime
Sets the lead/lag time of a task reference connection. See TaskConnectionSetLeadLagTime.
TaskConnectionGetLeadLagTime
Gets the lead/lag time of a task reference connection. See TaskConnectionGetLeadLagTime.
TaskConnectionGetConnectFrom
Gets the from task reference of a task reference connection. See TaskConnectionGetConnectFrom.
TaskConnectionGetConnectTo
Gets the to task reference of a task reference connection. See TaskConnectionGetConnectTo.
VersionControlRegisterCallback
Registers a version control change callback. See VersionControlRegisterCallback.
VersionControlUnregisterCallback
Unregisters a version control change callback. See VersionControlUnregisterCallback.
VersionControlInit
Initializes version control functionality. See VersionControlInit.
VersionControlErrorToStr
Gets the string description for a version control error code. See VersionControlErrorToStr.
VersionControlEnumFiles
Enumerates version control files. See VersionControlEnumFiles.
VersionControlFileExists
Checks in a file exists in repository. See VersionControlFileExists.
VersionControlOperationPending
Checks if there is a pending version control command. See VersionControlOperationPending.
VersionControlGetFileInfo
Gets information about a version control file. See VersionControlGetFileInfo.
VersionControlGetFileHistory
Gets version control file history. See VersionControlGetFileHistory.
VersionControlGetAccessRights
Gets access rights for a version control file. See VersionControlGetAccessRights.
VersionControlAddFiles
Adds files to the version control system. See VersionControlAddFiles.
VersionControlCreateDirectories
Creates directories in the version control system. See VersionControlCreateDirectories.
VersionControlSyncFiles
Syncs version control files. See VersionControlSyncFiles.
VersionControlCheckOutFiles
Checks out version control files. See VersionControlCheckOutFiles.
VersionControlCheckInFiles
Checks in version control files. See VersionControlCheckInFiles.
VersionControlRenameFiles
Renames version control files. See VersionControlRenameFiles.
VersionControlRevertFiles
Reverts version control files. See VersionControlRevertFiles.
VersionControlDeleteFiles
Deletes version control files. See VersionControlDeleteFiles.
VersionControlRestoreDeletedFiles
Restores deleted version control files. See VersionControlRestoreDeletedFiles.
VersionControlDeleteVersions
Deletes versions on a version control file. See VersionControlDeleteVersions.
VersionControlRollbackFile
Rollbacks to a previous version of a version control file. See VersionControlRollbackFile.
VersionControlSetAccessRights
Sets access rights of a version control file. See VersionControlSetAccessRights.
VersionControlUtilPathToFileID
Converts a file path to a file id. See VersionControlUtilPathToFileID.
VersionControlUtilFileIDToPath
Converts a file id to a file path. See VersionControlUtilFileIDToPath.
VersionControlUtilIsInitialized
Checks if the version control functionality is initialized. See VersionControlUtilIsInitialized.
VersionControlSetLocalPath
Sets the local path for version control files. See VersionControlSetLocalPath.
CommunicationChannelRegister
Registers a communication channel. See CommunicationChannelRegister.
CommunicationChannelUnregister
Unregisters a communication channel. See CommunicationChannelUnregister.
CommunicationChannelSendPacket
Sends a packet to a communication channel. See CommunicationChannelSendPacket.
CommunicationChannelEnum
Gets channels and their associated data. See CommunicationChannelEnum.
ChatHistoryGetHistory
Gets chat data history for a chat room. See ChatHistoryGetHistory.
DataHistoryGetHistory
Gets data history for an object. See DataHistoryGetHistory.
DataHistoryGetEntryData
Gets data history entry data in a variant data format. See DataHistoryGetEntryData.
DataHistorySetMaxCacheEntries
Sets the number of data history entries that are cached on the client. See DataHistorySetMaxCacheEntries.
VariantDecode_HPMInt32
Decodes variant data to the HPMInt32 format. See VariantDecode_HPMInt32.
VariantDecode_HPMUInt32
Decodes variant data to the HPMUInt32 format. See VariantDecode_HPMUInt32.
VariantDecode_HPMInt64
Decodes variant data to the HPMInt64 format. See VariantDecode_HPMInt64.
VariantDecode_HPMUInt64
Decodes variant data to the HPMUInt64 format. See VariantDecode_HPMUInt64.
VariantDecode_HPMFP32
Decodes variant data to the HPMFP32 format. See VariantDecode_HPMFP32.
VariantDecode_HPMFP64
Decodes variant data to the HPMFP64 format. See VariantDecode_HPMFP64.
VariantDecode_HPMUniqueID
Decodes variant data to the HPMUniqueID format. See VariantDecode_HPMUniqueID.
VariantDecode_HPMString
Decodes variant data to the HPMString format. See VariantDecode_HPMString.
VariantDecode_HPMTaskLinkedToMilestones
Decodes variant data to the HPMTaskLinkedToMilestones format. See VariantDecode_HPMTaskLinkedToMilestones.
VariantDecode_HPMTaskDelegateTo
Decodes variant data to the HPMTaskDelegateTo format. See VariantDecode_HPMTaskDelegateTo.
VariantDecode_HPMTaskSprintAllocatedResources
Decodes variant data to the HPMTaskSprintAllocatedResources format. See VariantDecode_HPMTaskSprintAllocatedResources.
VariantDecode_HPMTaskVisibleTo
Decodes variant data to the HPMTaskVisibleTo format. See VariantDecode_HPMTaskVisibleTo.
VariantDecode_HPMTaskResourceAllocation
Decodes variant data to the HPMTaskResourceAllocation format. See VariantDecode_HPMTaskResourceAllocation.
VariantDecode_HPMStatisticsMultiFrequency
Decodes variant data to the HPMStatisticsMultiFrequency format. See VariantDecode_HPMStatisticsMultiFrequency.
VariantDecode_HPMStatisticsCustomStatisticsFrequency
Decodes variant data to the HPMStatisticsCustomStatisticsFrequency format. See VariantDecode_HPMStatisticsCustomStatisticsFrequency.
VariantDecode_HPMTaskAttachedDocuments
Decodes variant data to the HPMTaskAttachedDocuments format. See VariantDecode_HPMTaskAttachedDocuments.
VariantDecode_HPMTaskVacationOptions
Decodes variant data to the HPMTaskVacationOptions format. See VariantDecode_HPMTaskVacationOptions.
VariantDecode_HPMTaskCommentsOptions
Decodes variant data to the HPMTaskCommentsOptions format. See VariantDecode_HPMTaskCommentsOptions.
VariantDecode_HPMTaskLinkedTo
Decodes variant data to the HPMTaskLinkedTo format. See VariantDecode_HPMTaskLinkedTo.
VariantDecode_HPMTaskSprintResourceAllocation
Decodes variant data to the HPMTaskSprintResourceAllocation format. See VariantDecode_HPMTaskSprintResourceAllocation.
VariantDecode_HPMDataHistoryTaskCreated
Decodes variant data to the HPMDataHistoryTaskCreated format. See VariantDecode_HPMDataHistoryTaskCreated.
VariantDecode_HPMDataHistoryTaskRestoredFromHistory
Decodes variant data to the HPMDataHistoryTaskRestoredFromHistory format. See VariantDecode_HPMDataHistoryTaskRestoredFromHistory.
VariantDecode_HPMDataHistoryTaskMoved
Decodes variant data to the HPMDataHistoryTaskMoved format. See VariantDecode_HPMDataHistoryTaskMoved.
VariantDecode_HPMDataHistoryTaskRenameCustomColumn
Decodes variant data to the HPMDataHistoryTaskRenameCustomColumn format. See VariantDecode_HPMDataHistoryTaskRenameCustomColumn.
VariantDecode_HPMDataHistoryTaskProxyCreated
Decodes variant data to the HPMDataHistoryTaskProxyCreated format. See VariantDecode_HPMDataHistoryTaskProxyCreated.
VariantDecode_HPMDataHistoryTaskProxyDeleted
Decodes variant data to the HPMDataHistoryTaskProxyDeleted format. See VariantDecode_HPMDataHistoryTaskProxyDeleted.
VariantDecode_HPMDataHistoryTaskRenameBoardElementInfo
Decodes variant data to the HPMDataHistoryTaskRenameBoardElementInfo. See VariantDecode_HPMDataHistoryTaskRenameBoardElementInfo.
VariantDecode_HPMDataHistoryTaskBoardCardInfo
Decodes variant data to the HPMDataHistoryTaskBoardCardInfo. See VariantDecode_HPMDataHistoryTaskBoardCardInfo.
VariantDecode_HPMTaskTimeZones
Decodes variant data to the HPMTaskTimeZones format. See VariantDecode_HPMTaskTimeZones.
VariantDecode_HPMChatMessage
Decodes variant data to the HPMChatMessage format. See VariantDecode_HPMChatMessage.
VariantDecode_HPMProjectCustomColumns
Decodes variant data to the HPMProjectCustomColumns format. See VariantDecode_HPMProjectCustomColumns.
VariantDecode_HPMProjectCustomColumnsColumn
Decodes variant data to the HPMProjectCustomColumnsColumn format. See VariantDecode_HPMProjectCustomColumnsColumn.
VariantDecode_HPMProjectCustomColumnAncestry
Decodes variant data to the HPMProjectCustomColumnAncestry format. See VariantDecode_HPMProjectCustomColumnAncestry.
VariantDecode_HPMProjectWorkflowSettings
Decodes variant data to the HPMProjectWorkflowSettings format. See VariantDecode_HPMProjectWorkflowSettings.
VariantDecode_HPMHolidays
Decodes variant data to the HPMHolidays format. See VariantDecode_HPMHolidays.
VariantDecode_HPMWorkingDays
Decodes variant data to the HPMWorkingDays format. See VariantDecode_HPMWorkingDays.
VariantDecode_HPMCustomWorkingDays
Decodes variant data to the HPMCustomWorkingDays format. See VariantDecode_HPMCustomWorkingDays.
VariantDecode_HPMWorkingHours
Decodes variant data to the HPMWorkingHours format. See VariantDecode_HPMWorkingHours.
VariantDecode_HPMCustomWorkingHours
Decodes variant data to the HPMCustomWorkingHours format. See VariantDecode_HPMCustomWorkingHours.
VariantDecode_HPMProjectDefaultColumns
Decodes variant data to the HPMProjectDefaultColumns format. See VariantDecode_HPMProjectDefaultColumns.
VariantDecode_HPMUntranslatedString
Decodes variant data to the HPMUntranslatedString format. See VariantDecode_HPMUntranslatedString.
VariantDecode_HPMBinaryBuffer
Decodes variant data to the HPMBinaryBuffer format. See VariantDecode_HPMBinaryBuffer.
VariantDecode_ProjectBugReportResources
Decodes variant data to the HPMResourceDefinitionList format. See VariantDecode_ProjectBugReportResources.
VariantDecode_HPMProjectColumnMetaData
Decodes variant data to the HPMProjectColumnMetaData format. See VariantDecode_HPMProjectColumnMetaData.
VariantDecode_HPMProjectViewPreset
Decodes variant data to the HPMProjectViewPreset format. See VariantDecode_HPMProjectViewPreset.
VariantDecode_HPMResourceDefinitionList
Decodes variant data to the HPMResourceDefinitionList format. See VariantDecode_HPMResourceDefinitionList.
VariantEncode_HPMResourceDefinitionList
Encodes HPMResourceDefinitionList data to a variant format. See VariantEncode_HPMResourceDefinitionList.
VariantEncode_HPMInt32
Encodes HPMInt32 data to a variant format. See VariantEncode_HPMInt32.
VariantEncode_HPMUInt32
Encodes HPMUInt32 data to a variant format. See VariantEncode_HPMUInt32.
VariantEncode_HPMInt64
Encodes HPMInt64 data to a variant format. See VariantEncode_HPMInt64.
VariantEncode_HPMUInt64
Encodes HPMUInt64 data to a variant format. See VariantEncode_HPMUInt64.
VariantEncode_HPMFP32
Encodes HPMFP32 data to a variant format. See VariantEncode_HPMFP32.
VariantEncode_HPMFP64
Encodes HPMFP64 data to a variant format. See VariantEncode_HPMFP64.
VariantEncode_HPMUniqueID
Encodes HPMUniqueID data to a variant format. See VariantEncode_HPMUniqueID.
VariantEncode_HPMString
Encodes HPMString data to a variant format. See VariantEncode_HPMString.
VariantEncode_HPMUntranslatedString
Encodes HPMUntranslatedString data to a variant format. See VariantEncode_HPMUntranslatedString.
VariantEncode_EHPMTaskStatus
Encodes a EHPMTaskStatus status to a variant format. See VariantEncode_EHPMTaskStatus.
CriteriaDataDecode_HPMTaskFindCriteriaTypeText
Decodes criteria data to the HPMTaskFindCriteriaTypeText format. See CriteriaDataDecode_HPMTaskFindCriteriaTypeText.
CriteriaDataDecode_HPMTaskFindCriteriaTypeInteger
Decodes criteria data to the HPMTaskFindCriteriaTypeInteger format. See CriteriaDataDecode_HPMTaskFindCriteriaTypeInteger.
CriteriaDataDecode_HPMTaskFindCriteriaTypeFloat
Decodes criteria data to the HPMTaskFindCriteriaTypeFloat format. See CriteriaDataDecode_HPMTaskFindCriteriaTypeFloat.
CriteriaDataDecode_HPMTaskFindCriteriaTypeGeneralCondition
Decodes criteria data to the HPMTaskFindCriteriaTypeGeneralCondition format. See CriteriaDataDecode_HPMTaskFindCriteriaTypeGeneralCondition.
CriteriaDataDecode_HPMTaskFindCriteriaTypeDate
Decodes criteria data to the HPMTaskFindCriteriaTypeDate format. See CriteriaDataDecode_HPMTaskFindCriteriaTypeDate.
CriteriaDataDecode_HPMTaskFindCriteriaTypeDroplist
Decodes criteria data to the HPMTaskFindCriteriaTypeDroplist format. See CriteriaDataDecode_HPMTaskFindCriteriaTypeDroplist.
CriteriaDataDecode_HPMTaskFindCriteriaTypeMultiSelectDroplist
Decodes criteria data to the HPMTaskFindCriteriaTypeMultiSelectDroplist format. See CriteriaDataDecode_HPMTaskFindCriteriaTypeMultiSelectDroplist.
CriteriaDataEncode_HPMTaskFindCriteriaTypeText
Encodes criteria data to the HPMTaskFindCriteriaTypeText format. See CriteriaDataEncode_HPMTaskFindCriteriaTypeText.
CriteriaDataEncode_HPMTaskFindCriteriaTypeInteger
Encodes criteria data to the HPMTaskFindCriteriaTypeInteger format. See CriteriaDataEncode_HPMTaskFindCriteriaTypeInteger.
CriteriaDataEncode_HPMTaskFindCriteriaTypeFloat
Encodes criteria data to the HPMTaskFindCriteriaTypeFloat format. See CriteriaDataEncode_HPMTaskFindCriteriaTypeFloat.
CriteriaDataEncode_HPMTaskFindCriteriaTypeGeneralCondition
Encodes criteria data to the HPMTaskFindCriteriaTypeGeneralCondition format. See CriteriaDataEncode_HPMTaskFindCriteriaTypeGeneralCondition.
CriteriaDataEncode_HPMTaskFindCriteriaTypeDate
Encodes criteria data to the HPMTaskFindCriteriaTypeDate format. See CriteriaDataEncode_HPMTaskFindCriteriaTypeDate.
CriteriaDataEncode_HPMTaskFindCriteriaTypeDroplist
Encodes criteria data to the HPMTaskFindCriteriaTypeDroplist format. See CriteriaDataEncode_HPMTaskFindCriteriaTypeDroplist.
CriteriaDataEncode_HPMTaskFindCriteriaTypeMultiSelectDroplist
Encodes criteria data to the HPMTaskFindCriteriaTypeMultiSelectDroplist format. See CriteriaDataEncode_HPMTaskFindCriteriaTypeMultiSelectDroplist.
AuthenticationClientPluginRegister
Registers a client authentication method. See AuthenticationClientPluginRegister.
AuthenticationClientPluginUnregister
Unregisters a client authentication method. See AuthenticationClientPluginUnregister.
AuthenticationClientProtocolEnded
Notification from SDK Plugin to Client that an authentication protocol has ended
AuthenticationIntegrationProtocolEnded
Notification from Integration SDK Client to Server that an authentication protocol has ended
AuthenticationResolveCredentials
Checks if user credentials are valid or not.
AuthenticationResolveCredentialsEnded
Notification from Integration SDK Client to Server that an credentials check has ended
DashboardPageEnum
Enumerates dashboard page IDs in a database. See DashboardPageEnum.
DashboardPageGetName
Gets the name of a page. See DashboardPageGetName.
DashboardPageSetName
Sets the name of a page. See DashboardPageSetName.
DashboardPageGetTheme
Gets the theme of a page. See DashboardPageGetTheme.
DashboardPageSetTheme
Sets the theme of a page. See DashboardPageSetTheme.
DashboardThemeEnum
Lists the available dashboard themes. See DashboardThemeEnum.
DashboardPageGetSharedToWithViewingRights
Gets the resources that the page is shared to with viewing rights. See DashboardPageGetSharedToWithViewingRights.
DashboardPageSetSharedToWithViewingRights
Sets the resources that the page is shared to with viewing rights. See DashboardPageSetSharedToWithViewingRights.
DashboardPageGetSharedToWithEditingRights
Gets the resources that the page is shared to with editing rights. See DashboardPageGetSharedToWithEditingRights.
DashboardPageSetSharedToWithEditingRights
Sets the resources that the page is shared to with editing rights. See DashboardPageSetSharedToWithEditingRights.
DashboardPageDelete
Deletes the page with the given unique identifier. See DashboardPageDelete.
DashboardPageCreate
Creates a new page. See DashboardPageCreate.
DashboardPageIsPersonal
Gets whether the page is personal to a resource. See DashboardPageIsPersonal.
DashboardPageGetCreatedBy
Gets the unique identifier of the resource that created the page. See DashboardPageGetCreatedBy.
DashboardPageGetLayout
Gets the layout of a page. See DashboardPageGetLayout.
DashboardPageSetLayout
Sets the layout of a page. See DashboardPageSetLayout.
DashboardChartEnum
Enumerates chart IDs on a dashboard page. See DashboardChartEnum.
DashboardChartCreate
TBD. See DashboardChartCreate.
DashboardChartDelete
TBD. See DashboardChartDelete.
DashboardChartSetName
TBD. See DashboardChartSetName.
DashboardChartSetPresentationConfig
TBD. See DashboardChartSetPresentationConfig.
DashboardChartSetComputationConfig
TBD. See DashboardChartSetComputationConfig.
DashboardChartGetName
TBD. See DashboardChartGetName.
DashboardChartGetPageID
TBD. See DashboardChartGetPageID.
DashboardChartGetComputationConfig
TBD. See DashboardChartGetComputationConfig.
DashboardChartGetPresentationConfig
TBD. See DashboardChartGetPresentationConfig.
DashboardChartGetHistoricComputationConfigs
TBD. See DashboardChartGetHistoricComputationConfigs.
DashboardChartGetLastSampledHistoricComputationConfig
TBD. See DashboardChartGetLastSampledHistoricComputationConfig.
DashboardUtilGetMeasureAutoName
TBD. See DashboardUtilGetMeasureAutoName.
DashboardUtilGetFilterAutoName
TBD. See DashboardUtilGetFilterAutoName.
DashboardUtilColumnCanBeUsedForDimension
TBD. See DashboardUtilColumnCanBeUsedForDimension.
DashboardUtilIsDimensionValidForResource
TBD. See DashboardUtilIsDimensionValidForResource.
DashboardUtilIsMeasureValidForResource
TBD. See DashboardUtilIsMeasureValidForResource.
DashboardUtilIsFilterValidForResource
TBD. See DashboardUtilIsFilterValidForResource.
DashboardUtilIsComputationConfigValidForResource
TBD. See DashboardUtilIsComputationConfigValidForResource.
DashboardSubscribeToChart
Subscribes to a chart. Chart data will be received asynchronously. See DashboardSubscribeToChart.
DashboardSubscriptionGetLastResultSetAsString
Decodes dashboard subscription data to result set as a HPMString. See DashboardSubscriptionGetLastResultSetAsString.
DashboardSubscriptionGetLastResultSet
Decodes dashboard subscription data to result set as a HPMDashboardChartResultSet. See DashboardSubscriptionGetLastResultSet.
UtilGetColumnHash
Gets the column hash from a set of column properties. See UtilGetColumnHash.
UtilIsIDValid
Checks if a unique identifier exists in the database. See UtilIsIDValid.
UtilIsIDTask
Checks if a unique identifier points to a task. See UtilIsIDTask.
UtilIsIDTaskRef
Checks if a unique identifier points to a task ref. See UtilIsIDTaskRef.
UtilIsIDProject
Checks if a unique identifier points to a project. See UtilIsIDProject.
UtilIsIDBacklogProject
Checks if a unique identifier points to a backlog project. See UtilIsIDBacklogProject.
UtilIsIDQAProject
Checks if a unique identifier points to a QA project. See UtilIsIDQAProject.
UtilIsIDResource
Checks if a unique identifier points to a resource. See UtilIsIDResource.
UtilDecodeCustomChoiceValue
Decodes a custom choice value. See UtilDecodeCustomChoiceValue.
UtilDecodeCustomColumnResourcesValue
Decodes a custom column resource value. See UtilDecodeCustomColumnResourcesValue.
UtilEncodeCustomColumnResourcesValue
Encodes a custom column resource value. See UtilEncodeCustomColumnResourcesValue.
UtilDecodeCustomColumnDateTimeValue
Decodes a custom column DateTime value. See UtilDecodeCustomColumnDateTimeValue.
UtilEncodeCustomColumnDateTimeValue
Encodes a custom column DateTime value. See UtilEncodeCustomColumnDateTimeValue.
UtilDecodeCustomColumnCalculatedValue
Decodes a custom function column value. See UtilDecodeCustomColumnCalculatedValue.
UtilGetRealProjectIDFromProjectID
Gets the unique identifier of the real project. See UtilGetRealProjectIDFromProjectID.
UtilGetLastErrorDescription
Gets the last error description. See UtilGetLastErrorDescription.
UtilGetHelixPlanURL
Gets the Helix Plan URL. See UtilGetHelixPlanURL.
UtilGetTaskInfoFromHelixPlanURL
Gets task information from a Helix Plan URL. See UtilGetTaskInfoFromHelixPlanURL.
UtilGetFindCriteriaDataTypeFromData
Gets the criteria data type of a criteria data. See UtilGetFindCriteriaDataTypeFromData.
UtilGetFindCriteriaDataTypeFromColumn
Gets the criteria data type of a column. See UtilGetFindCriteriaDataTypeFromColumn.
UtilConvertFindStringToReport
Converts a text string into a report. See UtilConvertFindStringToReport.
UtilConvertReportToFindString
Converts a report to a text string. See UtilConvertReportToFindString.
UtilGetColumnName
Gets the name of a column as a string. See UtilGetColumnName.
UtilGetColumnDescription
Gets the description of a column. See UtilGetColumnDescription.
UtilColumnToTaskField
Converts a column to a taskfield. See UtilColumnToTaskField.
UtilTaskFieldToColumn
Converts a taskfield to a column. See UtilTaskFieldToColumn.
UtilGetColumnDataItemFormatted
Gets the formatted string version of data in a column. See UtilGetColumnDataItemFormatted.
UtilIsColumnReadOnly
Checks if a column is read only. See UtilIsColumnReadOnly.
UtilGetColumnData
Gets the possible data values for a list column. See UtilGetColumnData.
LocalizationGetLanguages
Gets all the languages that are available to the application. See LocalizationGetLanguages.
LocalizationGetLanguageName
Gets the string representation of a language. See LocalizationGetLanguageName.
UtilGetWorkflowObjectName
Gets the name of a pipeline, workflow status or transition etc. See UtilGetWorkflowObjectName.
UtilGetWorkflowObjectIDFromName
Gets the object ID of a pipeline, workflow status or transition etc. See UtilGetWorkflowObjectIDFromName.
UtilGetWorkflowName
Gets the name of a pipeline or workflow. See UtilGetWorkflowName.
UtilGetWorkflowIDFromName
Gets the ID of a pipeline or workflow. See UtilGetWorkflowIDFromName.
UtilGetWorkflowType
Gets the type of a pipeline or workflow. See UtilGetWorkflowType.
UtilGetWorkflowContainerFlags
Gets the type pipeline or workflow container flags. See UtilGetWorkflowContainerFlags.
UtilTaskCommentExists
Checks if a comment exists on a task. See UtilTaskCommentExists.
UtilGlobalReportExists
Checks if a global report exsits. See UtilGlobalReportExists.
UtilProjectReportExists
Checks if a project report exists. See UtilProjectReportExists.
UtilWorkflowObjectExists
Checks if a workflow object exists. See UtilWorkflowObjectExists.
UtilWorkflowExists
Checks if a workflow exists. See UtilWorkflowExists.
DebugCheckHeap
Checks the integrity of the heap. See DebugCheckHeap.
LocalizationTranslateString
Translates an untranslated string. See LocalizationTranslateString.
LocalizationGetDefaultLanguage
Gets the default langue. Currently this is UK english. See LocalizationGetDefaultLanguage.
LocalizationCreateUntranslatedStringFromString
Encodes a string into an untranslated string. See LocalizationCreateUntranslatedStringFromString.
LocalizationCreateUntranslatedStringFromTranslationID
Encodes a translation id into an untranslated string. See LocalizationCreateUntranslatedStringFromTranslationID.
LocalizationGetTranslationIDFromFullTranslationID
Converts a full translation ID into a translation ID. See LocalizationGetTranslationIDFromFullTranslationID.
TaskBoardConvertSprintToBoard
Converts sprint to board. See TaskBoardConvertSprintToBoard.
TaskGetSprintIsBoard
Checks whether sprint is converted to board.. See TaskGetSprintIsBoard.
TaskBoardGetCardAttributeColumns
Gets the list of card attribute columns for the board. See TaskBoardGetCardAttributeColumns.
TaskBoardGetColumnToStatusMapping
Gets the list of pair of column and it's mapped status. See TaskBoardGetColumnToStatusMapping.
TaskBoardLaneEnum
Enumerates all lanes on a board. See TaskBoardLaneEnum.
TaskBoardLaneColumnEnum
Enumerates all columns on a lane. See TaskBoardLaneColumnEnum.
TaskBoardElementGetBoard
Get Board of the element. See TaskBoardElementGetBoard.
TaskBoardElementGetName
Gets the name of an element on a board. See TaskBoardElementGetName.
TaskBoardElementGetType
Gets the type of an element on a board. See TaskBoardElementGetType.
TaskBoardColumnGetParentLane
Gets the parent lane for column. See TaskBoardColumnGetParentLane.
TaskBoardElementGetPosition
Gets the position for element. See TaskBoardElementGetPosition
TaskBoardUpdateAttributes
Updates board's attributes. See TaskBoardUpdateAttributes.
TaskBoardMapColumnToStatus
Maps board's column to new status. See TaskBoardMapColumnToStatus.
TaskBoardCreateLane
Creates lane in board. See TaskBoardCreateLane
TaskBoardCreateColumn
Creates column in parent lane in board. See TaskBoardCreateColumn.
TaskBoardUpdateElement
Updates element in board. See TaskBoardUpdateElement.
TaskBoardDeleteElement
Deletes element in board. See TaskBoardDeleteElement.
TaskBoardGetMembershipInfo
Get membership info for task that exists on board. See TaskBoardGetMembershipInfo.
TaskBoardMove
Moves cards to a new position on a board. See TaskBoardMove.
TaskBoardHide
Hides cards on a board. See TaskBoardHide.
TaskBoardUnhide
Unhides cards on a board and move them to the end of their cells. See TaskBoardUnhide.
TaskBoardElementGetCardLimit
Gets card limit for element in a board. See TaskBoardElementGetCardLimit
TaskBoardElementSetCardLimit
Updates card limit for element in a board. See TaskBoardElementSetCardLimit
SessionLock
Locks the session from receiving updates from server. See SessionLock.
SessionReadLock
Locks the session from receiving updates from server. See SessionReadLock.
SessionReadLockHeld
Notifies the SDK that during the lifetime of it's return value you guarantee that the read locks is being held by another thread. See SessionReadLockHeld.
TaskCheckWorkflowTransitionRequirements
Checks that the requirements of a workflow status transition are met. See TaskCheckWorkflowTransitionRequirements.
DebugSetFlags
Sets debug flags, makes possible to disable some SDK errors. See DebugSetFlags.
ProjectGetMilestones
Gets the list of all milestone task ref ids for the specified project.
ProjectGetSprints
Gets the list of all sprint task ref ids for the specified project.
VersionControlUtilResourceHasRights
Checks if a specified resource has a specific set of rights to a version control file.
TaskRefUtilHasLimitedVisibility
Checks if a specified resource has a specific set of rights to a version control file.
TaskRefUtilIsDelegatedTo
Checks if a specified resource has a specific set of rights to a version control file.
TaskLinkToMilestones
Links a list of tasks to milestones. See TaskLinkToMilestones.
UtilGetNoMilestoneID
Returns unique ID of 'No release' option. See UtilGetNoMilestoneID.
VersionControlUtilFileIDToFileInfo
Gets file info from a file id. See VersionControlUtilFileIDToFileInfo.
TaskGetLastUpdatedByResourceName
Gets the resource name of the last resource that updated a task. See TaskGetLastUpdatedByResourceName.
GlobalGetWebServiceHostname
Gets the Hansoft web service hostname. See GlobalGetWebServiceHostname.
DebugFlushWatchNotifications
Flushes any current watch notifications immediately. See DebugFlushWatchNotifications.
SessionTryLock
Tries to acquire a lock for the current thread. See SessionTryLock.
SessionDidTryLockSucceed
Checks if a try lock call was succesful. See SessionDidTryLockSucceed.
ProjectGetColumnResourcePermissionRules
Gets column resource permission rules of a project. See ProjectGetColumnResourcePermissionRules.
ProjectSetColumnResourcePermissionRules
Sets column resource permission rules of a project. See ProjectSetColumnResourcePermissionRules.
GlobalGetSecurityPolicy
Gets the security policy settings. See GlobalGetSecurityPolicy.
ProjectGetName
Gets the name of a project. See ProjectGetName.
ProjectGetSortName
Gets the sorting name of a project. See ProjectGetSortName.
ProjectGetNiceName
Gets the nice name of a project. See ProjectGetNiceName.
ProjectGetProjectMethod
Gets the project method of a project. See ProjectGetProjectMethod.
ProjectGetDefaultEditorMode
Gets the default editor mode of a project. See ProjectGetDefaultEditorMode.
ProjectGetAgileTemplate
Gets the agile template of a project. See ProjectGetAgileTemplate.
ResourceGroupGetSortNameFromResourceGroup
Gets the sort name from a resource group. See ResourceGroupGetSortNameFromResourceGroup.
ResourceGroupGetProjectFromResourceGroup
Gets the project from a resource group. See ResourceGroupGetProjectFromResourceGroup.
ResourceGetSortNameFromResource
Gets the sort name from a resource. See ResourceGetSortNameFromResource.
ResourceUtilResourceIsDeleted
Checks if a resource is deleted. See ResourceUtilResourceIsDeleted.
ResourceUtilResourceIsLocked
Checks if a resource is locked. See ResourceUtilResourceIsLocked.
ResourceGetEmailFromResource
Gets the email for a resource. See ResourceGetEmailFromResource.
ResourceUtilResourceIsActiveAccount
Checks if a resource account is active. See ResourceUtilResourceIsActiveAccount.
ResourceUtilResourceHasAdminAccess
Checks if a resource has admin access. See ResourceUtilResourceHasAdminAccess.
ResourceUtilResourceHasResourceAllocationAccess
Checks if a resource has resource allocation access. See ResourceUtilResourceHasResourceAllocationAccess.
ResourceUtilResourceHasDocumentManagementAccess
Checks if a resource has document management access. See ResourceUtilResourceHasDocumentManagementAccess.
ResourceUtilResourceIsAuthenticationProvider
Checks if an SDK resource is an authentication provider. See ResourceUtilResourceIsAuthenticationProvider.
ResourceUtilResourceIsCredentialCheckProvider
Checks if an SDK resource is a credential check provider. See ResourceUtilResourceIsCredentialCheckProvider.
ResourceUtilResourceHasAvatarManagementAccess
Checks if a resource has avatar management access. See ResourceUtilResourceHasAvatarManagementAccess.
ResourceUtilResourceIsSdkChatUser
Checks if an SDK resource is chat user. See ResourceUtilResourceIsSdkChatUser.
ResourceUtilResourceHasChatAccess
Checks if a resource has chat access. See ResourceUtilResourceHasChatAccess.
ResourceUtilResourceHasDashboardAccess
Checks if a resource has dashboard access. See ResourceUtilResourceHasDashboardAccess.
ResourceUtilResourceCanShareDashboardPages
Checks if a resource can share dashboard pages. See ResourceUtilResourceCanShareDashboardPages.
ResourceUtilSdkResourceGetSyncMethod
Gets the sync method for an SDK resource. See ResourceUtilSdkResourceGetSyncMethod.
GlobalGetSecurityOptions
Gets security options for authentication
AuthenticationResolveCredentialsHelixAuth
Resolve credentials using Helix Authentication Service.
UtilGetCustomColumnName
Gets the name of a custom column. See UtilGetCustomColumnName.
UtilGetCustomColumnType
Gets the type of a custom column. See UtilGetCustomColumnType.
SessionOpenVirtualImpersonated
Opens a virtual impersonated SDK session. See SessionOpenVirtualImpersonated.
UtilNormaliseCustomSettings
Gets the normalised version of a custom settings string. See UtilNormaliseCustomSettings.
ProjectUtilGetCustomColumnIsHidden
Checks if a custom column is hidden in a project. See ProjectUtilGetCustomColumnIsHidden.
TaskRefReportFind
Returns all tasks references found when a report is applied. See TaskRefReportFind.
UtilGetReport
Gets a report from a report GUID. See UtilGetReport.
ProjectGetCustomName
Gets the custom name from a project method template setting. See ProjectGetCustomName.
ProjectUtilCustomColumnExistInProject
Checks if a custom column exists in a project. See ProjectUtilCustomColumnExistInProject.
Comments
Defines all functions in the SDK interface. To initialize this structure call HPMInit. To destroy the instance of the SDK, call HPMDestroy. One SDK instance can support several sessions. All functions are thread safe. Before calling HPMDestroy make sure that you have closed all sessions
See Also
HPMInit
Initializes the SDK structure.
HPMError HPMInit(
    HPMSdkFunctions * _pSdkFunctions,
    const HPMClientSDKData * _pClientSDKData,
    const HPMSystemChar * _pLibraryPath
    );
Parameters
_pSdkFunctions
Pointer to the HPMSdkFunctions to be initialized.
_pClientSDKData
Pointer to a HPMClientSDKData. This member should be NULL if you aren't using the SDK as a client plugin.
_pLibraryPath
Absolute path to the directory where the SDK DLL's are located. If not set the application will look for the DLL's according to Windows DLL search order. Not used for client plugins.
Return Value
Returns one of the folloing errors codes. See EHPMError for more info.
| Error | Description |
|---|---|
| EHPMError_NoError | No error occurred. |
| EHPMError_DllNotFound | The SDK dll could not be found in the current path. |
| EHPMError_DllInvalid | The SDK dll did not contain the expected functions. This could be due to an old dll being used with a new SDK header file. |
Comments
You only need one HPMSdkFunctions instance for several sessions, but you can also have several HPMSdkFunctions instances if that is more convenient. For the managed and C++ wrappers, see SessionOpen.
See Also
HPMSdkFunctions, HPMDestroy, EHPMError
HPMDestroy
Unloads the SDK dll.
void HPMDestroy(
    HPMSdkFunctions * _pSdkFunctions
    );
Parameters
_pSdkFunctions
Pointer to the HPMSdkFunctions to be destroyed.
Comments
Make sure you have closed all sessions before you call this function. The managed and C++ wrappers use SessionDestroy instead.
See Also
HPMErrorToStr
Gets a descriptive string from an error code.
const char * HPMErrorToStr(
    HPMError _Error
    );
Parameters
_Error
The error to get the description of. Must be one of EHPMError.
Return Value
Returns a pointer to a string describing the error.
See Also
Release Notes
Release notes for the Helix Plan SDK.
Version 2024.202 Changes since version 2024.201
Password policy
Passwords set from the SDK must now follow the the password policy set in HPMSecurityPolicySettings
ResourceCreate
ResourceSetProperties
Errors
New error
+ EHPMError_PasswordRulesViolation
Columns
Added custom column utility
+ ProjectUtilCustomColumnExistInProject
Version 2024.201 Changes since version 2024.101
Deprecated
SDK versions prior to 10.101
- ProjectGetKanbanWallSettings
- ProjectSetKanbanWallSettings
Find
Added functionality to find tasks returned by a report
+ HPMReportFind
+ HPMReportMainGroup
+ HPMReportSubGroup
+ TaskRefReportFind
+ UtilGetReport
Project
Get project custom names
+ EHPMProjectCustomNameType
+ ProjectGetCustomName
Version 2024.101 Changes since version 11.107
Rename
Hansoft has been renamed Helix Plan and the major version number has been updated to 2024 to align with other Perforce products
UtilGetTaskInfoFromHansoftURL -> UtilGetTaskInfoFromHelixPlanURL
UtilGetHansoftURL -> UtilGetHelixPlanURL
EHPMError_InvalidHansoftPlanURL -> EHPMError_InvalidHelixPlanURL
EHPMError_NoHansoftTaskFoundInURL -> EHPMError_NoHelixPlanTaskFoundInURL
Column Permissions
Deprecated custom column permissions, use column resource permissions
- EHPMProjectCustomColumnsColumnAccessRights_SubAndMainProjectManagers
- EHPMProjectCustomColumnsColumnAccessRights_MainProjectManagers
Project Settings
Removed deprecated flag
- EHPMProjectSettingsFlag_LetResourcesChangeAgilePriorityInMyWork
Columns
Added custom column property getter
+ ProjectUtilGetCustomColumnIsHidden
Deprecated
Deprecated incomplete column utils
- UtilGetCustomColumnFromHash Use ProjectGetCustomColumn instead
- UtilGetCustomColumnIsHidden Use ProjectUtilGetCustomColumnIsHidden instead
Version 11.107 Changes since version 11.106
Column Permissions
Added FieldID to column resource permission rules
+ HPMProjectColumnResourcePermissionRule::m_FieldID
Project Settings
Deprecated HPMProjectSettings::@{EHPMProjectSettingsFlag}_LetResourcesChangeAgilePriorityInMyWork
Version 11.106 Changes since version 11.105
Linking
Added new options for the general link column on tasks
+ HPMTaskLinkedToLink::m_LinkedToSubType
+ HPMTaskLinkedToLink::m_LinkedToFrom
+ HPMTaskLinkedToLink::m_LinkNotes
+ HPMTaskLinkedToLink::m_LinkURL
Version 11.105 Changes since version 11.104
Columns
Added custom column getter
+ UtilGetCustomColumnFromHash
Version 11.104 Changes since version 11.103
Columns
Added custom column getters
+ UtilGetCustomColumnName
+ UtilGetCustomColumnType
+ UtilGetCustomColumnIsHidden
Custom settings
Added function to normalise custom settings for comparison
+ UtilNormaliseCustomSettings
Virtual session
Added virtual session with fixed impersonation
+ EHPMError_ImpersonationNotAvailableOnImpersonatedVirtualSession
+ SessionOpenVirtualImpersonated
Version 11.103 Changes since version 11.102
Column Permissions
Added a base permission definition to column resource permissions
+ HPMResourcePermissionDefinition
Version 11.102 Changes since version 11.101
Authentication
Added new methods to authenticate using Helix Authentication Service
+ GlobalGetSecurityOptions
+ HPMGlobalSecurityOptions
+ AuthenticationResolveCredentialsHelixAuth
+ HPMChangeCallbackData_AuthenticationResolveCredentialsHelixAuthUrl
Added new HPMChangeCallbackData_GlobalSecurityOptionsChanged members for the Helix Authentication options
+ HPMChangeCallbackData_GlobalSecurityOptionsChanged::@{HPMGlobalSecurityOptions}::m_bAllowUseTokenSystem
+ HPMChangeCallbackData_GlobalSecurityOptionsChanged::@{HPMGlobalSecurityOptions}::m_bAllowUseSSO
+ HPMChangeCallbackData_GlobalSecurityOptionsChanged::@{HPMGlobalSecurityOptions}::m_bSSORequired
Version 11.101 Changes since version 11.006
Column Permissions
Added column resource permissions
+ ProjectGetColumnResourcePermissionRules
+ ProjectSetColumnResourcePermissionRules
+ EHPMChangeCallbackOperation_ProjectColumnResourcePermissionRulesChange
+ HPMChangeCallbackData_ProjectColumnResourcePermissionRulesChange
+ EHPMProjectColumnResourcePermission
+ HPMResourcePermissionDefinition
+ HPMProjectColumnResourcePermissionRule
+ HPMProjectColumnResourcePermissionRules
Security
Set and get global security policy settings
+ GlobalGetSecurityPolicy
+ HPMSecurityPolicySettings
+ EHPMChangeCallbackOperation_GlobalSecurityPolicyChanged
+ HPMChangeCallbackData_GlobalSecurityPolicyChanged
Project
Add getters for project property fields
+ ProjectGetName
+ ProjectGetSortName
+ ProjectGetNiceName
+ ProjectGetProjectMethod
+ ProjectGetDefaultEditorMode
+ ProjectGetAgileTemplate
Users
Add getters for user property fields + ResourceGroupGetSortNameFromResourceGroup
+ ResourceGroupGetProjectFromResourceGroup
+ ResourceGetSortNameFromResource
+ ResourceUtilResourceIsDeleted
+ ResourceUtilResourceIsLocked
+ ResourceGetEmailFromResource
+ ResourceUtilResourceIsActiveAccount
+ ResourceUtilResourceHasAdminAccess
+ ResourceUtilResourceHasResourceAllocationAccess
+ ResourceUtilResourceHasDocumentManagementAccess
+ ResourceUtilResourceIsAuthenticationProvider
+ ResourceUtilResourceIsCredentialCheckProvider
+ ResourceUtilResourceHasAvatarManagementAccess
+ ResourceUtilResourceIsSdkChatUser
+ ResourceUtilResourceHasChatAccess
+ ResourceUtilResourceHasDashboardAccess
+ ResourceUtilResourceCanShareDashboardPages
+ ResourceUtilSdkResourceGetSyncMethod
User Groups
Add notifications for project user group add and remove
+ EHPMChangeCallbackOperation_ProjectResourceGroupAdd
+ HPMChangeCallbackData_ProjectResourceGroupAdd
+ EHPMChangeCallbackOperation_ProjectResourceGroupRemove
+ HPMChangeCallbackData_ProjectResourceGroupRemove
Version 11.006 Changes since version 11.005
Errors
New error
+ EHPMError_ConnectionAlreadyExists
Version 11.005 Changes since version 11.004
Errors
New error
+ EHPMError_TaskAllocationPerecentLimitExceed
Version 11.004 Changes since version 11.003
Locks
Added try lock mechanism
+ HPMSessionTryLock
+ SessionTryLock
+ SessionDidTryLockSucceed
Version 11.003 Changes since version 11.002
Origin
Added XML and Excel import origin
+ EHPMDataHistoryClientOrigin_XMLImport
+ EHPMDataHistoryClientOrigin_ExcelImport
Version 11.002 Changes since version 11.001
Dashboards
Added task identifiers to chart result set
+ HPMDashboardTaskIDs
+ HPMDashboardChartResultSet::m_TasksIds
Version 11.001 Changes since version 10.212
Deprecated
SDK versions prior to 10.001
Tasks
Setting task color now requires EHPMTaskColor values
Columns
Added color column
+ EHPMValueType_Enum_Color
+ EHPMProjectDefaultColumn_Color
Version 10.212 Changes since version 10.211
Authentication
Send in source to credentials resolution for token generation
+ AuthenticationResolveCredentials._pSource
Added new HPMChangeCallbackData_AuthenticationResolveCredentialsResponse members that describes the new authenticate token
+ HPMChangeCallbackData_AuthenticationResolveCredentialsResponse::m_pAuthToken
Added new user token changed notification:
+ EHPMChangeCallbackOperation_ResourceAccessTokensChanged
+ HPMChangeCallbackData_ResourceAccessTokensChanged
Added new user global security options changed notification:
+ EHPMChangeCallbackOperation_GlobalSecurityOptionsChanged
+ HPMChangeCallbackData_GlobalSecurityOptionsChanged
Version 10.211 Changes since version 10.210
Managed SDK
Fixed more incorrect UTF8 strings
Find
Possible to search for items in current sprint
+ EHPMFilterType_InCurrentSprint
+ EHPMProjectDefaultColumn_InCurrentSprint
Version 10.210 Changes since version 10.209
Group settings
Resource groups can be restricted to a specific project
+ HPMResourceGroupProperties::m_ProjectID
Version 10.209 Changes since version 10.208
Managed SDK
Fixed incorrect UTF8 strings
Version 10.208 Changes since version 10.207
Project settings
Normal resources can assign to ghost users
+ EHPMProjectSettingsFlag_ResourcesCanAssignToGhostUsers
Version 10.207 Changes since version 10.206
Strings
HPMString is now UTF8 on Windows
Version 10.206 Changes since version 10.205
Project settings
Time spent column can automatically update work remaining
+ HPMProjectSettings::m_CustomColumnHashToUpdateWorkRemaining
Version 10.205 Changes since version 10.204
User settings
Automatically add to watch list options
+ EHPMResourceGlobalSettingsFlag_EnableWatchOnItemCreation
+ EHPMResourceGlobalSettingsFlag_EnableWatchOnCommentOnItem
+ EHPMResourceGlobalSettingsFlag_AddToWatchWhenAssigned
Version 10.204 Changes since version 10.203
Java SDK
Fixed Java string memory corruption error. Programs must use the new HPMSdkJavaJNI to see the change.
Version 10.203 Changes since version 10.202
Data history
Added new history entry types
+ EHPMDataHistoryEntryType_TaskImportedFromExcel
+ EHPMDataHistoryEntryType_TaskImportedFromXml
Version 10.202 Changes since version 10.201
Boards
Support column change when changing status on item
+EHPMBoardMoveReason_StatusChanged
Version 10.201 Changes since version 10.106
Deprecated
Removed x86 support.
Managed
The .NET SDK requires install of "Microsoft Visual C++ Redistributable" on machines where the SDK application is deployed. The latest version for Visual Studio 2015, 2017 and 2019 can be downloaded here: https://aka.ms/vs/16/release/vc_redist.x64.exe
Tasks
Renamed EHPMProjectDefaultColumn_CCCommentsTo to EHPMProjectDefaultColumn_Watch
+ EHPMProjectDefaultColumn
Version 10.106 Changes since version 10.105
Global
Added a new function to get the hostname for web service URLs.
+ GlobalGetWebServiceHostname
Version 10.105 Changes since version 10.104
User settings
Show status updates for user stories / comments in Gantt.
+ EHPMResourceGlobalSettingsFlag_ShowStatusUpdatesInComments
Enable auto search in Find / Find All.
+ EHPMResourceGlobalSettingsFlag_EnableAutoSearch
Version 10.104 Changes since version 10.103
User groups
Added new functions to manage user groups (now it's possible to pass member list to group create / group edit command):
+ ResourceGroupNewCreate
+ ResourceGroupNewEdit
+ ResourceGroupNewDelete
+ ResourceGroupGetNextID
Added callbacks types and structures for new user group commands:
+EHPMChangeCallbackOperation_ResourceGroupAdded
+EHPMChangeCallbackOperation_ResourceGroupEdited
+EHPMChangeCallbackOperation_ResourceGroupDeleted
+HPMChangeCallbackData_ResourceGroupAdded
+HPMChangeCallbackData_ResourceGroupEdited
+HPMChangeCallbackData_ResourceGroupDeleted
Projects
Added new functions to manage user groups assigned to projects:
+ ProjectResourceGroupAdd
+ ProjectResourceGroupRemove
+ ProjectResourceGroupEnum
Version 10.103 Changes since version 10.102
Dashboards
HPMDashboardChartResultSetValue now returns infinity for null values.
Version 10.102 Changes since version 10.101
Java SDK
Added handling of Java modified UTF-8 strings. Programs must use the new HPMSdkJavaJNI to see the change.
Dashboards
Added the index of the dimension or measure key part.
+HPMDashboardChartResultSetValue::m_KeyIndex
Version 10.101 Changes since version 10.012
Deprecated
SDK versions prior to 8.002 Support for .NET versions older than 4.0.
Projects
Added sprint and milestone utility functions
+HPMProjectMilestones
+HPMProjectSprints
+ProjectGetMilestones
+ProjectGetSprints
Added transition flags to next workflow state information
+HPMWorkflowProgressionState::m_TransitionFlags
Added enabled actions workflow state information
+HPMEnabledAction
+HPMWorkflowProgressionState::m_nEnabledActions
+HPMWorkflowProgressionState::m_pEnabledActions
Added QA and Backlog project ID to delete project notification
+HPMChangeCallbackData_ProjectDelete::m_BacklogID
+HPMChangeCallbackData_ProjectDelete::m_QAID
Added archived status changed flag to project properties change notification
+HPMChangeCallbackData_ProjectPropertiesChange::m_bArchivedStatusChanged
Tasks
Added delegation and visibility utilities.
+TaskRefUtilHasLimitedVisibility
+TaskRefUtilIsDelegatedTo
Added to do list task ref add/delete to task assignment notification
+HPMChangeCallbackData_TaskAssignmentChange::m_ToDoTaskRefID
Added task id to task ref delete notification
+HPMChangeCallbackData_TaskRefDelete::m_TaskID
+HPMChangeCallbackData_TaskRefDelete::m_TaskRefContainerID
+HPMChangeCallbackData_TaskRefDelete::m_TaskProjectID
+HPMChangeCallbackData_TaskRefDelete::m_RealProjectID
+HPMChangeCallbackData_TaskRefDelete::m_BacklogProjectID
+HPMChangeCallbackData_TaskRefDelete::m_QAProjectID
Added the list of resources the task is assigned to to UtilGetTaskInfoFromHansoftURL
+HPMTaskInformation::m_ResourceNames
Added database ID field
+EHPMTaskField_DatabaseID
Added function to assign milestones to the list of tasks
+TaskLinkToMilestones
Added function to retrieve unique identifier of 'No release' option
+UtilGetNoMilestoneID
+TaskUtilGetEffectiveLinkedToMilestones._bReturnNoMilestoneID
Added function to retrieve the resource name of the resource that last updated a task.
+ TaskGetLastUpdatedByResourceName
Authenticate
Added new enum EHPMAuthenticationRefusedResult for representing AuthenticationResolveCredentials failed reason.
Added new HPMChangeCallbackData_AuthenticationResolveCredentialsResponse members that describes error in case AuthenticationResolveCredentials failed: +HPMChangeCallbackData_AuthenticationResolveCredentialsResponse::m_pErrorText
+HPMChangeCallbackData_AuthenticationResolveCredentialsResponse::m_bExpired
+HPMChangeCallbackData_AuthenticationResolveCredentialsResponse::m_RefusedResult
Send in context and channel name to credentials resolution
+ AuthenticationResolveCredentialsEnded._Context
+ AuthenticationResolveCredentialsEnded._pChannelName
Version control
Added resource rights utility.
+VersionControlUtilResourceHasRights
Added file id to file info utility
+HPMVersionControlFileInfo
+VersionControlUtilFileIDToFileInfo
Version 10.012 Changes since version 10.011
Columns
Added new column, available for find criteria only:
+EHPMProjectDefaultColumn_TreeLevel
Version 10.011 Changes since version 10.010
Time reporting
Added new function to create new timesheet rows for task for specific user and date.
+TimesheetCreateTaskTimeSpentRow
Tasks
Added function to retrieve WBS path of task reference.
+TaskRefGetWBSPath
Version 10.010 Changes since version 10.009
Columns
Added new column, available for backlog only:
+EHPMProjectDefaultColumn_WBS
Version 10.009 Changes since version 10.008
Comments
+HPMTaskComment::m_nMentionedUsers
+HPMTaskComment::m_pMentionedUsers
Added new parameter to TaskNotifyCommentPosted function. Now you can specify which users to notify about mention in the comment.
+TaskNotifyCommentPosted._pMentionedResources
Deprecated
SDK 10.001 and 10.002 have been deprecated. Compile your programs with a newer version of the SDK.
Version 10.008 Changes since version 10.007
Documents
Added functions to set and get the disallowed file types
+ GlobalSetDisallowedFileTypes
+ GlobalGetDisallowedFileTypes
Version 10.007 Changes since version 10.006
Tasks
Added function to get task information from a Hansoft URL
+ UtilGetTaskInfoFromHansoftURL
Version 10.006 Changes since version 10.005
Tasks
Added possibility to get and set image that is shown on task card in board
+HPMTaskAttachedDocuments::m_TaskMainImageID
Version 10.005 Changes since version 10.004
Boards
Added possibility to set card limits on element
+TaskBoardElementGetCardLimit
+TaskBoardElementSetCardLimit
Fields
New field type: +EHPMBoardElementField
Data history
Added new history entry type + EHPMDataHistoryEntryType_TaskBoardElementSettingsChanged
Added new history origin + EHPMDataHistoryOrigin_BoardChangeElementSettings
Version 10.004 Changes since version 10.003
General
Added possibility to retrieve all previous partial allocation for task
+HPMTaskOldAllocationEntry
+HPMTaskOldAllocation
+TaskGetOldPercentResourceAllocation
Version 10.003 Changes since version 10.002
Boards
Added possibility to map board columns to statuses.
+TaskBoardGetColumnToStatusMapping
+TaskBoardMapColumnToStatus
+EHPMChangeCallbackOperation_ColumnStatusMappingChanged
Fields
+EHPMTaskField_Board_ColumnToStatus
Data history
Added new history origins: +EHPMDataHistoryOrigin_BoardMapColumnToStatus
Version 10.002 Changes since version 10.001
Disposition
Added possibility to change card position in board in disposition command +EHPMTaskChangeDispositionOptionFlag_BoardPosition
+HPMTaskChangeDispositionEntry::m_ColumnID
+HPMTaskChangeDispositionEntry::m_Position
Version 10.001 Changes since version 9.208
Boards
Added boards
+TaskBoardConvertSprintToBoard
+TaskGetSprintIsBoard
+TaskBoardGetCardAttributeColumns
+TaskBoardLaneEnum
+TaskBoardLaneColumnEnum
+TaskBoardElementGetBoard
+TaskBoardElementGetName
+TaskBoardElementGetType
+TaskBoardColumnGetParentLane
+TaskBoardElementGetPosition
+TaskBoardUpdateAttributes
+TaskBoardCreateLane
+TaskBoardCreateColumn
+TaskBoardUpdateElement
+TaskBoardDeleteElement
+TaskBoardGetMembershipInfo
+TaskBoardMove
+TaskBoardHide
+TaskBoardUnhide
+TaskCheckWorkflowTransitionRequirements
Columns
Added new columns type for board's support
+EHPMProjectDefaultColumn_BoardLane
+EHPMProjectDefaultColumn_BoardColumn
Added new column's appropriate description values
+EHPMValueType_BoardLane
+EHPMValueType_BoardColumn
Fixed two criteria data types for find system
+EHPMFindCriteriaDataType_DropListWithDropList
+EHPMFindCriteriaDataType_DropListWithDate
Added new criteria data type for find system
+EHPMFindCriteriaDataType_DropListWithDropList
Find
Added new find filter
+ EHPMFilterType_AreBoards
Project
Added task assignment notifications.
+ EHPMChangeCallbackOperation_TaskAssignmentChange
+ HPMChangeCallbackData_TaskAssignmentChange
Fields
New fields
+ EHPMTaskField_LastUpdatedBy
+ EHPMTaskField_Board_Elements
+ EHPMTaskField_Board_CardAttributeColumns
+ EHPMTaskField_BoardCommit_LaneID
+ EHPMTaskField_BoardCommit_ColumnID
+ EHPMTaskField_BoardCommit_Position
+ EHPMTaskField_BoardCommit_Flags
+ EHPMTaskField_SprintIsBoard
Data history
Added new history entry types
+ EHPMDataHistoryEntryType_TaskRenameBoardLane
+ EHPMDataHistoryEntryType_TaskRenameBoardColumn
+ EHPMDataHistoryEntryType_TaskBoardLaneChanged
+ EHPMDataHistoryEntryType_TaskBoardColumnChanged
+ EHPMDataHistoryEntryType_TaskBoardLaneDeleted
+ EHPMDataHistoryEntryType_TaskBoardColumnDeleted
Added new variant decodes for new entry types
+ VariantDecode_HPMDataHistoryTaskRenameBoardElementInfo
+ VariantDecode_HPMDataHistoryTaskBoardCardInfo
+ HPMDataHistoryTaskRenameBoardElementInfo
+ HPMDataHistoryTaskBoardCardInfo
Added new history origins
+ EHPMDataHistoryOrigin_UpdateBoardAttributes
+ EHPMDataHistoryOrigin_BoardElementDelete
+ EHPMDataHistoryOrigin_BoardTasksMove
+ EHPMDataHistoryOrigin_BoardTasksHide
+ EHPMDataHistoryOrigin_BoardTasksUnhide
+ EHPMDataHistoryOrigin_SprintSetBoard
+ EHPMDataHistoryOrigin_UpdateBoardElement
+ EHPMDataHistoryOrigin_BoardRepositioning
Authentication
Send in context to credentials resolution
+ AuthenticationResolveCredentials._Context
Locks
Added read locks
+SessionReadLock
+SessionReadLockHeld
Deprecated
Using ProjectGetKanbanWallSettings and ProjectSetKanbanWallSettings is deprecated now, since Kanban mode is removed for wall.
Version 9.208 Changes since version 9.207
ResultSetTool
Fixed custom column name rendering bug
Version 9.207 Changes since version 9.206
Icons
New icons
+ EHPMListIcon_NoIcon
+ EHPMListIcon_WarningTriangleRed
+ EHPMListIcon_WarningTriangleYellow
+ EHPMListIcon_ExclamationMark
+ EHPMListIcon_Information
+ EHPMListIcon_Pause
+ EHPMListIcon_Stop
Version 9.206 Changes since version 9.205
Project
Added project setting
+ EHPMProjectSettingsFlag_CreatedSprintBacklogItemsAreUserStoriesByDefault
Documents
Added functions to set and get option if comment is required when attaching documents
+ GlobalSetDocumentAttachmentCommentRequired
+ GlobalGetDocumentAttachmentCommentRequired
+ HPMChangeCallbackData_GlobalDocumentAttachmentCommentRequiredChange
+ EHPMChangeCallbackOperation_GlobalDocumentAttachmentCommentRequiredChange
Version 9.205 Changes since version 9.204
Project
Added function to export a project as XML data
+ ProjectExportXML
Version 9.204 Changes since version 9.203
Dashboards
Added delta post action (instead of pure value chart shows difference with previous value)
+ EHPMDashboardChartPostAction
+ HPMDashboardChartMeasure::m_PostAction
Version 9.203 Changes since version 9.202
Managed
The .NET SDK requires install of "Microsoft Visual C++ 2017 Redistributable" on machines where the SDK application is deployed: https://go.microsoft.com/fwlink/?LinkId=746572
User settings
Show linebreaks for user stories / comments in Gantt
+ EHPMResourceGlobalSettingsFlag_ShowLinebreaksInList
Find
Added new find filter
+ EHPMFilterType_IsLeaf
Version 9.202 Changes since version 9.201
Columns
Added new option to allow renaming custom columns without doing it in other sub-projects + @(HPMProjectCustomColumnChanges::m_bRenameInSubprojects)
Version 9.201 Changes since version 9.109
Managed
The .NET SDK requires install of "Microsoft Visual C++ 2015 Redistributable Update 3" on machines where the SDK application is deployed: https://www.microsoft.com/en-us/download/details.aspx?id=53587
Columns
Added new type of custom column for calculated values called function column.
+ ProjectUtilPrepareFunctionColumnLocalContext
+ ProjectGetFunctionColumnExpression
+ ProjectGetFunctionColumnExpressionError
+ ProjectWaitUntilFunctionColumnCalculated
+ ProjectUtilParseLocalContextFunctionColumnExpression
+ ProjectUtilApplyLocalContextFunctionColumnChanges
+ ProjectUtilValidateLocalContextFunctionColumnExpressionChanges
+ ProjectUtilGetLocalContextFunctionColumnExpressionString
+ ProjectUtilGetLocalContextCustomColumnName
+ ProjectUtilGetLocalContextCustomColumns
+ ProjectUtilGetLocalContextFunctionColumnTokens
+ UtilDecodeStringPosition
+ UtilEncodeStringPosition
+ ProjectUtilCompareCustomColumns
+ UtilDecodeCustomColumnCalculatedValue
+ DebugSetFlags
+ EHPMProjectCustomColumnsColumnType_Function
+ EHPMProjectFunctionColumnOperator
+ EHPMProjectFunctionColumnFunction
+ EHPMProjectFunctionColumnParenthesis
+ EHPMProjectFunctionColumnToken
+ EHPMProjectField_FunctionColumnExpression
+ HPMTaskCustomSummaryValue::m_Errors
+ HPMProjectCustomColumnsColumn::m_bHidden
+ HPMCalculatedColumnValue
+ HPMProjectCustomColumnChanges
+ HPMProjectCustomColumnChange
+ HPMProjectCustomColumnMetaData
+ HPMProjectFunctionColumnLocalContext
+ HPMFunctionColumnToken
+ HPMFunctionColumnTokens
+ HPMStringPosition
+ HPMProjectFunctionColumnExpression
+ HPMProjectFunctionColumnExpressionParseResult
+ HPMProjectFunctionColumnExpressionsValidationError
+ HPMProjectFunctionColumnExpressionsValidationErrors
+ HPMChangeCallbackData_ProjectCustomColumnsChange::m_Changes
- ProjectCustomColumnsCreate Use ProjectCustomColumnsSet with HPMProjectCustomColumnChanges::m_pAdded instead.
- EHPMChangeCallbackOperation_ProjectCustomColumnsCreate
- HPMChangeCallbackData_ProjectCustomColumnsCreate
ProjectSetColumnMetaData is now only used for setting column meta data for default columns. Use ProjectCustomColumnsSet to set meta data for custom columns.
In ProjectCustomColumnsSet there is now a new interface with function column support.
Notifications
Added project id to task deleted notification.
HPMChangeCallbackData_TaskDelete::m_ProjectID
Project
New project overview text.
+ ProjectSetOverviewText
+ ProjectGetOverviewText
+ EHPMChangeCallbackOperation_ProjectOverviewTextChange
+ HPMChangeCallbackData_ProjectOverviewTextChange
+ ProjectGetAttachmentPath
Email settings
Possible to set and get the depth of parent tasks to display when tasks are mentioned inside mail message
+ HPMProjectEmailSettings::m_ParentTaskDisplayDepthForEmails
User view presets
Possible to set the depth of parent tasks to display when tasks are displayed outside of the context of the task tree
+ HPMProjectViewPreset::m_ParentTaskDisplayDepth
Task depth
Added new functions to get and set project resource parent task display depth
+ ProjectResourceGetParentTaskDisplayDepth
+ ProjectResourceSetParentTaskDisplayDepth
+ EHPMChangeCallbackOperation_ProjectResourceParentTaskDisplayDepthChange
+ HPMChangeCallbackData_ProjectResourceParentTaskDisplayDepthChange
Method templates
Added missing method templates
+ EHPMProjectAgileTemplate_Custom2
+ EHPMProjectAgileTemplate_Custom3
+ EHPMProjectAgileTemplate_Custom4
+ EHPMProjectAgileTemplate_Custom5
Timesheets
Added get function for timesheet lock. Changed signature of ProjectSetTimesheetLock
+ HPMTimesheetLock
+ ProjectGetTimesheetLock
Dashboards
Added notification that chart status has been updated
+ EHPMChartStatus
+ EHPMChangeCallbackOperation_DashboardChartStatusUpdated
+ HPMChangeCallbackData_DashboardChartStatusUpdated
+ EHPMDashboardChartPresentationSettingEnabled_StatusVisibility
+ EHPMDashboardChartStatusVisibility
+ HPMDashboardChartPresentationConfig::m_StatusVisibility
General
Return bool in wrapped SDKs for applicable functions that previously had unexpected return types
UtilTaskCommentExists
UtilGlobalReportExists
UtilProjectReportExists
UtilWorkflowObjectExists
UtilWorkflowExists
Deprecated
Removed deprecated open sub project functions. Use ProjectUtilGetBacklog and ProjectUtilGetQA instead.
- ProjectOpenBacklogProject
- ProjectOpenQAProject
Cyan wall item color no longer used in client:
EHPMTaskWallItemColor_Cyan -> EHPMTaskWallItemColor_Cyan_DEPRECATED
Next EHPMProjectWorkflowObjectFlag flags are removed, since they are not used in client anymore: EHPMProjectWorkflowObjectFlag_WorkflowStatus_LetAssignedResourcesReassign EHPMProjectWorkflowObjectFlag_WorkflowStatus_LetAssignedResourcesReassignToOriginalReporter
Removed option to set sub project path depth per project. Use HPMProjectEmailSettings::m_ParentTaskDisplayDepthForEmails to set this option for emails and HPMProjectViewPreset::m_ParentTaskDisplayDepth to set this option per use
Removed HPMDashboardChartComputationConfig::m_ShowHistoricalDataFromDate setting.
Version 9.109 Changes since version 9.108
User view presets
Added missing option flags.
+ EHPMProjectPresetShowOptionFlag_ShowPriorityInToDoList
+ EHPMProjectPresetShowOptionFlag_ShowAccumulatedTimeInToDoList
Version 9.108 Changes since version 9.107
Managed SDK
Fixed SessionDestroy memory leak. Make class IDisposable if it has members that are IDisposable
Version 9.107 Changes since version 9.106
ResultSetTool
Fixed forecasting rendering bug
Version 9.106 Changes since version 9.105
Default values
Keep track of default values in meta data
+ HPMProjectColumnMetaData::m_bHasDefaultValue
Version 9.105 Changes since version 9.104
Default values
Set default column values on task creation
+ EHPMTaskCreateOptionFlag_SetDefaultValues
Project settings
Retrieve time spent column in QA
+ HPMProjectSettings::m_CustomColumnHashForTimeSpentColumnInToDolistQA
Clone project
Clone reports
+ EHPMProjectCloneDataFlag_CloneReports
Version 9.104 Changes since version 9.103
Column meta data
Added missing encode and decode functions
+ VariantEncode_HPMResourceDefinitionList
+ VariantDecode_HPMResourceDefinitionList
Version 9.103 Changes since version 9.102
Workflows
Added new flag to workflows to hide item status in the client
+ EHPMProjectWorkflowContainerFlag_HideItemStatus
Version 9.102 Changes since version 9.101
Dashboards
Possible to manually set max and min values on vertical axis
+ EHPMDashboardChartPresentationSettingEnabled_AxisScaling
+ EHPMDashboardChartPresentationAxisScalingFlags
+ HPMDashboardAxisScaling
+ HPMDashboardChartPresentationConfig::m_AxisScaling
Custom columns
New flags for date/datetime custom columns
+ EHPMProjectCustomColumnsColumnFlag_UpdateDate_OnNotDone
+ EHPMProjectCustomColumnsColumnFlag_UpdateDate_OnInProgress
+ EHPMProjectCustomColumnsColumnFlag_UpdateDate_OnCompleted
+ EHPMProjectCustomColumnsColumnFlag_UpdateDate_OnBlocked
+ EHPMProjectCustomColumnsColumnFlag_UpdateDate_OnToBeDeleted
+ EHPMProjectCustomColumnsColumnFlag_UpdateDate_OnCommited
+ EHPMProjectCustomColumnsColumnFlag_UpdateDate_SetFirstTime
Renamed flag for date/datetime custom columns
EHPMProjectCustomColumnsColumnFlag_DefaultDateColumnsToNow -> EHPMProjectCustomColumnsColumnFlag_UpdateDate_OnNew
Flag to set if date custom columns are set on create or commit
+ EHPMTaskCreateOptionFlag
+ HPMTaskCreateUnified::m_OptionFlags
Project
Projects can now be cloned
+ HPMProjectCloneProperties
+ ProjectClone
+ EHPMChangeCallbackOperation_ProjectClone
+ EHPMDataHistoryOrigin_ProjectClone
+ ProjectClone
Version 9.101 Changes since version 9.002
Columns
Metadata added for custom columns
+ ProjectGetColumnMetaData
+ ProjectSetColumnMetaData
+ VariantDecode_HPMProjectColumnMetaData
+ EHPMProjectField_DefaultColumnMetaData
+ EHPMProjectField_CustomColumnMetaData
+ HPMProjectColumnMetaData
+ EHPMProjectColumnMetaDataFlag
+ EHPMChangeCallbackOperation_ProjectColumnMetaDataChange
+ HPMChangeCallbackData_ProjectColumnMetaDataChange
- ProjectCustomColumnsRenameTaskData - ProjectCustomColumnsDeleteTaskData
In ProjectCustomColumnsSet there is now a new parameter that you must specify when you change a custom column.
If you change a custom column so its hash changes, you need to make sure to include its old and new hash in an entry in _pHashChanges. See HPMProjectCustomColumnChangeHashes. Failure to do this will cause the data for this column to be deleted on all tasks.
This replaces the ProjectCustomColumnsRenameTaskData and ProjectCustomColumnsDeleteTaskData functions, which are now deprecated
User view presets
User view presets can now be shared.
+ ProjectCreateViewPreset
+ ProjectChangeViewPreset
+ ProjectDeleteViewPreset
+ EHPMChangeCallbackOperation_ProjectViewPresetCreate
+ HPMChangeCallbackData_ProjectViewPresetCreate
+ EHPMChangeCallbackOperation_ProjectViewPresetChange
+ HPMChangeCallbackData_ProjectViewPresetChange
+ EHPMChangeCallbackOperation_ProjectViewPresetDelete
+ HPMChangeCallbackData_ProjectViewPresetDelete
+ HPMProjectViewPreset::m_ID
+ HPMProjectViewPreset::m_CreatedBy
+ HPMProjectViewPreset::m_nShareWithUsers
+ HPMProjectViewPreset::m_pShareWithUsers
+ HPMProjectViewPreset::m_nShareWithEditRights
+ HPMProjectViewPreset::m_pShareWithEditRights
+ EHPMDataHistoryOrigin_ProjectDeleteUserViewPreset
+ EHPMDataHistoryOrigin_ProjectChangeUserViewPreset
+ EHPMDataHistoryOrigin_ProjectCreateUserViewPreset
+ EHPMProjectField_ViewPresets
+ VariantDecode_HPMProjectViewPreset
Project
Missing value
+ EHPMProjectField_NameSortValue
User settings
New meaning and name
EHPMResourceGlobalSettingsFlag_CopyResourceAndMiscOnTaskInsert -> EHPMResourceGlobalSettingsFlag_CopyMiscOnTaskInsert
Deprecated
Version 6.0 of the SDK.
- ProjectSetViewPresets
- HPMChangeCallbackData_ProjectViewPresetCreate
- EHPMChangeCallbackOperation_ProjectViewPresetsChange
- ResourceUtilCanBeDeleted
- ResourceGetDeletedDate
- ResourceGetUndeletedDate
- UtilGetResourceUndeleteTimeOut
+ HPMProjectViewPreset::m_nResources
+ HPMProjectViewPreset::m_pResources
Version 9.002 Changes since version 9.001
Columns
New columns
+ EHPMProjectDefaultColumn_LastUpdatedBy
Fields
New fields
+ EHPMTaskField_LastUpdatedBy
Task
Last update by user
+ TaskGetLastUpdatedBy
+ TaskSetLastUpdatedBy
Shares
Convert shares users.
+ ResourceReplaceGuestResourceWithHomeResource
+ ResourceMakeGuestResourceAHomeResource
+ EHPMChangeCallbackOperation_SharesUpdate
+ HPMChangeCallbackData_SharesUpdate
Find
Find now includes sub project path by default.
+ HPMFindContext::m_bSeparateSubProjectPath
Version 9.001 Changes since version 8.402
User settings
Light and dark theme setting added.
+ EHPMResourceGlobalSettingsFlag_Theme
Version 8.402 Changes since version 8.401
Java SDK
Fixed bug that could cause segmentation fault.
Version 8.401 Changes since version 8.301
Reports
It is now possible to select the order of columns in a report.
+ HPMReport::m_nColumnsOrdering
+ HPMReport::m_pColumnsOrdering
QA section
Bugs can be committed to sprints like other tasks. Multiple workflows in QA section.
+ ProjectGetBugReportResources
+ ProjectSetBugReportResources
+ ProjectGetDefaultQAWorkflow
+ ProjectSetDefaultQAWorkflow
+ ProjectGetConvertedQAWorkflow
+ EHPMChangeCallbackOperation_ProjectBugReportResourcesChange
+ HPMChangeCallbackData_ProjectBugReportResourcesChange
+ EHPMChangeCallbackOperation_ProjectDefaultQAWorkflowChange
+ HPMChangeCallbackData_ProjectDefaultQAWorkflowChange
+ EHPMProjectWorkflowContainerFlag_ShowInQA
+ EHPMProjectWorkflowContainerFlag_ShowInPlanning
+ EHPMError_DefaultQAWorkflowCannotBeDeleted
+ EHPMError_DefaultQAWorkflowMustBeVisibleInQA
+ EHPMDataHistoryOrigin_ProjectSetDefaultQAWorkflow
+ EHPMProjectField_UsersCanReportNewBugs
+ EHPMProjectField_DefaultQAWorkflow
+ EHPMProjectField_ConvertedQAWorkflow
+ VariantDecode_ProjectBugReportResources
Deprecated.
- TaskSetLinkedToSprint
- EHPMProjectSettingsFlag_EnableWorkflowsInMainProjectAndBacklog
- HPMProjectSettings::m_pWorkflowDesignation
Epics
Possible to flag items as epics.
+ EHPMDataHistoryOrigin_CommandChangeField_IsEpic
+ EHPMProjectDefaultColumn_IsEpic
+ EHPMTaskField_EpicFlag
+ TaskSetEpicFlag
+ TaskGetEpicFlag
User view presets
Possible to use user presets for item settings and set order for columns when a bug is selected in the planning section.
+ HPMProjectViewPreset::m_nQAItemSettingsColumns
+ HPMProjectViewPreset::m_pQAItemSettingsColumns
+ HPMProjectViewPreset::m_nQAItemSettingsColumnsOrder
+ HPMProjectViewPreset::m_pQAItemSettingsColumnsOrder
Find
New data typed.
+ EHPMFindCriteriaDataType_DropListWithDate
+ EHPMFindCriteriaDataType_DropListWithDropList
Data history
Missing origins.
+ EHPMDataHistoryOrigin_CommandChangeField_OriginallyCreatedOn
+ EHPMDataHistoryOrigin_BIHistory
Dashboards
Changed velocity value to floating point.
Version 8.302 Changes since version 8.301
Samples
Added SDK sample to generate dashboard data for ResultSetTool
ResultSetTool
Added presentation mode
Version 8.301 Changes since version 8.201
Dashboards
Ideal burndown line added
+ EHPMDashboardChartPresentationSettingEnabled_IdealBurndown
+ EHPMDashboardChartPresentationIdealBurndownFlags
+ HPMDashboardChartIdealBurndown
+ HPMDashboardChartPresentationConfig::m_IdealBurndown
Trend sampling
Deprecated fields
EHPMStatisticsField_ItemStatus
EHPMStatisticsField_Severity
EHPMStatisticsField_BugStatus
EHPMStatisticsField_CompletedAndInCompletedDays
EHPMStatisticsField_BudgetedWorkEarnedValue
EHPMStatisticsField_Priority
EHPMStatisticsField_Risk
EHPMStatisticsField_Confidence
EHPMStatisticsField_CustomColumn
EHPMStatisticsField_CustomStatisticsSampler
EHPMStatisticsField_PipelineTasksBuildupAndBurndown
EHPMStatisticsField_RecordedStatisticsOnDate
Columns
Missing column
+ EHPMProjectDefaultColumn_Custom
SDK project sync
In prior versions, the SDK always synced and downloaded all projects and their data from the Hansoft server. From this version it is now possible to only sync selected projects. This is done by setting the m_SDKSyncMethod user property on an SDK user. When this SDK user opens an SDK session, only the projects that the SDK user is member of are downloaded. If the SDK tries to access data in projects that are not downloaded, an error is returned.
+ HPMResourceProperties::m_SDKSyncMethod
+ HPMResourceProperties::m_ParentSDKID
+ EHPMSDKSyncMethod
+ EHPMChangeCallbackOperation_UserNotMemberOfProject
+ HPMChangeCallbackData_UserNotMemberOfProject
+ EHPMError_UserNotMemberOfProject
Deprecated
Version 5.3 and older versions of the SDK.
Version 8.201 Changes since version 8.101
SSL
Support for new Hansoft server
Dashboards
New measures
+ EHPMDashboardChartMeasureCategory_SprintAllocation
+ EHPMDashboardChartMeasureCategory_SprintCapacity
Version 8.101 Changes since version 8.002
Dashboards
Added dashboards to SDK
+ DashboardPageEnum
+ DashboardPageGetName
+ DashboardPageSetName
+ DashboardPageGetTheme
+ DashboardPageSetTheme
+ DashboardThemeEnum
+ DashboardPageGetSharedToWithViewingRights
+ DashboardPageSetSharedToWithViewingRights
+ DashboardPageGetSharedToWithEditingRights
+ DashboardPageSetSharedToWithEditingRights
+ DashboardPageDelete
+ DashboardPageCreate
+ DashboardPageIsPersonal
+ DashboardPageGetCreatedBy
+ DashboardPageGetLayout
+ DashboardPageSetLayout
+ DashboardChartEnum
+ DashboardChartCreate
+ DashboardChartDelete
+ DashboardChartSetName
+ DashboardChartSetPresentationConfig
+ DashboardChartSetComputationConfig
+ DashboardChartGetName
+ DashboardChartGetPageID
+ DashboardChartGetComputationConfig
+ DashboardChartGetPresentationConfig
+ DashboardChartGetHistoricComputationConfigs
+ DashboardChartGetLastSampledHistoricComputationConfig
+ DashboardUtilGetMeasureAutoName
+ DashboardUtilGetFilterAutoName
+ DashboardUtilColumnCanBeUsedForDimension
+ DashboardUtilIsDimensionValidForResource
+ DashboardUtilIsMeasureValidForResource
+ DashboardUtilIsFilterValidForResource
+ DashboardUtilIsComputationConfigValidForResource
+ DashboardSubscribeToChart
+ DashboardSubscriptionGetLastResultSetAsString
+ DashboardSubscriptionGetLastResultSet
+ ResourceGetDashboardPage
+ VariantDecode_HPMUntranslatedString
+ VariantDecode_HPMBinaryBuffer
+ HPMDashboardChartResultSet
+ HPMDashboardChartResultSetDimensions
+ HPMDashboardChartResultSetMeasures
+ HPMDashboardChartResultSetInfo
+ HPMDashboardChartBounds
+ HPMDashboardChartResultSetElementInfo
+ HPMDashboardChartPresentationConfig
+ HPMDashboardChartResultSetRow
+ HPMDashboardChartResultSetValue
+ HPMDashboardChartSubscription
+ HPMDashboardPageLayoutChart
+ HPMDashboardPageLayoutColumn
+ HPMDashboardPageLayout
+ HPMDashboardChartDataIdentifier
+ HPMDashboardChartItemViewConfig
+ HPMDashboardChartFilter
+ HPMDashboardChartForecastingConfig
+ HPMDashboardChartDimension
+ HPMDashboardChartMeasure
+ HPMDashboardChartComputationConfig
+ HPMDashboardChartHistoricComputationConfigs
+ HPMDashboardChartValidationResult
+ HPMDashboardThemes
+ EHPMDashboardChartMeasureBurndownType
+ EHPMDashboardChartMeasureAllocationType
+ EHPMDashboardChartMeasureTimeRange
+ EHPMDashboardChartMeasureAggregationFunction
+ EHPMDashboardChartMeasureCategory
+ EHPMDashboardChartDimensionGroupExpansion
+ EHPMDashboardChartDimensionSettingEnabled
+ EHPMDashboardChartDimensionSortDirection
+ EHPMDashboardChartDimensionSortMethod
+ EHPMDashboardChartDimensionTimeResolution
+ EHPMDashboardChartDimensionTimeRange
+ EHPMDashboardChartDimensionCategory
+ EHPMDashboardChartForcastingVelocityMethod
+ EHPMDashboardChartForcastingDateRange
+ EHPMDashboardChartFilterProjectType
+ EHPMDashboardChartFilterCategory
+ EHPMDashboardChartSortDirection
+ EHPMDashboardPageLayoutType
+ EHPMDashboardChartResultDataType
+ EHPMDashboardChartResultDataSubType
+ EHPMDashboardChartType
+ HPMDashboardChartLimit
+ EHPMDashboardChartLimitType
+ HPMDashboardChartLimitTime
+ HPMDashboardChartLimitNumericValue
+ HPMDashboardChartLimitByDataIdentifiers
+ EHPMDashboardChartOrientation
+ EHPMDashboardChartLegend
+ EHPMDashboardChartLabel
+ EHPMDashboardChartGrouping
+ EHPMDashboardChartPresentationSettingEnabled
+ HPMBinaryBuffer
+ EHPMChangeCallbackOperation_DashboardChartReceive
+ HPMChangeCallbackData_DashboardChartReceive
+ EHPMChangeCallbackOperation_DashboardChartCreate
+ HPMChangeCallbackData_DashboardChartCreate
+ EHPMChangeCallbackOperation_DashboardComputationConfigurationChange
+ HPMChangeCallbackData_DashboardComputationConfigurationChange
+ EHPMChangeCallbackOperation_DashboardPresentationConfigurationChange
+ HPMChangeCallbackData_DashboardPresentationConfigurationChange
+ EHPMChangeCallbackOperation_DashboardChartDelete
+ HPMChangeCallbackData_DashboardChartDelete
+ EHPMChangeCallbackOperation_DashboardChartNameChange
+ HPMChangeCallbackData_DashboardChartNameChange
+ EHPMChangeCallbackOperation_DashboardPageCreate
+ HPMChangeCallbackData_DashboardPageCreate
+ EHPMChangeCallbackOperation_DashboardPageNameChange
+ HPMChangeCallbackData_DashboardPageNameChange
+ EHPMChangeCallbackOperation_DashboardThemeChange
+ HPMChangeCallbackData_DashboardThemeChange
+ EHPMChangeCallbackOperation_DashboardPageLayoutChange
+ HPMChangeCallbackData_DashboardPageLayoutChange
+ EHPMChangeCallbackOperation_DashboardPageSharedToWithViewingRightsChange
+ HPMChangeCallbackData_DashboardPageSharedToWithViewingRightsChange
+ EHPMChangeCallbackOperation_DashboardPageSharedToWithEditingRightsChange
+ HPMChangeCallbackData_DashboardPageSharedToWithEditingRightsChange
+ EHPMChangeCallbackOperation_DashboardPageDelete
+ HPMChangeCallbackData_DashboardPageDelete
Version 8.002 Changes since version 7.502
Java
Changed the way Java gets data history.
DataHistoryGetHistory now returns null and does not throw an HPMSdkException with a DataNotYetAvailable when history is not yet available.
History entries
Added resources
+ HPMTaskWorkRemainingHistory::m_bHaveSetData
+ HPMTaskIdealDaysHistory::m_bHaveSetData
+ HPMTaskPointsHistory::m_bHaveSetData
Find
Data type
+ EHPMFindCriteriaDataType_CustomQueryString
Project settings
Let users import data into delegated areas
+ EHPMProjectSettingsFlag_ResourcesCanImportData
Columns
New columns
+ EHPMProjectDefaultColumn_OriginallyCreatedOnTime
+ EHPMProjectDefaultColumn_WorkflowEnterOnTime
+ EHPMProjectDefaultColumn_WorkflowEnterByUser
Ability to get the ancestry of a custom column
+ VariantDecode_HPMProjectCustomColumnAncestry
+ ProjectGetCustomColumnAncestry
+ EHPMProjectField_CustomColumnAncestry
+ HPMProjectCustomColumnAncestryEntry
+ HPMProjectCustomColumnAncestry
Fields
New fields
+ EHPMTaskField_CommentStore
+ EHPMTaskField_OriginallyCreatedOnTime
Task
Created on time
+ TaskGetOriginallyCreatedOnTime
Resource properties
New resource properties
+ EHPMResourceFlag_DashboardAccess
+ EHPMResourceFlag_DashboardCanSharePages
Version control
Non blocking init of version control
+ VersionControlInit._bBlocking
Version 7.502 Changes since version 7.106
Sprint prediction
Possible to turn off sprint prediction
+ EHPMProjectSprintPredictionMethod_NoPrediction
Disposition
Debug option
+ EHPMTaskChangeDispositionOptionFlag_AllowInvalidChanges
Release tags
Return effective release tags
+ TaskUtilGetEffectiveLinkedToMilestones
+ HPMTaskEffectiveLinkedToMilestones
+ HPMMilestoneSummary::m_Completed
+ HPMMilestoneSummary::m_DurationDays
+ HPMMilestoneSummary::m_DurationDays_NotDone
+ HPMMilestoneSummary::m_StartTime
Project settings
New sprints have no members setting
+ HPMProjectSettings::m_bNewSprintsHaveNoMembers
Errors
New errors
+ EHPMError_ServerVersionMismatch
+ EHPMError_ServerDoesNotSupportPlatform
+ EHPMError_ServerTimeMismatch
Version 7.106 Changes since version 7.105
Linux support
SDK now runs on Linux
Version 7.105 Changes since version 7.104
Object handling
Compare two objects. Not ordinarily used by end user
+ ObjectCompare
Version 7.104 Changes since version 7.103
Task status dialog
Updated look and dialog error message
+ HPMCustomTaskStatusDialogValues::m_pOptionalTextHeading
+ HPMCustomTaskStatusDialogValues::m_pOptionalText
+ EHPMCustomTaskStatusNotification_DialogEndedModalOpen
Added notifications
+ GlobalRegisterForCustomTaskStatusNotifications
+ GlobalDisplayCustomTaskStatusDialog
Deprecated
Prior versions of the custom task status dialog were deprecated.
Version 7.103 Changes since version 7.003
Mac OS X support
SDK now runs on Mac OS X
Managed SDK
Included Hansoft Managed SDK DLL's for .NET 2.0-4.5. Samples use the .NET 2.0 version to be VS 2005 compatible - just update the reference if you want a newer version.
Task status dialog
New task status dialog that can be used e.g. for version control integrations
+ EHPMChangeCallbackOperation_CustomTaskStatusNotification
+ EHPMCustomTaskStatusNotification
+ HPMChangeCallbackData_CustomTaskStatusNotification
+ HPMCustomTaskStatusDialogValues
+ GlobalCancelCustomTaskStatusDialog
+ GlobalAddTasksCustomTaskStatusDialog
Strings
New string macro for C and C++ that uses the correct prefix for HPMString, L on Windows, u8 on C++11 Mac OS X and nothing on pre C++11 Mac OS X
+ hpm_str
For C and C++ on Windows HPMChar is 2 bytes, on Mac OS X 1 byte. If C++11 is used on Mac OS X, strings are u8, UTF-8 and if C++11 is not defined, strings are a char array.
Native semaphores
Native semaphores replaced with callbacks for portability
+ HPMNeedSessionProcessCallback
+ HPMNeedSessionProcessCallbackInfo
SessionOpen._pProcessSemaphore -> SessionOpen._pNeedProcessCallback
Errors
New error
+ EHPMError_CouldNotCreateSDKInterface
Chat access
Possible to restrict chat access per resource
+ EHPMResourceFlag_ChatAccess
Project settings
Visibility in to do list
+ HPMProjectSettings::m_ColumnForPriorityInToDoList
+ HPMProjectSettings::m_CustomColumnHashForTimeSpentColumnInToDolist
Authentication
New flags
+ EHPMAuthenticationPropertiesFlag_AllowActiveDirectory
+ EHPMAuthenticationPropertiesFlag_AllowLDAP
Error messages
New error messages
+ EHPMError_CouldNotCreateSDKInterface
Refactored
Removed SSL references
EHPMSSLVerificationFlag -> EHPMCertificateVerificationFlag
HPMSSLCertificateData -> HPMCertificateData
HPMSSLSettings -> HPMCertificateSettings
HPMFunctionSessionOpen._pSSLSettings -> SessionOpen._pCertificateSettings
EHPMError_SSLConnectionRefused -> EHPMError_SecureConnectionRefused
EHPMError_SSLConnectionNotTrusted -> EHPMError_SecureConnectionNotTrusted
EHPMError_SSL -> EHPMError_Certificate
EHPMError_ServerDoesNotSupportSSL -> EHPMError_ServerDoesNotSupportSecureConnection
EHPMError_SSLSettingsNotApplicableInClientSDK -> EHPMError_CertificateSettingsNotApplicableInClientSDK
Version 7.003 Changes since version 7.002
Timeouts
Possible to set session timeouts
+ SessionSetConnectionLostTimeout
Get connection lost reason
+ SessionGetDisconnectReason
Extended error
Possible to get an extended error message from SessionOpen (currently used for certificate errors)
+ MemoryFree
+ SessionOpen._pExtendedErrorMessage
Version 7.002 Changes since version 7.001
User view presets
Possible to use user presets for item settings and set order.
+ HPMProjectViewPreset::m_nColumnsOrder
+ HPMProjectViewPreset::m_pColumnsOrder
+ HPMProjectViewPreset::m_nItemSettingsColumns
+ HPMProjectViewPreset::m_pItemSettingsColumns
+ HPMProjectViewPreset::m_nItemSettingsColumnsOrder
+ HPMProjectViewPreset::m_pItemSettingsColumnsOrder
Estimated time
Possible to display estimated time as hours.
+ EHPMProjectSettingsFlag_DisplayIdealEstimateAsHours
+ HPMProjectSettings::m_EstimatedHours
Global email settings
Possible to set and get global email settings from SDK.
+ GlobalGetEmailSettings
+ GlobalSetEmailSettings
+ HPMGlobalEmailSettings
+ EHPMChangeCallbackOperation_GlobalEmailSettingsChange
+ HPMChangeCallbackData_GlobalEmailSettingsChange
+ EHPMEmailSecurityProtocol
Timesheets
Possible to hide start and finish from timesheet reporting dialog
+ HPMTimesheetConfig::m_bHideStartFinish
Sorting
Possible to sort projects, users and user groups by user defined sort value.
+ HPMProjectProperties::m_pSortName
+ HPMResourceProperties::m_pSortName
+ HPMResourceGroupProperties::m_pSortName
Version 7.001 Changes since version 6.717
Java
Added Java as a new SDK development language.
The Java SDK wrapper is almost identical to the C++ and .NET wrappers. The SDK types are mapped to Java types like this:
HPMString=String
HPMInt32=int
HPMUInt32=int
HPMInt64=long
HPMUInt64=long
HPMUInt8=byte
HPMInt8=byte
HPMUInt16=short
HPMInt16=short
HPMFP32=float
HPMFP64=double
Note that some Java objects hold references to native allocated memory. That memory is not freed until the Java object's finalize method is called, i.e. it depends on the implementation of the JVM when that happens. These are the objects that currently hold references to native memory:
HPMSdkSession
HPMDataHistory
HPMDynamicCustomSettingsContext
HPMFindContextData
HPMFindCriteriaData
HPMNotificationSubscription
HPMRightClickContext
HPMSessionLock
HPMUntranslatedString
HPMVariantData
These objects have a dispose() method that is called by the garbage collector or when a Java SDK application exists. There is no need to call dispose() explicitely, except for HPMSessionLock where dispose() must be called when leaving the lock's scope.
Managed and CPP SDK
Added missing VersionControlDisableCallbacks
Timesheets
Timesheet functionality has been modified and updated
The timesheet get functions are emulated in the 6.7 SDK, but ResourceSetTimesheetWeekData is deprecated so be careful before you upgrade to 7.0 if you use the SDK's timesheet functions.
+ ResourceGetTimesheetDay
+ TimesheetGetDateRange
+ TimesheetRowSetActivityID
+ TimesheetRowSetProjectID
+ TimesheetRowSetTaskID
+ TimesheetRowSetStartedTime
+ TimesheetRowSetDurationTime
+ TimesheetRowSetComment
+ TimesheetRowDelete
+ EHPMTimesheetField
+ EHPMTimesheetRequestType
+ HPMTimesheetConfig::m_DefaultActivityType
+ HPMTimesheetConfig::m_DefaultStarted
+ HPMTimesheetConfig::m_DefaultFinished
+ HPMTimesheetConfig::m_DefaultDuration
+ EHPMChangeCallbackOperation_ResourceGetTimesheetDayResponse
+ HPMChangeCallbackData_ResourceGetTimesheetDayResponse
+ EHPMChangeCallbackOperation_TimesheetGetDateRangeResponse
+ HPMChangeCallbackData_TimesheetGetDateRangeResponse
+ EHPMChangeCallbackOperation_TimesheetRowChange
+ HPMChangeCallbackData_TimesheetRowChange
+ HPMTimesheetActivity
+ HPMTimesheetDay
+ HPMUniqueEnum
Authentication
Messages use untranslated strings
+ HPMDataHistoryTimePosition
+ HPMAuthenticationErrorDescriptions
HPMAuthenticationClientPluginProperties::m_pNoPasswordText
Secure connections
Support for using certificates to authenticate SDK session
+ EHPMSSLVerificationFlag
+ HPMSSLSettings
+ EHPMError_SSLConnectionRefused
+ EHPMError_SSLConnectionNotTrusted
+ EHPMError_SSL
+ EHPMError_ServerDoesNotSupportSSL
+ EHPMError_SSLSettingsNotApplicableInClientSDK
+ SessionOpen._pSSLSettings
Settings
Set comment images thumbnail dimension
+ GlobalSetCommentThumbnailDimensionInPixels
+ GlobalGetCommentThumbnailDimensionInPixels
Tasks
List assigned resources in statuses
+ HPMLastAssignedInWorkflowStatus
+ HPMLastAssignedInWorkflowStatuses
+ TaskGetLastAssignedInWorkflowStatuses
Find can search in archived projects
+ TaskFind._Flags
+ EHPMTaskFindFlag
Chat
New chat message system
+ GlobalGetChatMessageLastID
+ ResourceSetChatOnlineStatus
+ ResourceGetChatOnlineStatus
+ ResourceSetDoNotDisturb
+ ResourceGetDoNotDisturb
+ ResourceSendChatMessage
+ ResourceSetLastReadChatID
+ ResourceGetLastReadChatID
+ ChatHistoryGetHistory
+ VariantDecode_HPMChatMessage
+ HPMChatRoom
+ HPMChatMessage
+ EHPMDataHistoryEntryType_ChatHistory
+ EHPMChatOnlineStatus
+ EHPMChangeCallbackOperation_ChatMessage
+ HPMChangeCallbackData_ChatMessage
+ EHPMChangeCallbackOperation_ChatMessageLastID
+ HPMChangeCallbackData_ChatMessageLastID
+ EHPMChangeCallbackOperation_ChatMessageLastReadID
+ HPMChangeCallbackData_ChatMessageLastReadID
+ EHPMChangeCallbackOperation_ChatOnlineStatusChange
+ HPMChangeCallbackData_ChatOnlineStatusChange
+ EHPMChangeCallbackOperation_ChatHistoryReceived
+ HPMChangeCallbackData_ChatHistoryReceived
+ EHPMChangeCallbackOperation_ResourceDoNotDisturbChange
+ HPMChangeCallbackData_ResourceDoNotDisturbChange
News feed
Messages to resource groups with this flag set will show up in the news feed + EHPMResourceGroupFlag_ChatVisibleInNewsFeed
Data history
Flag to show if data has been recorded on data history entry
+ HPMDataHistoryEntry::m_bHasDataRecorded
Possible to search project history. New filter functionality to limit the number of returned data history entries.
+ EHPMProjectField
+ EHPMDataHistoryEntryKind
+ EHPMDataHistoryOrigin_ConvertProjectChangeHistory
+ EHPMDataHistoryOrigin_ProjectCreate
+ EHPMDataHistoryOrigin_ProjectChange
+ EHPMDataHistoryOrigin_ProjectSetCustomColumns
+ EHPMDataHistoryOrigin_ProjectAddCustomColumn
+ EHPMDataHistoryOrigin_ProjectOpenQA
+ EHPMDataHistoryOrigin_ProjectSetWorkflow
+ EHPMDataHistoryOrigin_ProjectEnableWorkflowsInMainProjectAndBacklog
+ EHPMDataHistoryOrigin_ProjectCreateWorkflow
+ EHPMDataHistoryOrigin_ProjectChangeWorkflow
+ EHPMDataHistoryOrigin_ProjectDeleteWorkflow
+ EHPMDataHistoryOrigin_AddResourceToProject
+ EHPMDataHistoryOrigin_CreateShare
+ EHPMDataHistoryOrigin_CreateResource
+ EHPMDataHistoryOrigin_ProjectOpenBacklog
+ EHPMDataHistoryOrigin_ProjectSetDefaultActivatedColumns
+ EHPMStatisticsField_RecordedStatisticsOnDate
+ EHPMStatisticsScope_ChatHistory
+ EHPMStatisticsScope_ProjectChangeHistory
+ EHPMDataHistoryFlag
+ EHPMDataHistoryEntryFilterFlag
+ EHPMDataHistoryFilterOperatorFlag
+ HPMDataHistoryEntryFilter
+ HPMDataHistoryFilter
+ HPMDataHistoryGetHistoryParameters
+ HPMDataHistoryEntry::m_ObjectID
+ HPMDataHistoryEntry::m_EntryKind
+ HPMDataHistory::m_DeliveredTime
+ HPMDataHistory::m_DeliveredPosition
+ HPMDataHistory::m_EarliestAvailableTime
+ HPMDataHistory::m_EarliestAvailablePosition
+ HPMDataHistory::m_LatestAvailableTime
+ HPMDataHistory::m_LatestAvailablePosition
+ VariantDecode_HPMProjectCustomColumns
+ VariantDecode_HPMProjectCustomColumnsColumn
+ VariantDecode_HPMProjectWorkflowSettings
+ VariantDecode_HPMHolidays
+ VariantDecode_HPMWorkingDays
+ VariantDecode_HPMCustomWorkingDays
+ VariantDecode_HPMWorkingHours
+ VariantDecode_HPMCustomWorkingHours
+ VariantDecode_HPMProjectDefaultColumns
+ HPMDataHistoryTimePosition
Columns
Get old project column that has been changed.
+ ProjectGetOldCustomColumn
Resource properties
New resource properties
+ EHPMResourceFlag_AvatarManagementAccess
+ EHPMResourceFlag_SdkChatUser
Version control
New version control error
+ EHPMVersionControlError_FileAreadyDeleted
Original creator recorded
+ HPMVersionControlFilem_OriginalCreator
New inherited access rights
+ HPMVersionControlAccessRights::m_bUseInheritedRights
+ HPMVersionControlAccessRights::m_nInheritedAccessRights
+ HPMVersionControlAccessRights::m_pInheritedAccessRights
Errors
New errors
+ EHPMError_SDKNotAllowedToSetAuthOrCredential
+ EHPMError_ImageFormatNotSupported
+ EHPMError_CropAreaOutOfBounds
+ EHPMError_NoVersionControlHistory
+ EHPMError_TimeZoneOrder
+ EHPMError_ServerTimedOut
+ EHPMError_CouldNotLoadImpDll
+ EHPMError_DateTimeOutOfRange
Columns
New status column
+ EHPMProjectDefaultColumn_Status
Renamed columns
EHPMProjectDefaultColumn_ResourceTag -> EHPMProjectDefaultColumn_UserTag
EHPMProjectDefaultColumn_Resources -> EHPMProjectDefaultColumn_AssignedTo
Avatars
Avatars added to resources
+ ResourceUploadAvatar
+ EHPMResourceFlag_AvatarManagementAccess
+ EHPMChangeCallbackOperation_VersionControlUploadAvatarFilesResponse
+ HPMChangeCallbackData_VersionControlUploadAvatarFilesResponse
Refactored
All flags now have the suffix Flag
EHPMVersionControlFileAttributes -> EHPMVersionControlFileAttributesFlag
EHPMVersionControlAccessRight -> EHPMVersionControlAccessRightFlag
EHPMProjectPresetShowOption -> EHPMProjectPresetShowOptionFlag
Incorrect naming
TaskUtilSprintTasksEnum -> TaskUtilSprintTaskRefEnum
EHPMReportSortGroupOrderType_Secondory -> EHPMReportSortGroupOrderType_Secondary
Deprecated
Old timesheet functionality
- ResourceGetTimesheetReport
- ResourceGetTimesheetWeekData
- ResourceSetTimesheetWeekData
- ProjectGetTimesheetReport
- TaskGetTimesheetReport
- EHPMTimesheetSectionType
- EHPMTimesheetDataType
- EHPMTimesheetTravelType
- EHPMTimesheetDecimalMode
- EHPMTimesheetOvertimeRuleDayFlag
- HPMTimesheetReportedData
- HPMTimesheetRow
- HPMTimesheetSection
- HPMTimesheetWeekData
- HPMTimesheetConfigRow
- HPMTimesheetConfigAutomaticOvertimeRule
- HPMTimesheetConfig::m_DecimalMode
- HPMTimesheetConfig::m_bCanReportProjectTime
- HPMTimesheetConfig::m_bCanReportTravel
- HPMTimesheetConfig::m_bCanReportNonProjectTime
- HPMTimesheetConfig::m_bCanWriteComment
- HPMTimesheetConfig::m_bReportHoursInHoursAndMinutes
- HPMTimesheetConfig::m_bTimeClockActive
- HPMTimesheetConfig::m_nAutomaticOvertimeRules
- HPMTimesheetConfig::m_pAutomaticOvertimeRules
- EHPMChangeCallbackOperation_ProjectGetTimesheetReportResponse
- HPMChangeCallbackData_ProjectGetTimesheetReportResponse
- EHPMChangeCallbackOperation_ResourceGetTimesheetReportResponse
- HPMChangeCallbackData_ResourceGetTimesheetReportResponse
- EHPMChangeCallbackOperation_TaskGetTimesheetReportResponse
- HPMChangeCallbackData_TaskGetTimesheetReportResponse
- EHPMChangeCallbackOperation_ResourceGetTimesheetWeekDataResponse
- HPMChangeCallbackData_ResourceGetTimesheetWeekDataResponse
- EHPMChangeCallbackOperation_ResourceTimesheetWeekDataChange
- HPMChangeCallbackData_ResourceTimesheetWeekDataChange
Task lock
- TaskSetUnlocked
- TaskGetUnlocked
Wall view text size
- EHPMProjectWallSettingsTextSize
- HPMProjectWallSettings::m_TextSize
Removed costs on resource
- HPMProjectResourceProperties::m_InternalCost
- HPMProjectResourceProperties::m_ConsultancyFee
Old deprecated priority
- TaskSetPriority
- TaskGetPriority
Version 6.717 Changes since version 6.716
Managed SDK
Fixed memory leak and possible race condition
CPP SDK
Fixed possible race condition
Version 6.716 Changes since version 6.715
Custom columns
New custom column flag
+ EHPMProjectCustomColumnsColumnFlag_DontIntheritData
Version 6.715 Changes since version 6.602
Managed and CPP SDK
Enums used instead of basic types Set default values for enums bool used for booleans
CPP SDK
Pass value by const reference Added move semantics
Workflows
New functions to make workflows easier to work with
+ UtilGetWorkflowObjectName
+ UtilGetWorkflowObjectIDFromName
+ UtilGetWorkflowName
+ UtilGetWorkflowIDFromName
+ UtilGetWorkflowType
+ UtilGetWorkflowContainerFlags
+ ProjectWorkflowGetObject
+ EHPMWorkflowReturnType
Possible to go to any workflow status on any item status change
+ HPMProjectWorkflowObject::m_WorkflowStatus_pGotoWorkflowStatusWhenItemStatusSet
+ HPMWorkflowStatusChange
Icons
New icons
+ EHPMListIcon_VeryHighPriorityBox
+ EHPMListIcon_HighPriorityBox
+ EHPMListIcon_MediumPriorityBox
+ EHPMListIcon_LowPriorityBox
+ EHPMListIcon_VeryLowPriorityBox
+ EHPMListIcon_DisabledBox
+ EHPMListIcon_Plus
Errors
New error codes
+ EHPMError_IDNoLongerExists
+ EHPMError_NotValidOnTaskWithProxy
ID no longer exist
+ EHPMChangeCallbackOperation_IDNoLongerExists
+ HPMChangeCallbackData_IDNoLongerExists
Error messages from SDK to Hansoft client
+ ProjectDisplayUserMessage
+ EHPMProjectUserMessageType
+ EHPMChangeCallbackOperation_ProjectDisplayUserMessage
+ HPMChangeCallbackData_ProjectDisplayUserMessage
Resource conversion
Notifications
+ EHPMChangeCallbackOperation_ResourcePropertiesChange
+ HPMChangeCallbackData_ResourcePropertiesChange
Data history
Detailed info on history origin
+ EHPMDataHistoryClientOrigin
+ EHPMDataHistoryOrigin
+ HPMDataHistoryEntry::m_Origin
+ HPMDataHistoryEntry::m_ClientOrigin
+ HPMDataHistoryEntry::m_pClientCustomOrigin
Last user interface action
+ EHPMTaskField_LastUserInterfaceAction
+ EHPMTaskLastUserInterfaceAction
Work remaining history
+ EHPMTaskField_WorkRemainingHistory
Missing entry types
+ EHPMDataHistoryEntryType_TaskDeleted
+ EHPMDataHistoryEntryType_TaskMoved
+ EHPMDataHistoryEntryType_TaskRenameCustomColumn
+ EHPMDataHistoryEntryType_TaskProxyCreated
+ EHPMDataHistoryEntryType_TaskProxyDeleted
+ EHPMDataHistoryEntryType_TaskRestoredFromHistory
Missing variant decodes
+ VariantDecode_HPMTaskAttachedDocuments
+ VariantDecode_HPMTaskVacationOptions
+ VariantDecode_HPMTaskCommentsOptions
+ VariantDecode_HPMTaskLinkedTo
+ VariantDecode_HPMTaskSprintResourceAllocation
+ VariantDecode_HPMDataHistoryTaskCreated
+ VariantDecode_HPMDataHistoryTaskRestoredFromHistory
+ VariantDecode_HPMDataHistoryTaskMoved
+ VariantDecode_HPMDataHistoryTaskRenameCustomColumn
+ VariantDecode_HPMDataHistoryTaskProxyCreated
+ VariantDecode_HPMDataHistoryTaskProxyDeleted
+ VariantDecode_HPMTaskTimeZones
+ HPMDataHistoryTaskCreated
+ HPMDataHistoryTaskRestoredFromHistory
+ HPMDataHistoryTaskMoved
+ HPMDataHistoryTaskProxyCreated
+ HPMDataHistoryTaskProxyDeleted
+ HPMDataHistoryTaskRenameCustomColumn
Missing variant encodes
+ VariantEncode_HPMUntranslatedString
Possible to limit data history search based on time period
+ DataHistoryGetHistory._StartTime
+ DataHistoryGetHistory._EndTime
Columns
New custom column types
+ EHPMProjectCustomColumnsColumnType_MultiSelectionDropList
+ EHPMProjectCustomColumnsColumnType_DateTimeWithTime
Column listing
+ ProjectGetDefaultAvailableColumns
+ EHPMProjectGetDefaultActivatedNonHidableColumnsFlag
New return type for UtilGetColumnDescription
+ HPMColumnDescription
Value types for columns
+ EHPMValueType
Flag to see if item is set
+ HPMColumnData::m_bFirstItemIsNotSet
Possible to store SDK data on a custom column
+ HPMProjectCustomColumnsColumnSDKData
+ HPMProjectCustomColumnsColumn::m_pSDKData
Control how date is set on custom date columns
+ EHPMProjectCustomColumnsColumnFlag
+ HPMProjectCustomColumnsColumn.m_Flags
Tasks
Move tasks between projects
+ TaskMoveProject
Move in tree can now block
+ TaskRefUtilMoveInTree._pReturn
Task field not defined
+ EHPMTaskField_Undefined
Get workflow progression based on item status
+ TaskUtilGetWorkflowProgressionFromTaskStatusChange
Enumerate all connections to/from a task ref
+ TaskRefConnectionsEnum
+ EHPMTaskConnectionFlag
Possible to restore task from change history
+ HPMTaskCreateUnifiedEntry::m_NonProxy_bRestoreFromHistory
Task creation
+ HPMTaskCreateUnifiedReference::m_bHasNonSumbittedBetween
Comments
Possible to store SDK data on a comment
+ TaskGetCommentSDKInternalData
+ TaskSetCommentSDKInternalData
+ EHPMChangeCallbackOperation_TaskCommentSDKInternalDataChange
+ HPMChangeCallbackData_TaskCommentSDKInternalDataChange
Comment edited
+ EHPMChangeCallbackOperation_TaskEditComment
+ HPMChangeCallbackData_TaskEditComment
Comment last read time added
+ TaskSetLastResourceCommentReadTime
+ TaskGetLastResourceCommentReadTime
+ EHPMChangeCallbackOperation_TaskChangeLastResourceCommentReadTime
+ HPMChangeCallbackData_TaskChangeLastResourceCommentReadTime
+ EHPMProjectDefaultColumn_LastLoggedInReadComments
Comment create
+ TaskCreateComment._pComment
- TaskCreateComment._ParentPostID
Reports
All reports now have a unique GUID
+ HPMReport::m_ReportGUID
Critical path
Searching and personal option
+ EHPMProjectDefaultColumn_IsOnCriticalPath
+ EHPMResourceGlobalSettingsFlag_HighlightTasksOnCriticalPathFlags
Vacation options
More vacation options
+ EHPMTaskVacationOptionsFlag_UnionFreeDays
+ EHPMTaskVacationOptionsFlag_UnionWorkingDays
+ EHPMTaskVacationOptionsFlag_ShortestWorkingHours
+ EHPMTaskVacationOptionsFlag_LongestWorkingHours
Language support
Hansoft language support added to SDK
+ HPMUntranslatedString
+ LocalizationTranslateString
+ LocalizationGetDefaultLanguage
+ LocalizationCreateUntranslatedStringFromString
+ LocalizationCreateUntranslatedStringFromTranslationID
+ LocalizationGetTranslationIDFromFullTranslationID
+ HPMUntranslatedStringParamListEntry
+ HPMUntranslatedStringParamList
+ EHPMError_FullIdentifierNotAvailaibleInTranslation
+ EHPMError_IdentifierNotAvailaibleInTranslation
+ UtilGetWorkflowObjectIDFromName._pLanguage
Changed string type to untranslated string
HPMHoliday::m_pName
HPMHolidays::m_pCountry
HPMProjectWorkflowObject::m_WorkflowStatus_pName
HPMProjectWorkflowStructureTask::m_pTaskDescription
Resources
Expand resource list
ResourceUtilExpandResources
Resource impersonation
Add origin to resource impersonation
+ HPMResourceImpersonate
+ ResourceImpersonate._ClientOrigin
+ ResourceImpersonate._pCustomClientOrigin
Version control
Missing functionality
+ VersionControlFileExists
+ VersionControlOperationPending
+ VersionControlCheckOutFiles._bAlwaysAskOverwrite
+ HPMChangeCallbackData_VersionControlErrorResponse::m_pCustomError
+ HPMVersionControlCheckInFiles::m_bDeleteSourceFiles
Session
Added session id to session info
+ HPMSessionInfo::m_SessionID
Debugging
Heap integrity check
+ DebugCheckHeap
Find
Data type
+ EHPMFindCriteriaDataType_UnquotedText
Flags
Added missing not set values
+ EHPMAuthenticationPropertiesFlag_None
+ EHPMAuthenticationLoginNameFlag_None
+ EHPMReportFlag_None
+ EHPMTimesheetOvertimeRuleDayFlag_None
+ EHPMChannelFlag_None
+ EHPMPacketFlag_None
+ EHPFindCriteriaFlag_None
+ EHPMProjectSettingsFlag_None
+ EHPMProjectCustomColumnsColumnFlag_None
+ EHPMProjectResourceFlag_None
+ EHPMProjectWorkflowObjectFlag_None
+ EHPMProjectWorkflowContainerFlag_None
+ EHPMProjectWallSettingsFlags_None
+ EHPMProjectPresetShowOption_None
+ EHPMProjectGetDefaultActivatedNonHidableColumnsFlag_None
+ EHPMResourceFlag_None
+ EHPMResourcePasswordFlag_None
+ EHPMResourceGlobalSettingsFlag_None
+ EHPMResourceLockFlag_None
+ EHPMTaskVacationOptionsFlag_None
+ EHPMTaskCommentFlag_None
+ EHPMTaskChangeDispositionEntryChangeFlag_None
+ EHPMTaskChangeDispositionOptionFlag_None
+ EHPMVersionControlFileAttributes_None
+ EHPMVersionControlCallbackChanged_None
+ EHPMVersionControlFileInfoFlag_None
+ EHPMVersionControlAccessRight_None
+ EHPMOptionalBoolean
C SDK
Changed return types
UtilGetColumnHash
AuthenticationResolveCredentials
GlobalGetCustomSettingsIdentifierHash
GlobalGetSDKInternalDataIdentifierHash
UtilIsIDValid
UtilIsIDTask
UtilIsIDTaskRef
UtilIsIDProject
UtilIsIDBacklogProject
UtilIsIDQAProject
UtilIsIDResource
UtilGetRealProjectIDFromProjectID
ProjectResourceUtilIsMember
ProjectUtilGetBacklog
ProjectUtilGetQA
ProjectUtilIsArchived
TaskRefUtilIsCompleted
TaskRefUtilHasChildren
TaskUtilOneTaskRefHasChildren
ResourceGroupUtilResourceGroupExists
UtilIsColumnReadOnly
ResourceUtilCanBeDeleted
TaskRefUtilCanStartNow
SDK dialogs and menus
Added dynamic updates to dialogs added by SDK
+ GlobalRegisterForDynamicCustomSettingsNotifications
+ GlobalRequestDynamicCustomSettingsValues
+ GlobalSetDynamicCustomSettingsValues
+ HPMDynamicCustomSettingsContext
+ HPMDynamicCustomSettingsValue
+ HPMDynamicCustomSettingsValues
+ HPMDynamicCustomSettingsPaths
+ HPMNotificationSubscription
+ EHPMChangeCallbackOperation_DynamicCustomSettingsNotification
+ HPMChangeCallbackData_DynamicCustomSettingsNotification
+ EHPMChangeCallbackOperation_DynamicCustomSettingsValueChanged
+ HPMChangeCallbackData_DynamicCustomSettingsValueChanged
+ EHPMChangeCallbackOperation_DynamicCustomSettingsValuesRequestResponse
+ HPMChangeCallbackData_DynamicCustomSettingsValuesRequestResponse
+ EHPMChangeCallbackOperation_CommunicationChannelsChanged
+ HPMChangeCallbackData_CommunicationChannelsChanged
SDK can add right click menu items to Hansoft client (ClientPluginCpp sample updated to demo this)
+ GlobalRegisterForRightClickNotifications
+ GlobalAddRightClickMenuItem
+ HPMRightClickContext
+ EHPMChangeCallbackOperation_RightClickDisplayTaskMenu
+ HPMChangeCallbackData_RightClickDisplayTaskMenu
+ EHPMChangeCallbackOperation_RightClickDisplayWorkflowStepMenu
+ HPMChangeCallbackData_RightClickDisplayWorkflowStepMenu
+ EHPMChangeCallbackOperation_RightClickMenuItemSelected
+ HPMChangeCallbackData_RightClickMenuItemSelected
Display custom SDK dialog
+ GlobalDisplayCustomSettingsDialog
+ GlobalCancelCustomSettingsDialog
+ EHPMDynamicCustomSettingsNotification
New custom settings type
+ EHPMCustomSettingsType_Custom
Notifications
All callbacks that have a m_ChangedByResourceID variable now also have new m_ChangedByImpersonatedResourceID variable to get impersonating resource
Object handling
Get reference count of SDK objects.
+ ObjectGetRef
Session
Possible to lock session
+ SessionLock
+ HPMSessionLock
Types
New basic type added
+ HPMUserContext
New complex type added + HPMBoolean
Utils
New existence tests
+ UtilTaskCommentExists
+ UtilGlobalReportExists
+ UtilProjectReportExists
+ UtilWorkflowObjectExists
+ UtilWorkflowExists
+ TaskUtilSprintTasksEnum
Deprecated
Ghost resource mode only available locally in client
- EHPMProjectSettingsFlag_GhostResourceModeEnabled
Refactoring
Better named functions
ProjectActiveDefaultColumnsGet -> ProjectGetDefaultActivatedColumns
ProjectActiveDefaultColumnsSet -> ProjectSetDefaultActivatedColumns
ProjectGetDefaultActivatedColumns -> ProjectGetDefaultActivatedNonHidableColumns
HPMProjectActiveDefaultColumns -> HPMProjectDefaultColumns
UtilGetColumnType -> UtilGetColumnDescription
UtilGetFindCriteriaDataTypeDecode -> UtilGetFindCriteriaDataTypeFromData
UtilGetFindCriteriaDataTypeEncode -> UtilGetFindCriteriaDataTypeFromColumn
UtilGetApplicationLanguages -> LocalizationGetLanguages
UtilGetLanguageName -> LocalizationGetLanguageName
Renamed lists to something more understandable
CriteriaDataDecode_HPMTaskFindCriteriaTypeList -> CriteriaDataDecode_HPMTaskFindCriteriaTypeDroplist
CriteriaDataDecode_HPMTaskFindCriteriaTypeConditionalList -> CriteriaDataDecode_HPMTaskFindCriteriaTypeMultiSelectDroplist
CriteriaDataEncode_HPMTaskFindCriteriaTypeList -> CriteriaDataEncode_HPMTaskFindCriteriaTypeDroplist
CriteriaDataEncode_HPMTaskFindCriteriaTypeConditionalList -> CriteriaDataEncode_HPMTaskFindCriteriaTypeMultiSelectDroplist
Version 6.602 Changes since version 6.601
Virtual sessions
Fixed problem where memory grew
Managed
Fixed memory leak that occurred when using strings.
Version 6.601 Changes since version 6.511
Deprecation
Removed deprecated functions
- TaskCreate
- TaskCreateProxies
- TaskSetLockedType
- TaskSetType
- TaskSetLinkedToPipelineTask
- TaskRefSetTreeLevel
- TaskRefSetPreviousID
- TaskRefSetPreviousWorkPriorityID
- HPMTaskCreateEntry - HPMTaskCreate - HPMTaskCreateReturn - HPMTaskCreateProxiesEntry - HPMTaskCreateProxies - HPMTaskCreateProxiesReturn - EHPMChangeCallbackOperation_TaskCreate
- EHPMChangeCallbackOperation_TaskCreateProxies
- HPMChangeCallbackData_TaskCreateTask
- HPMChangeCallbackData_TaskCreate
- HPMChangeCallbackData_TaskCreateProxiesTask
- HPMChangeCallbackData_TaskCreateProxies
Calendar
Changed functionality on vacation task check
HPMCalendarDayInfo::m_OriginatingVacationTask -> HPMCalendarDayInfo::m_bOriginatesFromVacationTask
Priority
Added individual functions for backlog, main schedule and QA
+ TaskGetBacklogPriority
+ TaskSetBacklogPriority
+ TaskGetSprintPriority
+ TaskSetSprintPriority
+ TaskGetBugPriority
+ TaskSetBugPriority
Access rules
Edit other user's reports rule
+ EHPMProjectDetailedAccessRuleFunctionType_EditOtherUsersReports
Version control
New functions
+ VersionControlUtilIsInitialized
+ VersionControlSetLocalPath
Data history
Possible to set size of local data history cache
+ DataHistorySetMaxCacheEntries
Work remaining
Work remaining is now fraction of hours. The following now use floating point. The work remaining number is now the actual amount of hours and no longer offset by one. If unset the value will be floating point infinity.
HPMTaskWorkRemainingHistoryEntry::m_nHoursRemaining
HPMTaskSummary::m_WorkRemaining
HPMTaskSummary::m_EstimatedIdealDays
HPMTaskSummary::m_EstimatedIdealDays_NotDone
HPMMilestoneSummary::m_WorkRemaining
TaskSetWorkRemaining
TaskGetWorkRemaining
Refactoring
Changed names to be in sync with GUI
ProjectResourceUserViewPresetApply -> ProjectViewPresetApply
ProjectGetUserViewPresets -> ProjectGetViewPresets
ProjectSetUserViewPresets -> ProjectSetViewPresets
TaskSetEstimatedEffort -> TaskSetEstimatedIdealDays
TaskGetEstimatedEffort -> TaskGetEstimatedIdealDays
TaskSetOwner -> TaskSetOriginallyCreatedBy
TaskGetOwner -> TaskGetOriginallyCreatedBy
TaskGetUserID -> TaskGetID
EHPMProjectDefaultColumn_EstimatedEffort -> EHPMProjectDefaultColumn_EstimatedIdealDays
EHPMProjectDefaultColumn_Owner -> EHPMProjectDefaultColumn_OriginallyCreatedBy
EHPMProjectDefaultColumn_UserID -> EHPMProjectDefaultColumn_ID
EHPMTaskField_EstimatedEffort -> EHPMTaskField_EstimatedIdealDays
EHPMTaskField_Owner -> EHPMTaskField_OriginallyCreatedBy
EHPMTaskField_UserID -> EHPMTaskField_ID
HPMTaskSummary::m_EstimatedEffort -> HPMTaskSummary::m_EstimatedIdealDays
HPMTaskSummary::m_EstimatedEffort_NotDone -> HPMTaskSummary::m_EstimatedIdealDays_NotDone
EHPMStatisticsField_EstimatedEffort -> EHPMStatisticsField_EstimatedIdealDays
EHPMStatisticsField_BacklogItemStatus -> EHPMStatisticsField_ItemStatus
EHPMStatisticsField_QABugStatus -> EHPMStatisticsField_BugStatus
EHPMChangeCallbackOperation_ProjectUserViewPresetsChange -> EHPMChangeCallbackOperation_ProjectViewPresetsChange
EHPMChangeCallbackOperation_UserViewPresetsApplied -> EHPMChangeCallbackOperation_ProjectViewPresetsApplied
HPMChangeCallbackData_ProjectUserViewPresetsChange -> HPMChangeCallbackData_ProjectViewPresetsChange
HPMChangeCallbackData_UserViewPresetsApplied -> HPMChangeCallbackData_ProjectViewPresetsApplied
HPMProjectUserViewPreset -> HPMProjectViewPreset
HPMProjectUserViewPresets -> HPMProjectViewPresets
Renamed user to resource
HPMDataHistoryEntry::m_UserID -> HPMDataHistoryEntry::m_ResourceID
HPMDataHistoryEntry::m_User -> HPMDataHistoryEntry::m_Resource
HPMChangeCallbackData_AuthenticationResolveCredentialsResponse::m_UserID -> HPMChangeCallbackData_AuthenticationResolveCredentialsResponse::m_ResourceID
HPMTaskCreateUnifiedEntry::m_NonProxy_ReuseUserID -> HPMTaskCreateUnifiedEntry::m_NonProxy_ReuseID
HPMTaskCreateEntry::m_ReuseUserID -> HPMTaskCreateEntry::m_ReuseID
HPMReport::m_UserID -> HPMReport::m_ResourceID
Impersonation
Both impersonated and real resource is shown in data history
+ HPMDataHistoryEntry::m_NonImpersonatedResourceID
+ HPMDataHistoryEntry::m_NonImpersonatedResource
Errors
New error message when the server need to be updated
+ EHPMError_NewVersionOfServerRequired
Date format
Possible to use date format from set language
+ EHPMDateFormat_FromLanguage
Statistics
New fields and scope
+ EHPMStatisticsField_PipelineTasksBuildupAndBurndown
+ EHPMStatisticsField_NoStatistics
+ EHPMStatisticsScope_NoStatisticsScope
Task field
Added missing task fields
+ EHPMTaskField_IdealDaysHistory
+ EHPMTaskField_PointsHistory
Custom column type
Added new custom column type for accumulated time
+ EHPMProjectCustomColumnsColumnType_AccumulatedTime
Resource allocation
My work registration handled under the hood
- TaskSetResourceAllocation._bDontRegisterToMyWork
Version 6.511 Changes since version 6.510
Samples
Release configuration for SimpleManaged now omits debug flag Web integration now has EHPMSdkDebugMode.Off set as default
Version 6.510 Changes since version 6.509
Managed DLLs
The SDK strongly named managed DLLs are now signed correctly.
Version 6.509 Changes since version 6.508
Variant handling
Added missing variant encode function.
+ VariantEncode_EHPMTaskStatus
Version 6.508 Changes since version 6.507
Managed DLLs
Made the SDK managed DLLs strongly named.
Version 6.507 Changes since version 6.506
Version control
Fixed bug where you were not able to use VersionControl* functions with virtual SDK sessions.
Version 6.506 Changes since version 6.020
Notifications
Added id of resource that initiated change to all notifications
Time sheets
Added Hansoft time sheets to the SDK
+ ResourceGetTimesheetReport
+ ResourceGetTimesheetWeekData
+ ResourceSetTimesheetWeekData
+ ResourceTimesheetPeriodDataDelete
+ ProjectGetTimesheetReport
+ ProjectSetTimesheetLock
+ TaskGetTimesheetReport
+ GlobalSetTimesheetConfig
+ GlobalGetTimesheetConfig
+ EHPMChangeCallbackOperation_ProjectGetTimesheetReportResponse
+ EHPMChangeCallbackOperation_ResourceGetTimesheetReportResponse
+ EHPMChangeCallbackOperation_TaskGetTimesheetReportResponse
+ EHPMChangeCallbackOperation_ResourceGetTimesheetWeekDataResponse
+ EHPMChangeCallbackOperation_ResourceTimesheetPeriodDataDelete
+ EHPMChangeCallbackOperation_ProjectTimesheetLockChange
+ EHPMChangeCallbackOperation_ResourceTimesheetWeekDataChange
+ EHPMChangeCallbackOperation_GlobalTimesheetConfigChange
+ HPMChangeCallbackData_ProjectGetTimesheetReportResponse
+ HPMChangeCallbackData_ResourceGetTimesheetReportResponse
+ HPMChangeCallbackData_TaskGetTimesheetReportResponse
+ HPMChangeCallbackData_ResourceGetTimesheetWeekDataResponse
+ HPMChangeCallbackData_ResourceTimesheetPeriodDataDelete
+ HPMChangeCallbackData_ProjectTimesheetLockChange
+ HPMChangeCallbackData_ResourceTimesheetWeekDataChange
+ HPMChangeCallbackData_GlobalTimesheetConfigChange
+ HPMChangeCallbackData_TimesheetReportedDay
+ HPMChangeCallbackData_TimesheetPost
+ EHPMTimesheetDecimalMode
+ EHPMTimesheetOvertimeRuleDayFlag
+ EHPMTimesheetSectionType
+ EHPMTimesheetDataType
+ EHPMTimesheetTravelType
+ HPMTimesheetReportedData
+ HPMTimesheetRow
+ HPMTimesheetSection
+ HPMTimesheetWeekData
+ HPMTimesheetConfigRow
+ HPMTimesheetConfigAutomaticOvertimeRule
+ HPMTimesheetConfig
Language
Added language support
+ ResourceSetPreferredLanguage
+ ResourceGetPreferredLanguage
+ ResourceSetLastUsedLanguage
+ ResourceGetLastUsedLanguage
+ ResourceGetEffectiveLanguage
+ UtilGetApplicationLanguages
+ UtilGetLanguageName
+ EHPMChangeCallbackOperation_ResourcePreferredLanguageChange
+ EHPMChangeCallbackOperation_ResourceLastUsedLanguageChange
+ EHPMChangeCallbackOperation_ProjectViewPresetsApplied
+ HPMChangeCallbackData_ResourcePreferredLanguageChange
+ HPMChangeCallbackData_ResourceLastUsedLanguageChange
+ HPMChangeCallbackData_ProjectViewPresetsApplied
User view presets
Added support for user view presets
+ ProjectViewPresetApply
+ ProjectGetViewPresets
+ ProjectSetViewPresets
+ EHPMChangeCallbackOperation_ProjectViewPresetsChange
+ HPMChangeCallbackData_ProjectViewPresetsChange
+ EHPMProjectPresetShowOption
+ HPMProjectViewPresets
+ HPMProjectViewPreset
Archive
Added support for archiving sub projects.
+ TaskSetArchived
+ TaskGetArchived
+ EHPMTaskField_Archived
+ EHPMProjectDefaultColumn_IsArchived
+ EHPMFilterType_IsArchived
Undelete resource
Support for undeletion of users
+ ResourceGetDeletedDate
+ ResourceGetUndeletedDate
+ ResourceUtilCanBeDeleted
+ UtilGetResourceUndeleteTimeOut
Calendar
Added compensated holidays
+ HPMCalendarDayInfo::m_bCompensatedHoliday
Task checks
Added check if tasks can be started and are ongoing
+ TaskRefUtilCanStartNow
+ EHPMFilterType_CanStartNow
+ EHPMFilterType_IsOngoingWork
+ EHPMProjectDefaultColumn_CanStartNow
+ EHPMProjectDefaultColumn_IsOngoingWork
Removed
- EHPMFilterType_AreAgileTasks
Detailed access rules
Refactored
EHPMProjectDetailedAccessRuleFunctionType_ShareReportTemplates -> EHPMProjectDetailedAccessRuleFunctionType_ShareReports
Removed
- EHPMProjectDetailedAccessRuleFunctionType_ReportBugsInAllBugsInProjectView
Agile tasks
Removed
- EHPMTaskLockedType_AgileTaskItem
Version control info
Added id for version control info
+ EHPMVersionControlVersionActionInfo
+ HPMVersionControlFileHistoryEntry::m_ActionInfoID
+ HPMVersionControlFileHistoryEntry::m_pActionInfoArg
Columns
Changed type on column id
+ HPMColumn::m_ColumnID HPMInt32 -> HPMUInt32
History entries
Added resources
+ HPMResourceAllocationHistoryEntry
+ HPMTaskWorkRemainingHistoryEntry::m_bResourcesValid
+ HPMTaskWorkRemainingHistoryEntry::m_nResourceAllocationEntries
+ HPMTaskWorkRemainingHistoryEntry::m_pResourceAllocationEntries
+ HPMTaskIdealDaysHistoryEntry::m_bResourcesValid
+ HPMTaskIdealDaysHistoryEntry::m_nResourceAllocationEntries
+ HPMTaskIdealDaysHistoryEntry::m_pResourceAllocationEntries
+ HPMTaskPointsHistoryEntry::m_bResourcesValid
+ HPMTaskPointsHistoryEntry::m_nResourceAllocationEntries
+ HPMTaskPointsHistoryEntry::m_pResourceAllocationEntries
Working directory
Added possibility to set a working directory
+ EHPMError_WorkingDirectoryNotAvailableInClientSDK
+ SessionOpen._pWorkingDirectory
Library directory
Added possibility to set a library directory
+ HPMInit._pLibraryPath
Samples
Updated ClientPluginCpp sample to open native window when notification is received
Version 6.020 Changes since version 6.005
Kanban
Added SDK support for new Kanban functionality
+ ProjectGetKanbanWallSettings
+ ProjectSetKanbanWallSettings
+ HPMProjectWorkflowObject::m_TaktTimeDays
+ HPMProjectWorkflowObject::m_TaktTimeHours
+ HPMProjectWorkflowObject::m_MaxWIPItems
Calendar
Added SDK support for calendar settings
+ ProjectCalendarGetWorkingDays
+ ProjectCalendarSetWorkingDays
+ ProjectCalendarGetCustomWorkingDays
+ ProjectCalendarSetCustomWorkingDays
+ ProjectCalendarGetWorkingHours
+ ProjectCalendarSetWorkingHours
+ ProjectCalendarGetCustomWorkingHours
+ ProjectCalendarSetCustomWorkingHours
+ ProjectCalendarGetHolidays
+ ProjectCalendarSetHolidays
+ ProjectGetCalendarDayInfo
+ HPMWorkingDays
+ HPMCustomWorkDay
+ HPMCustomWorkingDays
+ HPMCustomWorkHoursDay
+ HPMCustomWorkingHours
+ HPMWorkingHours
+ HPMHoliday
+ HPMHolidayYear
+ HPMHolidays
+ HPMCalendarDayInfo
+ EHPMChangeCallbackOperation_CalendarChangeHoliday
+ EHPMChangeCallbackOperation_CalendarChangeCustomWorkingHours
+ EHPMChangeCallbackOperation_CalendarChangeWorkingHours
+ EHPMChangeCallbackOperation_CalendarChangeCustomWorkingDays
+ EHPMChangeCallbackOperation_CalendarChangeWorkingDays
+ HPMChangeCallbackData_CalendarChangeHolidays
+ HPMChangeCallbackData_CalendarChangeCustomWorkingHours
+ HPMChangeCallbackData_CalendarChangeWorkingHours
+ HPMChangeCallbackData_CalendarChangeCustomWorkingDays
+ HPMChangeCallbackData_CalendarChangeWorkingDays
Authentication
Minor changes to resolve authentication functionality
+ AuthenticationResolveCredentials._pSessionIDs
+ AuthenticationResolveCredentials._pResult
- AuthenticationResolveCredentialsEnded._pChannelName
- AuthenticationResolveCredentialsEnded._UserID
- AuthenticationResolveCredentialsEnded._pErrorMessage
+ @HPMCommunicationChannelProperties}::m_Flags
+ HPMCredentialResolutionSessionIDsEnum
+ EHPMChangeCallbackOperation_AuthenticationResolveCredentialsResponse
+ HPMChangeCallbackData_AuthenticationResolveCredentialsResponse
Burndowns
Added ideal days and points burndown support
+ TaskSetIdealDaysHistory
+ TaskGetIdealDaysHistory
+ TaskEnumIdealDaysHistoryDays
+ TaskSetPointsHistory
+ TaskGetPointsHistory
+ TaskEnumPointsHistoryDays
+ EHPMStatisticsScope_Milestone
+ EHPMChangeCallbackOperation_TaskChangeIdealDaysHistory
+ EHPMChangeCallbackOperation_TaskChangePointsHistory
+ HPMChangeCallbackData_TaskChangePointsHistory
+ HPMChangeCallbackData_TaskChangeIdealDaysHistory
+ HPMTaskIdealDaysHistoryEntry
+ HPMTaskIdealDaysHistory
+ HPMTaskPointsHistoryEntry
+ HPMTaskPointsHistory
+ HPMTaskHistoryDaysEnum
+ HPMMilestoneSummary::m_IdealDays
+ HPMMilestoneSummary::m_IdealDays_NotDone
+ HPMMilestoneSummary::m_Points
+ HPMMilestoneSummary::m_Points_NotDone
+ HPMMilestoneSummary::m_WorkRemaining
Resource
Added new resource setting flags
+ EHPMResourceGlobalSettingsFlag_RightAlignItemText
+ EHPMResourceGlobalSettingsFlag_ShowPastSprintsMilestonesInDropdown
Custom column
Added encoding of resources for resource custom column
+ UtilEncodeCustomColumnResourcesValue
Debug
Added new debug mode.
+ EHPMSdkDebugMode
Samples
Added Web Integration QA Sample. This is an example of how to write an SDK integration with Hansoft, specifically how to write a Hansoft web frontend.
Version 6.005
Changes since version 5.311:
Session pool
Added SDK session pool
+ SessionOpenVirtual
Session handling
Get information from session.
+ SessionGetInfo
+ HPMSessionInfo
Resource handling
Added function to get impersonating resource.
+ ResourceGetImpersonate
Added resource lock mechanism.
+ ResourceGetLockFlags
+ ResourceChangeLockFlags
+ EHPMResourceLockFlag + EHPMChangeCallbackOperation_ResourceLockFlagsChange
+ HPMChangeCallbackData_ResourceLockFlagsChange
Resources can be from remote database.
+ HPMResourceProperties::m_RemoteID
+ HPMResourceProperties::m_pRemoteGUID
Project handling
Added new custom priority column handling.
+ ProjectGetAgilePriorityCustomColumn
+ ProjectSetAgilePriorityCustomColumn
+ EHPMChangeCallbackOperation_ProjectAgilePriorityCustomColumnChange
+ HPMChangeCallbackData_ProjectAgilePriorityCustomColumnChange
+ EHPMProjectSettingsFlag_LetResourcesChangeAgilePriorityInMyWork
Added function to get a custom column from a hash.
+ ProjectGetCustomColumn
Added function to get the columns that are always activated in a project.
+ ProjectGetDefaultActivatedColumns
Task handling
Added functions for the new agile priority.
+ TaskGetAgilePriorityCategory
+ TaskSetAgilePriorityCategory
+ TaskUtilUpdateAgilePriority
+ EHPMTaskAgilePriorityCategory
+ EHPMTaskField_SprintPriority
+ EHPMTaskField_BacklogPriority
+ EHPMTaskField_BugPriority
Added function to get summary values for a milestone.
+ TaskRefGetMilestoneSummary
Added new summaries.
+ HPMTaskSummary::m_AssignedUncompleted
+ HPMTaskSummary::m_ComplexityPoints_NotDone
+ HPMTaskSummary::m_EstimatedEffort_NotDone
+ HPMTaskSummary::m_DurationDays
+ HPMTaskSummary::m_DurationDays_NotDone
+ HPMMilestoneSummary
Removed in favor of HPMResourceDefinitionList.
- HPMTaskDelegateTo
- HPMTaskVisibleTo
Version control
File id used instead of file path.
+ VersionControlUtilPathToFileID
+ VersionControlUtilFileIDToPath
+ HPMChangeCallbackData_VersionControlErrorResponse::m_FileID
Refactored.
HPMTaskAttachedDocumentsEntry::m_pFileName -> HPMTaskAttachedDocumentsEntry::m_FileID
Check if file was force reverted.
+ HPMVersionControlRevertFiles::m_bForceRevert
+ HPMChangeCallbackData_VersionControlCheckInFilesResponse::m_bForceReverted
Authentication
Added new authentication functionality.
+ CommunicationChannelEnum
+ AuthenticationClientProtocolEnded
+ AuthenticationIntegrationProtocolEnded
+ AuthenticationResolveCredentials
+ AuthenticationResolveCredentialsEnded
+ EHPMPacketDropReason
+ EHPMChannelRegisterFailReason
+ EHPMChangeCallbackOperation_AuthenticationProtocolBegin
+ EHPMChangeCallbackOperation_CommunicationChannelPacketReceived
+ EHPMChangeCallbackOperation_CommunicationChannelPacketDropped
+ EHPMChangeCallbackOperation_AuthenticationResolveCredentials
+ EHPMChangeCallbackOperation_CommunicationChannelRegisterFailed
+ HPMChangeCallbackData_AuthenticationProtocolBegin
+ HPMChangeCallbackData_CommunicationChannelPacketReceived
+ HPMChangeCallbackData_CommunicationChannelPacketDropped
+ HPMChangeCallbackData_CommunicationChannelRegisterFailed
+ HPMChangeCallbackData_AuthenticationResolveCredentials
+ EHPMResourceFlag_AuthenticationProvider
+ EHPMResourceFlag_CredentialCheckProvider
+ EHPMResourcePasswordFlag_PasswordDisabled
Refactored.
ClientAuthenticationMethodRegister -> AuthenticationClientPluginRegister
ClientAuthenticationMethodUnregister -> AuthenticationClientPluginUnregister
Column handling
New column utilities functions.
+ UtilGetColumnType
+ UtilColumnToTaskField
+ UtilTaskFieldToColumn
+ UtilGetColumnDataItemFormatted
+ UtilIsColumnReadOnly
+ UtilGetColumnData
+ HPMColumnData
+ HPMCustomColumnInfo
New default columns.
+ EHPMProjectDefaultColumn_SprintPriority
+ EHPMProjectDefaultColumn_BacklogPriority
+ EHPMProjectDefaultColumn_BugPriority
Errors
New errors.
+ EHPMError_InvalidSessionKeySize
+ EHPMError_InvalidIdentifier
+ EHPMError_SessionPoolNotInitialized
+ EHPMError_SessionPoolSessionNotAvailable
+ EHPMError_SessionPoolNotAllowed
+ EHPMError_SessionPoolNotAvailableInClientSDK
+ EHPMError_LoginDisabled
+ EHPMError_Partitioned
+ EHPMLicenseViolationReason_CannotChangeDeletedResource
+ EHPMLicenseViolationReason_CannotUndeleteADeletedResource
Version 5.311
Changes since version 5.310:
Samples
Updated samples to use new TaskCreateUnified.
Version 5.310
Changes since version 5.309:
Bug fix
EHPMChangeCallbackOperation_DataHistoryReceived callback was not sent.
Version 5.309
Changes since version 5.308:
Major New Features
To avoid possible corruption the way tasks are created and how you change their disposition has been changed.
+ TaskCreateUnified
+ TaskChangeDisposition
+ TaskSetFullyCreated
+ TaskGetFullyCreated
+ EHPMChangeCallbackOperation_TaskCreateUnified
+ EHPMChangeCallbackOperation_TaskChangeDisposition
Refactored.
TaskSetCreatedByPipelineTask -> TaskSetLinkedToPipelineTask
TaskGetCreatedByPipelineTask -> TaskGetLinkedToPipelineTask
Changed behavior. Now only works for QA project.
TaskSetLinkedToSprint
Deprecated functions.
TaskSetLinkedToPipelineTask
TaskCreateProxies
TaskRefSetPreviousWorkPriorityID
TaskRefSetPreviousID
TaskRefSetTreeLevel
TaskSetType
TaskSetLockedType
TaskCreate
Version 5.308
Changes since version 5.306:
Minor New Features
Added support for getting summary values for top level/header tasks.
+ TaskRefGetSummary
+ HPMTaskSummary
+ HPMTaskCustomSummaryValue
Version 5.306
Changes since version 1.205:
Major New Features
The SDK now has functionality for Reports and Workflows/Pipelines. It is possible to do a find from the SDK.
Samples
Added CustomSettingsManaged to demonstrate how to make custom client dialogs for settings with the SDK.
Reports
Added support for reports
+ GlobalGetReports
+ GlobalSetReports
+ ProjectGetReport
+ ProjectGetReports
+ ProjectSetReports
+ ProjectEnumReportResources
+ UtilConvertFindStringToReport
+ EHPMReportViewType
+ EHPMReportFlag
+ EHPMReportSortGroupOrderType
+ EHPMFindCriteriaType
+ EHPMFindCriteriaDataType
+ EHPMFindCriteriaOperator
+ EHPMFindCriteriaConnectionSite
+ EHPFindCriteriaFlag
+ EHPMCustomChoiceValueType_GlobalReport
+ EHPMCustomChoiceValueType_Report
+ HPMReportEmailProperties
+ HPMReportSortGroupProperties
+ HPMReport
+ HPMReports
+ EHPMChangeCallbackOperation_ProjectReportsChange
+ EHPMChangeCallbackOperation_GlobalReportsChange
+ HPMChangeCallbackData_ProjectReportsChange
+ HPMChangeCallbackData_GlobalReportsChange
+ UtilGetFindCriteriaDataTypeDecode
+ UtilGetFindCriteriaDataTypeEncode
+ CriteriaDataDecode_HPMTaskFindCriteriaTypeText
+ CriteriaDataDecode_HPMTaskFindCriteriaTypeInteger
+ CriteriaDataDecode_HPMTaskFindCriteriaTypeFloat
+ CriteriaDataDecode_HPMTaskFindCriteriaTypeGeneralCondition
+ CriteriaDataDecode_HPMTaskFindCriteriaTypeDate
+ CriteriaDataDecode_HPMTaskFindCriteriaTypeList
+ CriteriaDataDecode_HPMTaskFindCriteriaTypeConditionalList
+ CriteriaDataEncode_HPMTaskFindCriteriaTypeText
+ CriteriaDataEncode_HPMTaskFindCriteriaTypeInteger
+ CriteriaDataEncode_HPMTaskFindCriteriaTypeFloat
+ CriteriaDataEncode_HPMTaskFindCriteriaTypeGeneralCondition
+ CriteriaDataEncode_HPMTaskFindCriteriaTypeDate
+ CriteriaDataEncode_HPMTaskFindCriteriaTypeList
+ CriteriaDataEncode_HPMTaskFindCriteriaTypeConditionalList
+ HPMFindCriteriaDataListItem
+ HPMFindCriteriaData
+ HPMFindCriteriaConnection
+ HPMFindCriteria
+ HPMFindCriteriaDataHeader
+ HPMFindCriteriaTypeText
+ HPMFindCriteriaTypeInteger
+ HPMFindCriteriaTypeFloat
+ HPMFindCriteriaTypeGeneralCondition
+ HPMFindCriteriaTypeDate
+ HPMFindCriteriaTypeList
+ HPMFindCriteriaTypeConditionalList
Workflows/Pipelines
Added support for workflows and pipelines. Functionality that dealt with QA workflows has been updated to be general.
+ TaskSetWorkflow
+ TaskGetWorkflow
+ TaskSetDefaultWorkflow
+ TaskGetDefaultWorkflow
+ TaskPipelineGetTaskRef
+ TaskGetLastAssignedInWorkflowStatus
+ TaskGetLastEnterWorkflowStatus
+ TaskGetLastExitWorkflowStatus
+ TaskSetCreatedByPipelineTask
+ TaskGetCreatedByPipelineTask
+ TaskSetCreatedPipelineTasks
+ TaskGetCreatedPipelineTasks
+ TaskSetCreatedFromWorkflowObject
+ TaskGetCreatedFromWorkflowObject
+ TaskUtilGetWorkflowProgression
+ TaskUpdatePipelineWorkflowToNewestVersion
+ TaskSetWorkflowStatus._bDoAutoAssignments
+ ProjectUtilGetWorkflowProgression
+ ProjectGetWorkflowStatusStats
+ ProjectUtilGetWorkflowStructure
+ HPMWorkflowObjectIdentifier
+ HPMWorkflowStatusTransitInfo
+ HPMWorkflowProgressionState
+ HPMWorkflowProgressionStructure
+ HPMProjectWorkflowObject::m_WorkflowStatus_nDefaultTaskValues
+ HPMProjectWorkflowObject::m_WorkflowStatus_pDefaultTaskValues
+ HPMProjectWorkflowObject::m_WorkflowStatus_SelectedWorklfowID
+ HPMProjectWorkflowSettings::m_Identifier
+ HPMProjectWorkflowSettings::m_NewestWorkflowVersionID
+ HPMProjectWorkflowSettings::m_Flags
+ HPMProjectWorkflowSettings::m_Properties
+ HPMProjectWorkflowSettings::m_CreatedByResource
+ HPMProjectWorkflowSettings::m_ResourceList
+ HPMProjectWorkflowEnum
+ HPMProjectWorkflowObjectEnum
+ HPMProjectWorkflowStructureTask
+ HPMProjectWorkflows
+ HPMProjectWorkflowStructure
+ HPMProjectWorkflowStatusStats
+ HPMProjectWorkflowEnumWorkflowProperties
+ HPMProjectWorkflowEnumObjectProperties
+ HPMProjectSettings::m_pWorkflowDesignation
+ HPMProjectSettings::m_pWorkflowDesignation
+ EHPMTaskField_Workflow
+ EHPMTaskField_CreatedByPipelineTask
+ EHPMTaskField_CreatedPipelineTasks
+ EHPMTaskField_CreatedFromWorkflowObject
+ EHPMTaskField_DefaultWorkflow
+ EHPMProjectSettingsFlag_EnableWorkflowsInMainProjectAndBacklog
+ EHPMChangeCallbackOperation_ProjectWorkflowCreate
+ EHPMChangeCallbackOperation_ProjectWorkflowDelete
+ EHPMChangeCallbackOperation_ProjectWorkflowStatusStatsChange
+ EHPMChangeCallbackOperation_ProjectWorkflowNewVersion
+ EHPMChangeCallbackOperation_TaskUpdatePipelineWorkflowToNewestVersion
+ EHPMChangeCallbackOperation_GlobalWorkflowsDeleted
+ EHPMChangeCallbackOperation_TaskLastExitWorkflowStatusChange
+ EHPMChangeCallbackOperation_TaskLastEnterWorkflowStatusChange
+ EHPMChangeCallbackOperation_TaskLastAssignedInWorkflowStatusChange
+ HPMChangeCallbackData_ProjectWorkflowChange
+ HPMChangeCallbackData_ProjectWorkflowCreate
+ HPMChangeCallbackData_WorkflowUpdateData
+ HPMChangeCallbackData_ProjectWorkflowDelete
+ HPMChangeCallbackData_WorkflowsDeletedData
+ HPMChangeCallbackData_GlobalWorkflowsDeleted
+ HPMChangeCallbackData_ProjectWorkflowNewVersion
+ HPMChangeCallbackData_FieldUpdateData
+ HPMChangeCallbackData_TaskUpdateData
+ HPMChangeCallbackData_TaskUpdatePipelineWorkflowToNewestVersion
+ HPMChangeCallbackData_TaskLastExitWorkflowStatusChange
+ HPMChangeCallbackData_TaskLastEnterWorkflowStatusChange
+ HPMChangeCallbackData_TaskLastAssignedInWorkflowStatusChange
+ EHPMProjectDetailedAccessRuleFunctionType_OverrideWorkflow
+ EHPMProjectWorkflowEnumObjectType
+ EHPMProjectWorkflowEnumWorkflowType
+ EHPMWorkflowType
+ EHPMProjectWorkflowContainerFlag
Refactored QA workflow to general workflow.
HPMProjectQAWorkflowObject -> HPMProjectWorkflowObject
HPMProjectQAWorkflowRequiredField -> HPMProjectWorkflowRequiredField
HPMProjectQAWorkflowConnection -> HPMProjectWorkflowConnection
HPMProjectQAWorkflowSettings -> HPMProjectWorkflowSettings
ProjectGetQAWorkflowSettings -> ProjectWorkflowGetSettings
ProjectSetQAWorkflowSettings -> ProjectWorkflowSetSettings
EHPMProjectQAWorkflowObjectType -> EHPMProjectWorkflowObjectType
EHPMProjectQAWorkflowObjectFlag -> EHPMProjectWorkflowObjectFlag
EHPMProjectQAWorkflowConnectionSite -> EHPMProjectWorkflowConnectionSite
EHPMProjectQAWorkflowRequiredFieldType -> EHPMProjectWorkflowRequiredFieldType
EHPMTaskField_QAStatus -> EHPMTaskField_WorkflowStatus
TaskGetQAStatus -> TaskGetWorkflowStatus
TaskSetQAStatus -> TaskSetWorkflowStatus
EHPMChangeCallbackOperation_ProjectQAWorkflowChange -> EHPMChangeCallbackOperation_ProjectWorkflowChange
Task tree
Added functionality for the task tree.
+ @TaskRefUtilEnumChildren}
+ @TaskRefUtilEnumPipelineProgression}
+ @TaskRefUtilGetParent}
+ @TaskRefUtilGetNext}
+ @TaskRefUtilGetNextSibling}
+ @TaskRefUtilGetPrevSibling}
+ @TaskRefUtilGetNextAtSameOrLowerLevel}
+ @TaskRefUtilGetPrevAtSameOrLowerLevel}
+ @TaskRefUtilMoveInTree}
+ @TaskRefUtilTraceTree}
+ @TaskRefUtilIsCompleted}
+ @TaskRefUtilHasChildren}
+ @TaskUtilOneTaskRefHasChildren}
Find
Added find functionality.
+ UtilPrepareFindContext
+ UtilUpdateFindContext
+ TaskFind
+ TaskRefUtilIsInFindContext
+ UtilConvertReportToFindString
+ HPMFindCondition
+ HPMFindContextData
+ HPMFindContext
+ EHPMFilterType
+ EHPMFindSelectionType
+ EHPMResourceGlobalSettingsFlag_SymbolicFindOperators
Task handling
Added function to get the text representation of a column for a text reference
+ TaskRefGetColumnText
+ HPMColumnTextOptions
Added functionality to get connected tasks in a container
+ TaskEnumConnections
+ HPMTaskConnectionEnum
Added function to get sub project path
+ TaskRefUtilGetSubProjectPath
Added parameters to control auto assignments and auto completion
+ EHPMTaskSetStatusFlag
+ TaskSetStatus._bGotoWorkflowStatusWhenCompleted
+ TaskSetStatus._SetStatusFlags
+ TaskSetCustomColumnData._Flags
+ TaskSetResourceAllocation._bGotoWorkflowStatusWhenAssigned
+ TaskSetResourceAllocation._SetStatusFlags
Removed Completed by parameter - TaskSetCompleted._pCompletedBy
Added total duration field
+ EHPMTaskField_TotalDuration
Refactored status deferred to blocked
EHPMTaskStatus_Deferred -> EHPMTaskStatus_Blocked
Refactored EHPMTaskConnectionType name
EHPMTaskConnectionType_GanttConnectionType_EndToStart -> EHPMTaskConnectionType_EndToStart
EHPMTaskConnectionType_GanttConnectionType_EndToEnd -> EHPMTaskConnectionType_EndToEnd
EHPMTaskConnectionType_GanttConnectionType_StartToEnd -> EHPMTaskConnectionType_StartToEnd
EHPMTaskConnectionType_GanttConnectionType_StartToStart -> EHPMTaskConnectionType_StartToStart
Project handling
Added nice name that is safe to use in the file system
+ HPMProjectProperties::m_pNiceName
Added parameter to be able to include last comment on updated items in emails
+ HPMProjectEmailSettings::m_ResourceScheduleUpdated_bIncludeComment
Added utils to check for membership, to get backlog and QA project from main project and to check if project is archived + ProjectResourceUtilIsMember
+ ProjectUtilGetBacklog
+ ProjectUtilGetQA
+ ProjectUtilIsArchived
Added new default columns
+ EHPMProjectDefaultColumn_PipelineAndWorkflow
+ EHPMProjectDefaultColumn_ItemType
+ EHPMProjectDefaultColumn_IsOverdue
+ EHPMProjectDefaultColumn_IsInProgress
+ EHPMProjectDefaultColumn_IsIncomplete
+ EHPMProjectDefaultColumn_IsCompleted
+ EHPMProjectDefaultColumn_IsNotStartedYet
+ EHPMProjectDefaultColumn_IsNotAssigned
+ EHPMProjectDefaultColumn_IsMilestoneOverdue
+ EHPMProjectDefaultColumn_IsOutOfOfficeTask
+ EHPMProjectDefaultColumn_UserStory
+ EHPMProjectDefaultColumn_IsAssignedToMe
+ EHPMProjectDefaultColumn_IsUserStory
+ EHPMProjectDefaultColumn_HasChildren
+ EHPMProjectDefaultColumn_HasAssignment
+ EHPMProjectDefaultColumn_Project
+ EHPMProjectDefaultColumn_LeafSubItems
+ EHPMProjectDefaultColumn_SubItems
+ EHPMProjectDefaultColumn_ParentSubProjects
+ EHPMProjectDefaultColumn_ImmediateSubItems
+ EHPMProjectDefaultColumn_ImmediateParentSubProject
Removed unused wall settings flag
- EHPMProjectWallSettingsFlags_ShowProxyPath
Refactored default column backlog item status to item status, description to item name and priority to priority tag
EHPMProjectDefaultColumn_BacklogItemStatus -> EHPMProjectDefaultColumn_ItemStatus
EHPMProjectDefaultColumn_Description -> EHPMProjectDefaultColumn_ItemName
EHPMProjectDefaultColumn_Priority -> EHPMProjectDefaultColumn_PriorityTag
Unified icon enumerations.
EHPMProjectCustomColumnsColumnDropListItemIcon -> EHPMListIcon
EHPMProjectQAWorkflowBugStatusIcon -> EHPMListIcon
Resource handling
Added function to get the currently logged in user.
+ ResourceGetLoggedIn
Added functions to get resources in resource group, resource id from resource string name and resource string name from resource id + ResourceGroupGetResources
+ ResourceGetResourceFromName
+ ResourceGetNameFromResource
Added resources to custom columns
+ UtilDecodeCustomColumnResourcesValue
+ EHPMProjectCustomColumnsColumnType_Resources
+ EHPMCustomChoiceValueType_ResourceGroup
Added list for resources
+ HPMResourceDefinitionList
Refactored EHPMTaskSprintResourceType to EHPMResourceGroupingType
EHPMTaskSprintResourceType_ResourceGroup -> EHPMResourceGroupingType_Resource
Column handling
Added utility functions to convert to and from Hansoft's internal date format
+ UtilDecodeCustomColumnDateTimeValue
+ UtilEncodeCustomColumnDateTimeValue
Added function to get the Hansoft URL
+ UtilGetHansoftURL
Added function to get the column header for a column
+ UtilGetColumnName
Unified column and column type.
+ HPMColumn
+ EHPMColumnType
EHPMProjectWallSettingsColumnType -> EHPMColumnType
HPMProjectWallSettingsColumn -> HPMColumn
Version Control
Added field to specify type of resource to have grants granted and rejected
+ HPMVersionControlAccessRight::m_Type
Data history
Added variant data in data history.
+ VariantDecode_HPMInt32
+ VariantDecode_HPMUInt32
+ VariantDecode_HPMInt64
+ VariantDecode_HPMUInt64
+ VariantDecode_HPMFP32
+ VariantDecode_HPMFP64
+ VariantDecode_HPMUniqueID
+ VariantDecode_HPMString
+ VariantDecode_HPMTaskLinkedToMilestones
+ VariantDecode_HPMTaskDelegateTo
+ VariantDecode_HPMTaskSprintAllocatedResources
+ VariantDecode_HPMTaskVisibleTo
+ VariantDecode_HPMTaskResourceAllocation
+ VariantDecode_HPMStatisticsMultiFrequency
+ VariantDecode_HPMStatisticsCustomStatisticsFrequency
+ VariantEncode_HPMInt32
+ VariantEncode_HPMUInt32
+ VariantEncode_HPMInt64
+ VariantEncode_HPMUInt64
+ VariantEncode_HPMFP32
+ VariantEncode_HPMFP64
+ VariantEncode_HPMUniqueID
+ VariantEncode_HPMString
+ HPMVariantData
Document handling
Added functions to set and get the size limit of attached documents
+ GlobalSetDocumentAttachmentLimit
+ GlobalGetDocumentAttachmentLimit
Session handling
Added function to stop session
+ SessionStop
Object handling
Added reference count to objects.
+ ObjectAddRef
Icons
Added icon enumeration for all Hansoft icons
+ EHPMListIcon
Version 1.205
Changes since version 1.101:
Major New Features
It is now possible to extend the Hansoft client by the way of custom dll:s loaded by the client. Limited functionality for creating custom GUIS have also been added to the client. See the ClientPluginCpp sample for more information.
Samples
Added ClientPluginCpp to demonstrate how to use the SDK from a client plugin.
Basic Types
Added support for 8 bit strings and characters. + HPMAsciChar
Database GUIDs
Added support for a database to have a GUID. Useful to distinguish between several databases.
+ HPMDatabaseGUIDs
+ GlobalGetDatabaseGUIDs
Client Plugin Support
Added support for using the SDK as a client plugin.
+ ClientSDKGetFunctionPtr
+ HPMClientSDKData
+ EHPMChangeCallbackOperation_ClientExecuteURL
+ HPMChangeCallbackData_ClientExecuteURL
+ EHPMChangeCallbackOperation_ClientSyncDone
+ HPMChangeCallbackData_ClientSyncDone
Client GUI
Added support for adding a limited client GUI.
+ GlobalGetCustomSettingsIdentifierHash
+ EHPMCustomSettingsType
+ HPMCustomSettingValue
+ GlobalRegisterCustomSettings
+ GlobalUnregisterCustomSettings
+ GlobalGetRegisteredCustomSettings
+ EHPMChangeCallbackOperation_GlobalCustomSettingsChange
+ HPMChangeCallbackData_GlobalCustomSettingsChange
+ EHPMChangeCallbackOperation_GlobalCustomSettingsUnregister
+ HPMChangeCallbackData_GlobalCustomSettingsUnregister
+ GlobalGetCustomSettingsValue
+ GlobalSetCustomSettingsValue
+ EHPMChangeCallbackOperation_GlobalCustomSettingsValueChange
+ HPMChangeCallbackData_GlobalCustomSettingsValueChange
+ ResourceGetCustomSettingsValue
+ ResourceSetCustomSettingsValue
+ EHPMChangeCallbackOperation_ResourceCustomSettingsValueChange
+ HPMChangeCallbackData_ResourceCustomSettingsValueChange
+ ProjectGetCustomSettingsValue
+ ProjectSetCustomSettingsValue
+ EHPMChangeCallbackOperation_ProjectCustomSettingsValueChange
+ HPMChangeCallbackData_ProjectCustomSettingsValueChange
+ ProjectResourceGetCustomSettingsValue
+ ProjectResourceSetCustomSettingsValue
+ EHPMChangeCallbackOperation_ProjectResourceCustomSettingsValueChange
+ HPMChangeCallbackData_ProjectResourceCustomSettingsValueChange
+ EHPMCustomChoiceValueType
+ HPMCustomChoiceValue
+ UtilDecodeCustomChoiceValue
Internal SDK Data
Added support for a SDK integration to save hidden data on different objects.
+ HPMSDKInternalData
+ GlobalGetSDKInternalDataIdentifierHash
+ GlobalGetSDKInternalData
+ GlobalSetSDKInternalData
+ EHPMChangeCallbackOperation_GlobalSDKInternalDataChange
+ HPMChangeCallbackData_GlobalSDKInternalDataChange
+ ResourceGetSDKInternalData
+ ResourceSetSDKInternalData
+ EHPMChangeCallbackOperation_ResourceSDKInternalDataChange
+ HPMChangeCallbackData_ResourceSDKInternalDataChange
+ ProjectGetSDKInternalData
+ ProjectSetSDKInternalData
+ EHPMChangeCallbackOperation_ProjectSDKInternalDataChange
+ HPMChangeCallbackData_ProjectSDKInternalDataChange
+ ProjectResourceGetSDKInternalData
+ ProjectResourceSetSDKInternalData
+ EHPMChangeCallbackOperation_ProjectResourceSDKInternalDataChange
+ HPMChangeCallbackData_ProjectResourceSDKInternalDataChange
+ TaskGetSDKInternalData
+ TaskSetSDKInternalData
+ EHPMChangeCallbackOperation_TaskSDKInternalDataChange
+ HPMChangeCallbackData_TaskSDKInternalDataChange
+ TaskRefGetSDKInternalData
+ TaskRefSetSDKInternalData
+ EHPMChangeCallbackOperation_TaskRefSDKInternalDataChange
+ HPMChangeCallbackData_TaskRefSDKInternalDataChange
Task Handling
Added support for preserving the task identifier and not only the task reference identifier.
HPMTaskCreateEntry::m_ReuseID -> HPMTaskCreateEntry::m_ReuseUniqueRefID
+ HPMTaskCreateEntry::m_ReuseUniqueID
Added support for proxy tasks.
+ HPMTaskCreateProxiesEntry
+ HPMTaskCreateProxies
+ HPMTaskCreateProxiesReturn
+ TaskCreateProxies
+ EHPMChangeCallbackOperation_TaskCreateProxies
+ HPMChangeCallbackData_TaskCreateProxiesTask
+ HPMChangeCallbackData_TaskCreateProxies
+ TaskGetProxy
Added functions for getting task references from tasks.
+ TaskEnumReferences
+ TaskGetMainReference
Refactored "parent id" to "previous id" to avoid confusion.
TaskRefSetParentID -> TaskRefSetPreviousID
TaskRefGetParentID -> TaskRefGetPreviousID
TaskRefSetParentWorkPriorityID -> TaskRefSetPreviousWorkPriorityID
TaskRefGetParentWorkPriorityID -> TaskRefGetPreviousWorkPriorityID
Added utilities for checking if a unique id is a task or a task ref.
+ UtilIsIDTask
+ UtilIsIDTaskRef
Added explicit enum for task severity.
+ EHPMTaskSeverity
Added sprint grouping to wall positions.
+ HPMTaskWallPosition::m_GroupingSprintUID
Error Handling
Added conversion for version control error codes to text error messages.
+ VersionControlErrorToStr
Added new error handling relating to custom settings GUI and client SDK.
+ EHPMError_ParseError
+ EHPMError_InvalidCustomSettingsType
+ EHPMError_NotAvailableInClientSDK
+ EHPMError_OnlyAvailableInClientSDK
Custom Statistics
Added support for custom statistics.
+ EHPMStatisticsField_CustomStatisticsSampler
+ HPMCustomStatisticsField
+ HPMProjectCustomStatisticsSampler
+ HPMProjectCustomStatisticsSettings
+ ProjectGetCustomStatisticsSettings
+ ProjectSetCustomStatisticsSettings
+ EHPMChangeCallbackOperation_ProjectCustomStatisticsSettingsChange
+ HPMChangeCallbackData_ProjectCustomStatisticsSettingsChange
+ HPMStatisticsCustomStatisticsFrequencyEntry
+ HPMStatisticsCustomStatisticsFrequency
+ DataHistoryGetEntryData_HPMStatisticsCustomStatisticsFrequency
Floating Point Stats
Added support for floating point statistics.
+ HPMStatisticsMultiFrequencyEntry::m_FrequencyFP
Version Control
Added new error code.
EHPMVersionControlError_Success_FileUnchanged
Added support for adding files directly from memory.
HPMVersionControlLocalFilePair::m_nFileData
HPMVersionControlLocalFilePair::m_pFileData
Added support for getting version control file info from a single file without enumerating it.
+ VersionControlGetFileInfo
Project Handling
Added new project settings flags.
+ EHPMProjectSettingsFlag_EverybodyCanCommentOnAllItems
+ EHPMProjectSettingsFlag_AutoRefreshQAView
+ EHPMProjectSettingsFlag_DisplayItemsInQAViewWithoutQuery
Updated custom column support with new features.
+ EHPMProjectCustomColumnsColumnAccessRights_ReadOnly
+ EHPMProjectCustomColumnsColumnType_IntegerNumber
+ EHPMProjectCustomColumnsColumnType_FloatNumber
+ EHPMProjectCustomColumnsColumnType_DateTime
+ EHPMProjectCustomColumnsColumnType_MultiLineText
+ HPMProjectCustomColumnsColumnDropListItem::m_nAutoAssignResources
+ HPMProjectCustomColumnsColumnDropListItem::m_pAutoAssignResources
+ HPMProjectCustomColumnsColumn::m_pUnit
Refactored and added new default columns.
EHPMProjectDefaultColumn_BacklogCategories -> EHPMProjectDefaultColumn_BacklogCategory
+ EHPMProjectDefaultColumn_Description
+ EHPMProjectDefaultColumn_Start
+ EHPMProjectDefaultColumn_Finish
+ EHPMProjectDefaultColumn_Duration
+ EHPMProjectDefaultColumn_Resources
+ EHPMProjectDefaultColumn_BudgetedWork
+ EHPMProjectDefaultColumn_EarnedValue
+ EHPMProjectDefaultColumn_Predecessor
+ EHPMProjectDefaultColumn_Successor
+ EHPMProjectDefaultColumn_WorkRemaining
+ EHPMProjectDefaultColumn_CommittedToSprint
+ EHPMProjectDefaultColumn_DetailedDescription
+ EHPMProjectDefaultColumn_StepsToReproduce
+ EHPMProjectDefaultColumn_Comments
+ EHPMProjectDefaultColumn_SubProjectPath
+ EHPMProjectDefaultColumn_CCCommentsTo
Added new QA workflow support.
+ EHPMProjectQAWorkflowObjectFlag_BugStatus_SetWorkRemainingToZeroWhenReachingThisBugStatus
Added new wall group functionality.
+ EHPMProjectWallSettingsFlags_ShowProxyPath
+ EHPMProjectWallSettingsFlags_ShowGroupWorkRemaining
+ HPMProjectWallGroup::m_GroupingSprintUID
+ HPMProjectWallGroup::m_ValueAssignID
Added new detailed access rules function types.
+ EHPMProjectDetailedAccessRuleFunctionType_ShareReportTemplates
+ EHPMProjectDetailedAccessRuleFunctionType_ReportBugsInAllBugsInProjectView
Resource Handling
Added new resource global settings flags.
+ EHPMResourceGlobalSettingsFlag_DoNotAutoPreviewFiles
+ EHPMResourceGlobalSettingsFlag_MagnifyItemsInTheWallView
Version 1.101
Changes since version 1.003:
Samples
Added a simple sample demonstrating the C++ wrapper.
Basic types
Added basic floating point types. + HPMFP32 + HPMFP64
Resource Groups
Added functionality for resource groups. + ResourceGroupCreate + ResourceGroupDelete + ResourceGroupEnum + ResourceGroupGetProperties + ResourceGroupSetProperties + EHPMChangeCallbackOperation_ResourceGroupsChange + HPMChangeCallbackData_ResourceGroupsChange + HPMResourceGroupProperties + HPMResourceGroupEnum
Backlog Wall View
Added new functionality relating to the backlog wall view. + ProjectGetWallSettings + ProjectSetWallSettings + ProjectGetWallGroups + ProjectSetWallGroups + TaskSetWallItemColor + TaskGetWallItemColor + TaskSetWallPositions + TaskGetWallPositions + EHPMWallGroupingType + EHPMChangeCallbackOperation_ProjectWallSettingsChange + EHPMChangeCallbackOperation_ProjectWallGroupsChange + HPMChangeCallbackData_ProjectWallSettingsChange + HPMChangeCallbackData_ProjectWallGroupsChange + EHPMProjectWallSettingsTextSize + EHPMProjectWallSettingsFlags + EHPMProjectWallSettingsColumnType + HPMProjectWallSettingsColumn + HPMProjectWallSettings + HPMProjectWallGroup + HPMProjectWallGroups + EHPMTaskField_WallItemColor + EHPMTaskField_WallItemPositions + EHPMTaskWallItemColor + HPMTaskWallPosition + HPMTaskWallPositions
Backlog work priority
Added new functionality relating to the backlog priority queue. + TaskRefSetParentWorkPriorityID + TaskRefGetParentWorkPriorityID + EHPMTaskRefField_ParentIDWorkPriority
Data history
Added functionality for getting floating point data history. + DataHistoryGetEntryData_HPMFP32 + DataHistoryGetEntryData_HPMFP64
Detailed access restrictions
Added new functionality relating to detailed access restrictions. + ProjectGetDetailedAccessRules + ProjectSetDetailedAccessRules + EHPMChangeCallbackOperation_ProjectDetailedAccessRulesChange + HPMChangeCallbackData_ProjectDetailedAccessRulesChange + EHPMProjectDetailedAccessRuleType + EHPMProjectDetailedAccessRuleFunctionType + HPMProjectDetailedAccessRuleFunction + HPMProjectDetailedAccessRule + HPMProjectDetailedAccessRules
Error handling
Added text error description functionality. + UtilGetLastErrorDescription Added new error handling relating to license violations. + EHPMLicenseViolationReason + EHPMError_LicenseViolation + EHPMChangeCallbackOperation_ResourceLicenseViolation + HPMChangeCallbackData_ResourceLicenseViolation
Generalized resource definitions
Refactored resource definitions to be general. EHPMProjectQAWorkflowAssignType -> EHPMResourceGroupingType HPMProjectQAWorkflowRequiredField -> HPMResourceDefinition
Project Handling
Added project settings. + EHPMProjectSettingsFlag_CreatedBacklogItemsAreUserStoriesByDefault + HPMProjectSettings::m_SprintDefaultLength Added default columns. + EHPMProjectDefaultColumn_DatabaseID + EHPMProjectDefaultColumn_WorkPriority Removed obsolete project resource flag. - EHPMProjectResourceFlag_CanEditAllBugs} Refactored QA workflow to support new functionality. EHPMProjectQAWorkflowBugStatusFlag -> EHPMProjectQAWorkflowObjectFlag + EHPMProjectQAWorkflowObjectFlag_BugStatus_LetAssignedResourcesReassignToOriginalReporter + EHPMProjectQAWorkflowObjectFlag_BugStatus_ReassignToOriginalReporterWhenReachingThisButStatus + EHPMProjectQAWorkflowObjectFlag_BugStatus_DontAllowBugToHaveNoResourcesAssigned + EHPMProjectQAWorkflowObjectFlag_BugStatus_UnpublishedStatus + EHPMProjectQAWorkflowObjectFlag_Transition_ResourcesCanEditAllFieldsThatMustBeSetForThisTransition @HPMProjectQAWorkflowObject::m_BugStatus_Flags -> @HPMProjectQAWorkflowObject::m_Flags @HPMProjectQAWorkflowObject::m_BugStatus_nRequiredFields -> @HPMProjectQAWorkflowObject::m_nRequiredFields @HPMProjectQAWorkflowObject::m_BugStatus_pRequiredFields -> @HPMProjectQAWorkflowObject::m_pRequiredFields
Task Handling
Added new task fields.
Version 1.003
Initial release