This topic has not yet been rated - Rate this topic

GetHeaderColumnsImportFileRequest Class

[Applies to: Microsoft Dynamics CRM 2011 and Microsoft 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.

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

Usage

'Usage

Syntax

C++

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

JScript

Example

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.
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[" & columnNum.ToString() & "] = " & headerName)
    columnNum += 1
Next headerName

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 Privileges.

Inheritance Hierarchy

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

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.

Platforms