bcp_setcolfmt

Syntax

RETCODE bcp_setcolfmt (
        HDBC hdbc,
        INT field,
        INT property,
        void* pValue,
        INT cbValue);

Argumente

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

• field
  Die Spaltenordnungszahl, für die die Eigenschaft festgelegt wird

• property
  Eine der Eigenschaftskonstanten. Eigenschaftskonstanten werden in dieser Tabelle definiert.

  Eigenschaft	Wert	Beschreibung
  BCP_FMT_TYPE	BYTE	Der Datentyp dieser Spalte in der Benutzerdatei. Wenn die Daten nicht mit dem Datentyp der entsprechenden Spalte in der Datenbanktabelle übereinstimmen, werden die Daten, wenn möglich, durch das Massenkopieren konvertiert. Der BCP_FMT_TYPE-Parameter wird von den SQL Server-Datentyptoken in sqlncli.h anstelle der ODBC C-Datentypenumeratoren aufgelistet. Sie können beispielsweise eine Zeichenfolge, ODBC-Typ SQL_C_CHAR, mithilfe des SQL Server-spezifischen SQLCHARACTER-Typs 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 BCP_FMT_TYPE auf 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.
  BCP_FMT_INDICATOR_LEN	INT	Die Länge des Indikators (Präfix) in Bytes Die Länge eines Längen-/NULL-Indikators innerhalb der Spaltendaten in Bytes. Gültige Indikatorlängenwerte sind 0 (wenn kein Indikator verwendet wird), 1, 2 oder 4. 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.
  BCP_FMT_DATA_LEN	DBINT	Die Länge der Daten (Spaltenlänge) in Bytes Dies ist die maximale Länge (in Bytes) der Daten dieser Spalte in der Benutzerdatei, ohne die Länge eines Längenindikators oder Abschlusszeichens. Durch Festlegen von BCP_FMT_DATA_LEN auf SQL_NULL_DATA wird angegeben, dass alle Werte in der Datendateispalte auf NULL festgelegt sind oder sein sollten. Wird BCP_FMT_DATA_LEN 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. BCP_FMT_DATA_LEN kann für SQL Server-Zeichen und Binärdatentypen BCP_LENGTH_VARIABLE, BCP_LENGTH_NULL, 0 oder ein positiver Wert sein. Wenn BCP_FMT_DATA_LEN 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. Ist BCP_FMT_DATA_LEN auf SQL_VARLEN_DATA festgelegt, ist der Datentyp ein SQL Server-Zeichen oder -Binärtyp. Ist weder ein Längenindikator noch eine Abschlusszeichensequenz angegeben, gibt das System eine Fehlermeldung zurück. Wenn BCP_FMT_DATA_LEN 0 oder ein positiver Wert ist, verwendet das System BCP_FMT_DATA_LEN als maximale Datenlänge. Wenn jedoch zusätzlich zu einem positiven BCP_FMT_DATA_LEN-Wert ein Längenindikator oder eine Abschlusszeichensequenz angegeben ist, bestimmt das System die Datenlänge mithilfe der Methode, die zu der kleineren zu kopierenden Datenmenge führt. Der BCP_FMT_DATA_LEN-Wert stellt die Anzahl der Datenbytes dar. Werden Zeichendaten durch Unicode-Zeichen dargestellt, repräsentiert ein positiver BCP_FMT_DATA_LEN-Parameterwert die Anzahl der Zeichen multipliziert mit der Größe (in Bytes) der einzelnen Zeichen.
  BCP_FMT_TERMINATOR	LPCBYTE	Zeiger auf die Abschlusszeichensequenz (entweder ANSI oder Unicode), 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 und die Länge der Bytezeichenfolge richtig festgelegt werden.
  BCP_FMT_SERVER_COL	INT	Die Position einer Spalte innerhalb der Datenbank
  BCP_FMT_COLLATION	LPCSTR	Sortierungsname

• pValue
  Der Zeiger auf den Wert, der der Eigenschaft zugeordnet ist. Er ermöglicht es, jede Spaltenformateigenschaft einzeln festzulegen.

• cbvalue
  Die Länge des Puffers der Eigenschaft in Bytes

Rückgabewert

SUCCEED oder FAIL

Hinweise

Diese Funktion setzt die bcp_colfmt-Funktion außer Kraft. Die gesamte Funktionalität von bcp_colfmt wird in der bcp_setcolfmt-Funktion bereitgestellt. Zusätzlich wird auch Unterstützung für Spaltensortierung bereitgestellt. Es wird empfohlen, die folgenden Spaltenformatattribute in der unten gegebenen Reihenfolge festzulegen:

BCP_FMT_SERVER_COL

BCP_FMT_DATA_LEN

BCP_FMT_TYPE

Mit der bcp_setcolfmt-Funktion können Sie das Benutzerdateiformat für das Massenkopieren angeben. Für Massenkopieren besteht ein Format aus folgenden Bestandteilen:

• Eine Zuordnung von Benutzerdateispalten zu Datenbankspalten

• Der 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_setcolfmt 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_setcolfmt, wobei mit drei dieser Aufrufe Ihr benutzerdefiniertes Format festgelegt wird. Legen Sie für die verbleibenden zwei Aufrufe BCP_FMT_TYPE auf 0 fest, und legen Sie BCP_FMT_INDICATOR_LENGTH, BCP_FMT_DATA_LEN und cbValue jeweils auf 0, SQL_VARLEN_DATA bzw. 0 fest. Mit diesem Verfahren werden alle fünf Spalten kopiert, drei mit dem benutzerdefinierten Format und zwei mit dem Standardformat.

Die bcp_columns-Funktion muss aufgerufen werden, bevor bcp_setcolfmt aufgerufen wird.

Sie müssen bcp_setcolfmt einmal für jede Eigenschaft jeder Spalte in der Benutzerdatei aufrufen.

Sie müssen 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, indem Sie den BCP_FMT_SERVER_COL-Parameter auf 0 festlegen. 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_setcolfmt-Unterstützung für erweiterte Features für Datum und Uhrzeit

Die mit der BCP_FMT_TYPE-Eigenschaft für Datums-/Uhrzeittypen verwendeten Typen entsprechen den unter Massenkopieränderungen für verbesserte Datum-/Uhrzeittypen (OLE DB und ODBC) angegebenen Typen.

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

Siehe auch

Verweis