GetHeaderColumnsImportFileRequest Class

發行項
11/28/2016

Applies To: Dynamics 365 (online), Dynamics 365 (on-premises), Dynamics CRM 2016, Dynamics CRM Online

Contains the data that is needed to retrieve the source-file column headings; or retrieve the system-generated column headings if the source file does not contain column headings.

For the Web API use GetHeaderColumnsImportFile Function.

Namespace: Microsoft.Crm.Sdk.Messages
Assembly: Microsoft.Crm.Sdk.Proxy (in Microsoft.Crm.Sdk.Proxy.dll)

Inheritance Hierarchy

System.Object
Microsoft.Xrm.Sdk.OrganizationRequest
Microsoft.Crm.Sdk.Messages.GetHeaderColumnsImportFileRequest

Syntax

[DataContractAttribute(Namespace = "https://schemas.microsoft.com/crm/2011/Contracts")]
public sealed class GetHeaderColumnsImportFileRequest : OrganizationRequest

<DataContractAttribute(Namespace := "https://schemas.microsoft.com/crm/2011/Contracts")>
Public NotInheritable Class GetHeaderColumnsImportFileRequest
    Inherits OrganizationRequest

Constructors

	Name	Description
	GetHeaderColumnsImportFileRequest()	Initializes a new instance of the GetHeaderColumnsImportFileRequest class.

Properties

	Name	Description
	ExtensionData	Gets or sets the structure that contains extra data. Optional.(Inherited from OrganizationRequest.)
	ImportFileId	Gets or sets the ID of the import file that is associated with the parse table. Required.
	Item[String]	Gets or sets the indexer for the Parameters collection.(Inherited from OrganizationRequest.)
	Parameters	Gets or sets the collection of parameters for the request. Required, but is supplied by derived classes.(Inherited from OrganizationRequest.)
	RequestId	Gets or sets the ID of an asynchronous operation (system job). Optional. (Inherited from OrganizationRequest.)
	RequestName	Gets or sets the name of the request. Required, but is supplied by derived classes.(Inherited from OrganizationRequest.)

Methods

	Name	Description
	Equals(Object)	(Inherited from Object.)
	GetHashCode()	(Inherited from Object.)
	GetType()	(Inherited from Object.)
	ToString()	(Inherited from Object.)

Remarks

Message Availability

This message works regardless whether the caller is connected to the server or offline.

Usage

Pass an instance of this class to the Execute method, which returns an instance of the GetHeaderColumnsImportFileResponse class.

Privileges and Access Rights

To perform this action, the caller must have privileges on the ImportFile entity and access rights on the specified record in the ImportFileId property. For a complete list of the required privileges, see GetHeaderColumnsImportFile message privileges.

Examples

The following example shows how to use this message. For this sample to work correctly, you must be connected to the server to get an IOrganizationService interface. For the complete sample, see the link later in this topic.


// Retrieve the header columns used in the import file.
GetHeaderColumnsImportFileRequest headerColumnsRequest = new GetHeaderColumnsImportFileRequest()
{
    ImportFileId = importFileId
};
GetHeaderColumnsImportFileResponse headerColumnsResponse =
    (GetHeaderColumnsImportFileResponse)_serviceProxy.Execute(headerColumnsRequest);

// Output the header columns.
int columnNum = 1;
foreach (string headerName in headerColumnsResponse.Columns)
{
    Console.WriteLine("Column[" + columnNum.ToString() + "] = " + headerName);
    columnNum++;
}


' Retrieve the header columns used in the import file.
Dim headerColumnsRequest As New GetHeaderColumnsImportFileRequest() With
    {.ImportFileId = importFileId}
Dim headerColumnsResponse As GetHeaderColumnsImportFileResponse =
    CType(_serviceProxy.Execute(headerColumnsRequest), 
        GetHeaderColumnsImportFileResponse)

' Output the header columns.
Dim columnNum As Integer = 1
For Each headerName As String In headerColumnsResponse.Columns
    Console.WriteLine("Column[" &amp; columnNum.ToString() &amp; "] = " &amp; headerName)
    columnNum += 1
Next headerName

Thread Safety

Any public static ( Shared in Visual Basic) members of this type are thread safe. Any instance members are not guaranteed to be thread safe.

共用方式為