CustomFields.ReadCustomFields2 方法
取得企業自訂欄位定義公式位於語言相關格式中的位置。
命名空間: WebSvcCustomFields
組件： ProjectServerServices (在 ProjectServerServices.dll 中)
語法
'宣告
<SoapDocumentMethodAttribute("https://schemas.microsoft.com/office/project/server/webservices/CustomFields/ReadCustomFields2", RequestNamespace := "https://schemas.microsoft.com/office/project/server/webservices/CustomFields/", _
ResponseNamespace := "https://schemas.microsoft.com/office/project/server/webservices/CustomFields/", _
Use := SoapBindingUse.Literal, ParameterStyle := SoapParameterStyle.Wrapped)> _
Public Function ReadCustomFields2 ( _
xmlFilter As String, _
autoCheckOut As Boolean _
) As CustomFieldDataSet
'用途
Dim instance As CustomFields
Dim xmlFilter As String
Dim autoCheckOut As Boolean
Dim returnValue As CustomFieldDataSet
returnValue = instance.ReadCustomFields2(xmlFilter, _
autoCheckOut)
[SoapDocumentMethodAttribute("https://schemas.microsoft.com/office/project/server/webservices/CustomFields/ReadCustomFields2", RequestNamespace = "https://schemas.microsoft.com/office/project/server/webservices/CustomFields/",
ResponseNamespace = "https://schemas.microsoft.com/office/project/server/webservices/CustomFields/",
Use = SoapBindingUse.Literal, ParameterStyle = SoapParameterStyle.Wrapped)]
public CustomFieldDataSet ReadCustomFields2(
string xmlFilter,
bool autoCheckOut
)
參數
xmlFilter
類型：System.String限制傳回的資料量。
autoCheckOut
類型：System.Boolean如果true，取出的自訂欄位進行修改。
傳回值
類型：WebSvcCustomFields.CustomFieldDataSet
備註
Project Server 2010新方法。如果自訂欄位或圖形標記由公式計算， ReadCustomFields2方法會將傳回CustomFieldDataSet中的公式轉換成取決於在 [地區及語言選項控制台執行 Project Server 的電腦中指定的地區設定的格式。相較之下， ReadCustomFields方法會傳回CustomFieldDataSet公式會與地區設定無關的位置。
.gif "注意事項") 注意事項 |
|---|
針對Project Server 2010，傳回的CustomFieldDataSet可包含Relative Importance自訂欄位以及Project Impact自訂欄位。Project Web App不會顯示這些自訂欄位的企業自訂欄位與查閱表格] 頁面上，因為它們是內建的產品組合分析並無法修改或刪除。 |
. For more information, see How to: Use a Filter Parameter with PSI Methods
Project Server 權限
權限 |
描述 |
|---|---|
非標準 |
您必須具備ManageWorkflow通用權限或ChangeWorkflow通用權限。如果您有ChangeWorkflow權限，您也必須OpenProject類別權限和SaveProject類別權限。 |
可讓使用者從 Project Professional 連線至 Project Server 資料庫。通用權限。 |
|
可讓使用者修改企業自訂欄位與查閱表格值的定義。通用權限。 |
|
可讓使用者管理 Project Server 使用者和群組。通用權限。 |
|
可讓使用者建立一個專案。通用權限。 |
|
可讓使用者檢視資源分派資料。通用權限。 |
範例
ReadCustomFieldsTest範例會執行下列動作：
讀取Project Web App安裝端點位址 app.config 檔案中所指定，然後將其寫入CustomFieldDataSet的 XML 檔案中的所有自訂欄位。
讀取查閱資料表資料指定語言的 LCID，並再將其寫入LookupTableDataSet的 XML 檔案。查閱表格的 XML 資料包含下表的集合： LookupTables、 LookupTableMasks，以及LookupTableTrees。
For information about using the code sample in a Microsoft Visual Studio 2010 project and creating an app.config file for configuration of the WCF endpoints, see Prerequisites for WCF-Based Code Samples.
using System;
using System.Text;
using System.ServiceModel;
using System.Xml;
using PSLibrary = Microsoft.Office.Project.Server.Library;
namespace Microsoft.SDK.Project.Samples.ReadCustomFieldsTest
{
class Program
{
private const string ENDPOINT_CUSTOMFIELDS = "basicHttp_CustomFields";
private const string ENDPOINT_LOOKUPTABLE = "basicHttp_LookupTable";
// Change the output directory for your computer.
private const string OUTPUT_FILES = @"C:\Project\Samples\Output\";
private static SvcCustomFields.CustomFieldsClient customFieldsClient;
private static SvcLookupTable.LookupTable lookupTableClient;
private static string outFileCustomFieldsDs;
private static string outFileLookupTableDs;
private static int language = 1033; // Use the English LCID by default.
static void Main(string[] args)
{
if (args.Length > 0 && args.Length < 3)
{
if (args[0].ToLower() == "-lcid")
{
language = Convert.ToInt32(args[1]);
}
}
outFileCustomFieldsDs = OUTPUT_FILES + "CustomFieldDataSet.xml";
outFileLookupTableDs = OUTPUT_FILES + "LookupTableDataSet.xml";
ConfigClientEndpoints(ENDPOINT_CUSTOMFIELDS);
ConfigClientEndpoints(ENDPOINT_LOOKUPTABLE);
try
{
Console.WriteLine("Reading custom fields...");
SvcCustomFields.CustomFieldDataSet customFieldDs =
customFieldsClient.ReadCustomFields2(string.Empty, false);
Console.WriteLine(
"\nXML output of the CustomFieldDataSet:\n\t{0}",
outFileCustomFieldsDs);
customFieldDs.WriteXml(outFileCustomFieldsDs);
Console.WriteLine("Reading lookup tables...");
SvcLookupTable.LookupTableDataSet lookupTableDs =
lookupTableClient.ReadLookupTables(string.Empty, false, language);
Console.WriteLine(
"\nXML output of the LookupTableDataSet:\n\t{0}",
outFileCustomFieldsDs);
lookupTableDs.WriteXml(outFileLookupTableDs);
}
catch (FaultException fault)
{
// Use the WCF FaultException, because the ASMX SoapException does not
// exist in a WCF-based application.
WriteFaultOutput(fault);
}
catch (EndpointNotFoundException ex)
{
Console.WriteLine(ex.Message);
Console.WriteLine("\nInnerException: \n" + ex.InnerException.Message);
}
Console.Write("\nPress any key to exit... ");
Console.ReadKey(true);
}
// Extract a PSClientError object from the WCF FaultException object, and
// then display the exception details and each error in the PSClientError stack.
private static void WriteFaultOutput(FaultException fault)
{
string errAttributeName;
string errAttribute;
string errOut;
string errMess = "".PadRight(30, '=') + "\r\n"
+ "Error details: " + "\r\n";
PSLibrary.PSClientError error = Helpers.GetPSClientError(fault, out errOut);
errMess += errOut;
if (error != null)
{
PSLibrary.PSErrorInfo[] errors = error.GetAllErrors();
PSLibrary.PSErrorInfo thisError;
for (int i = 0; i < errors.Length; i++)
{
thisError = errors[i];
errMess += "\r\n".PadRight(30, '=') + "\r\nPSClientError output:\r\n";
errMess += thisError.ErrId.ToString() + "\n";
for (int j = 0; j < thisError.ErrorAttributes.Length; j++)
{
errAttributeName = thisError.ErrorAttributeNames()[j];
errAttribute = thisError.ErrorAttributes[j];
errMess += "\r\n\t" + errAttributeName
+ ": " + errAttribute;
}
}
}
Console.ForegroundColor = ConsoleColor.Red;
Console.WriteLine(errMess);
Console.ResetColor();
}
// Use the endpoints defined in app.config to configure the client.
public static void ConfigClientEndpoints(string endpt)
{
if (endpt == ENDPOINT_CUSTOMFIELDS)
customFieldsClient = new SvcCustomFields.CustomFieldsClient(endpt);
else if (endpt == ENDPOINT_LOOKUPTABLE)
lookupTableClient = new SvcLookupTable.LookupTableClient(endpt);
}
}
// Helper methods
class Helpers
{
/// <summary>
/// Extract a PSClientError object from the ServiceModel.FaultException,
/// for use in output of the GetPSClientError stack of errors.
/// </summary>
/// <param name="e"></param>
/// <param name="errOut">Shows that FaultException has more information
/// about the errors than PSClientError has. FaultException can also contain
/// other types of errors, such as failure to connect to the server.</param>
/// <returns>PSClientError object, for enumerating errors.</returns>
public static PSLibrary.PSClientError GetPSClientError(FaultException e,
out string errOut)
{
const string PREFIX = "GetPSClientError() returns null: ";
errOut = string.Empty;
PSLibrary.PSClientError psClientError = null;
if (e == null)
{
errOut = PREFIX + "Null parameter (FaultException e) passed in.";
psClientError = null;
}
else
{
// Get a ServiceModel.MessageFault object.
var messageFault = e.CreateMessageFault();
if (messageFault.HasDetail)
{
using (var xmlReader = messageFault.GetReaderAtDetailContents())
{
var xml = new XmlDocument();
xml.Load(xmlReader);
var serverExecutionFault = xml["ServerExecutionFault"];
if (serverExecutionFault != null)
{
var exceptionDetails = serverExecutionFault["ExceptionDetails"];
if (exceptionDetails != null)
{
try
{
errOut = exceptionDetails.InnerXml + "\r\n";
psClientError =
new PSLibrary.PSClientError(exceptionDetails.InnerXml);
}
catch (InvalidOperationException ex)
{
errOut = PREFIX + "Unable to convert fault exception info ";
errOut += "a valid Project Server error message. Message: \n\t";
errOut += ex.Message;
psClientError = null;
}
}
else
{
errOut = PREFIX + "The FaultException e is a ServerExecutionFault, "
+ "but does not have ExceptionDetails.";
}
}
else
{
errOut = PREFIX + "The FaultException e is not a ServerExecutionFault.";
}
}
}
else // No detail in the MessageFault.
{
errOut = PREFIX + "The FaultException e does not have any detail.";
}
}
errOut += "\r\n" + e.ToString() + "\r\n";
return psClientError;
}
}
}
請參閱
參照
ReadCustomFields(String, Boolean)