bcp_colfmt

Syntax

RETCODE bcp_colfmt (
        HDBC hdbc,
        INT idxUserDataCol,
        BYTE eUserDataType,
        INT cbIndicator,
        DBINT cbUserData,
        LPCBYTE pUserDataTerm,
        INT cbUserDataTerm,
        INT idxServerCol);

Argumente

• hdbc
  Das für das Massenkopieren aktivierte ODBC-Verbindungshandle.

• idxUserDataCol
  Die Ordnungsnummer der Spalte in der Benutzerdatendatei, für die das Format angegeben wird. Die erste Spalte ist 1.

• eUserDataType
  Der Datentyp dieser Spalte in der Benutzerdatei. Wenn die Daten nicht mit dem Datentyp der entsprechenden Spalte in der Datenbanktabelle (idxServerColumn) übereinstimmen, werden die Daten, wenn möglich, durch das Massenkopieren konvertiert.

  Mit SQL Server 2005 wurde die Unterstützung für die Datentyptoken SQLXML und SQLUDT im eUserDataType-Parameter eingeführt.

  Der eUserDataType-Parameter wird von den SQL Server-Datentyptoken in sqlncli.h, nicht von den ODBC C-Datentypenumeratoren, aufgelistet. Sie können beispielsweise mithilfe des SQL Server-spezifischen SQLCHARACTER-Typs eine Zeichenfolge vom ODBC-Typ SQL_C_CHAR angeben.

  Um die Standarddatendarstellung für den SQL Server-Datentyp anzugeben, legen Sie diesen Parameter auf 0 fest.

  Für einen Massenkopiervorgang aus SQL Server in eine Datei, wenn für eUserDataType SQLDECIMAL oder SQLNUMERIC festgelegt ist:

  • Wenn die Quellspalte nicht dezimal oder numerisch ist, werden die Standardgenauigkeit und die Standardanzahl von Dezimalstellen verwendet.

  • Wenn die Quellspalte dezimal oder numerisch ist, werden die Genauigkeit und die Anzahl von Dezimalstellen der Quellspalte verwendet.

• cbIndicator
  Die Länge eines Längen-/NULL-Indikators innerhalb der Spaltendaten in Byte. Gültige Indikatorlängenwerte sind 0 (wenn kein Indikator verwendet wird), 1, 2, 4 oder 8.

  Legen Sie diesen Parameter auf SQL_VARLEN_DATA fest, um die Verwendung eines standardmäßigen Massenkopierindikators anzugeben.

  Indikatoren werden im Speicher direkt vor allen anderen Daten angezeigt. In der Datendatei werden sie direkt vor den Daten, auf die sie sich beziehen, angezeigt.

  Wird mehr als eine Methode zur Angabe der Länge der Datendateispalte verwendet (z. B. ein Indikator und eine maximale Spaltenlänge oder ein Indikator und eine Abschlusszeichensequenz), wird beim Massenkopieren die Methode ausgewählt, die zu der kleineren zu kopierenden Datenmenge führt.

  Datendateien, die durch Massenkopieren generiert wurden, wobei das Datenformat nicht durch Benutzereingriff angepasst wird, enthalten Indikatoren, wenn die Spaltendaten eine unterschiedliche Länge haben oder die Spalte NULL als Wert akzeptieren kann.

• cbUserData
  Die maximale Länge (in Byte) der Daten dieser Spalte in der Benutzerdatei, ohne die Länge eines Längenindikators oder Abschlusszeichens.

  Durch Festlegen von cbUserData auf SQL_NULL_DATA wird angegeben, dass alle Werte in der Datendateispalte auf NULL festgelegt sind oder es sein sollten.

  Wird cbUserData auf SQL_VARLEN_DATA festgelegt, bedeutet dies, dass das System die Länge der Daten für jede Spalte bestimmen soll. Für einige Spalten könnte dies bedeuten, dass ein Längen-/NULL-Indikator generiert wird, der den Daten in einer Kopie von SQL Server vorangestellt wird, oder dass der Indikator in Daten, die in SQL Server kopiert werden, erwartet wird.

  Für SQL Server-Zeichen- und Binärdatentypen kann cbUserData SQL_VARLEN_DATA, SQL_NULL_DATA, 0 oder ein positiver Wert sein. Wenn cbUserData auf SQL_VARLEN_DATA festgelegt ist, verwendet das System entweder den Längenindikator, sofern vorhanden, oder eine Abschlusszeichensequenz, um die Länge der Daten zu bestimmen. Wenn sowohl ein Längenindikator als auch eine Abschlusszeichensequenz angegeben sind, wird beim Massenkopieren der Wert verwendet, der zu der kleineren zu kopierenden Datenmenge führt. Wenn cbUserData auf SQL_VARLEN_DATA festgelegt, der Datentyp ein SQL Server-Zeichen- oder Binärdatentyp ist und weder ein Längenindikator noch eine Abschlusszeichensequenz angegeben ist, gibt das System eine Fehlermeldung zurück.

  Wenn cbUserData 0 oder ein positiver Wert ist, verwendet das System cbUserData als maximale Datenlänge. Wenn jedoch zusätzlich zu einem positiven cbUserData-Wert ein Längenindikator oder eine Abschlusszeichensequenz angegeben ist, bestimmt das System die Datenlänge mit der Methode, die zu der kleineren zu kopierenden Datenmenge führt.

  Der cbUserData-Wert stellt die Anzahl der Datenbytes dar. Werden Zeichendaten durch Unicode-Zeichen dargestellt, repräsentiert ein positiver cbUserData-Parameterwert die Anzahl der Zeichen multipliziert mit der Größe (in Byte) der einzelnen Zeichen.

• pUserDataTerm
  Die Abschlusszeichensequenz, die für diese Spalte verwendet werden soll. Dieser Parameter ist in erster Linie für Zeichendatentypen nützlich, da alle anderen Typen eine feste Länge besitzen oder, im Falle von Binärdaten, einen Indikator für die Länge erfordern, um die Anzahl der vorhandenen Bytes präzise zu erfassen.

  Legen Sie diesen Parameter auf NULL fest, um zu vermeiden, dass extrahierte Daten terminiert werden, oder um anzugeben, dass Daten in einer Benutzerdatei nicht terminiert werden.

  Wird mehr als eine Methode zur Angabe der Länge der Benutzerdateispalte verwendet (z. B. ein Abschlusszeichen und ein Längenindikator oder ein Abschlusszeichen und eine maximale Spaltenlänge), wird beim Massenkopieren die Methode ausgewählt, die zu der kleineren zu kopierenden Datenmenge führt.

  Die API für das Massenkopieren führt nach Bedarf eine Zeichenkonvertierung von Unicode in MBCS aus. Stellen Sie unbedingt sicher, dass sowohl die Bytezeichenfolge des Abschlusszeichens als auch die Länge der Bytezeichenfolge richtig festgelegt werden.

• cbUserDataTerm
  Die Länge (in Byte) der Abschlusszeichensequenz, die für diese Spalte verwendet werden soll. Wenn kein Abschlusszeichen vorhanden ist oder in den Daten gewünscht wird, legen Sie diesen Wert auf 0 fest.

• idxServerCol
  Die Ordungsposition der Spalte innerhalb der Datenbanktabelle. Die erste Spaltennummer ist 1. Die Ordnungsposition einer Spalte wird von SQLColumns ausgegeben.

  Wenn dieser Wert 0 ist, wird beim Massenkopieren die Spalte in der Datendatei ignoriert.

Rückgabewert

SUCCEED oder FAIL

Hinweise

Mit der bcp_colfmt-Funktion können Sie das Benutzerdateiformat für das Massenkopieren angeben. Für Massenkopiervorgänge enthält ein Format folgende Bestandteile:

• Eine Zuordnung von Benutzerdateispalten zu Datenbankspalten

• Den Datentyp der einzelnen Benutzerdateispalten

• Die Länge des optionalen Indikators für jede Spalte

• Die maximale Länge der Daten pro Benutzerdateispalte

• Die optionale abschließende Bytesequenz für jede Spalte

• Die Länge der optionalen abschließenden Bytesequenz

Jeder Aufruf von bcp_colfmt gibt das Format für eine Benutzerdateispalte an. Um beispielsweise die Standardeinstellungen für drei Spalten in einer aus fünf Spalten bestehenden Benutzerdatendatei zu ändern, rufen Sie zuerst bcp_columns(5) auf und anschließend fünf Mal bcp_colfmt, wobei mit drei von diesen Aufrufen Ihr benutzerdefiniertes Format festgelegt wird. Legen Sie für die verbleibenden zwei Aufrufe eUserDataType auf 0 und cbIndicator, cbUserData und cbUserDataTerm jeweils auf 0, SQL_VARLEN_DATA und 0. Mit diesem Verfahren werden alle fünf Spalten kopiert, drei mit dem benutzerdefinierten Format und zwei mit dem Standardformat.

Für cbIndicator ist der Wert 8, um einen großen Werttyp anzugeben, jetzt gültig. Wenn das Präfix für ein Feld angegeben wird, dessen entsprechende Spalte den neuen max-Typ aufweist, kann dafür nur 8 festgelegt werden. Einzelheiten dazu finden Sie unter bcp_bind.

Die bcp_columns-Funktion muss aufgerufen werden, bevor Aufrufe von bcp_colfmt ausgeführt werden.

Sie müssen bcp_colfmt einmal für jede Spalte in der Benutzerdatei aufrufen.

Wird bcp_colfmt mehr als einmal für eine Benutzerdateispalte aufgerufen, tritt ein Fehler auf.

Sie brauchen nicht alle Daten in einer Benutzerdatei in eine SQL Server-Tabelle kopieren. Um eine Spalte zu überspringen, geben Sie das Format der Daten für die Spalte an und legen für den idxServerCol-Parameter 0 fest. Wenn Sie eine Spalte überspringen möchten, müssen Sie ihren Typ angeben.

Die bcp_writefmt-Funktion kann verwendet werden, um die Formatspezifikation beizubehalten.

'bcp_colfmt'-Unterstützung für erweiterte Features für Datum und Uhrzeit

Informationen über die mit dem eUserDataType-Parameter für Datum-/Uhrzeit verwendeten Typen finden Sie unter Massenkopieränderungen für verbesserte Datum-/Uhrzeittypen (OLE DB und ODBC).

Weitere Informationen finden Sie unter Datums-/Uhrzeitverbesserungen (ODBC).

Siehe auch

Verweis