Aspose.Tasks for C++
MspDbSettings.h
1 #pragma once
2 //-----------------------------------------------------------------------
3 // <copyright file="MspDbSettings.cs" company="Aspose Pty Ltd">
4 // Copyright (c) 2002-2024 Aspose Pty Ltd. All Rights Reserved.
5 // </copyright>
6 //-----------------------------------------------------------------------
7 
8 #include <system/guid.h>
9 
10 #include "aspose.tasks.cpp/IO/DB/DbSettings.h"
11 #include "aspose.tasks.cpp/aspose_tasks_api_defs.h"
12 
13 namespace Aspose
14 {
15 namespace Tasks
16 {
17 namespace Connectivity
18 {
19 template <typename, typename> class DbMapper;
20 class DbReader;
21 class DbTypeConverter;
22 } // namespace Connectivity
23 } // namespace Tasks
24 } // namespace Aspose
25 
26 namespace Aspose {
27 
28 namespace Tasks {
29 
30 namespace Connectivity {
31 
32 /// <summary>
33 /// Allows to set necessary options to read project data from MS Project Server database.
34 /// </summary>
35 class ASPOSE_TASKS_SHARED_CLASS MspDbSettings : public Aspose::Tasks::Connectivity::DbSettings
36 {
37  typedef MspDbSettings ThisType;
39 
40  typedef ::System::BaseTypesInfo<BaseType> ThisTypeBaseTypesInfo;
41  ASPOSE_TASKS_SHARED_RTTI_INFO_DECL();
42 
43  template<typename FT0, typename FT1> friend class Aspose::Tasks::Connectivity::DbMapper;
44 
45 public:
46 
47  /// <summary>
48  /// Gets the guid of the project to read.
49  /// </summary>
50  ASPOSE_TASKS_SHARED_API System::Guid get_ProjectGuid() const;
51  /// <summary>
52  /// Gets the schema of the MS Project Server.
53  /// The default value is "pub".
54  /// </summary>
55  ASPOSE_TASKS_SHARED_API System::String get_Schema() const;
56  /// <summary>
57  /// Sets the schema of the MS Project Server.
58  /// The default value is "pub".
59  /// </summary>
60  ASPOSE_TASKS_SHARED_API void set_Schema(const System::String& value);
61 
62  /// <summary>
63  /// Initializes a new instance of the <see cref="MspDbSettings"></see> class.
64  /// </summary>
65  /// <param name="connectionString">the specified connection string.</param>
66  /// <param name="projectGuid">the specified guid of a project to read.</param>
67  ASPOSE_TASKS_SHARED_API MspDbSettings(const System::String& connectionString, System::Guid projectGuid);
68 
69 protected:
70 
71  ASPOSE_TASKS_SHARED_API System::SharedPtr<DbReader> GetDbReader() override;
72  ASPOSE_TASKS_SHARED_API System::SharedPtr<DbTypeConverter> GetTypeConverter() override;
73 
74  virtual ASPOSE_TASKS_SHARED_API ~MspDbSettings();
75 
76  #ifdef ASPOSE_GET_SHARED_MEMBERS
77  ASPOSE_TASKS_SHARED_API void GetSharedMembers(System::Object::shared_members_type& result) const override;
78  #endif
79 
80 
81 private:
82 
83  System::Guid projectGuid;
84  System::String pr_Schema;
85 
86 };
87 
88 } // namespace Connectivity
89 } // namespace Tasks
90 } // namespace Aspose
91 
92 
Allows to specify settings to read from project database.
Definition: DbSettings.h:71
Allows to set necessary options to read project data from MS Project Server database.
Definition: MspDbSettings.h:36
System::String get_Schema() const
Gets the schema of the MS Project Server. The default value is "pub".
void set_Schema(const System::String &value)
Sets the schema of the MS Project Server. The default value is "pub".
MspDbSettings(const System::String &connectionString, System::Guid projectGuid)
Initializes a new instance of the MspDbSettings class.
System::Guid get_ProjectGuid() const
Gets the guid of the project to read.
Definition: Asn.h:13