srv_describe (Utökat Stored Procedure API)

Gäller för:SQL Server

Important

Den här funktionen tas bort i en framtida version av SQL Server. Undvik att använda den här funktionen i nytt utvecklingsarbete och planera att ändra program som för närvarande använder den här funktionen. Använd istället CLR-integration.

Definierar kolumnnamn samt käll- och destinationsdatatyper för en specifik kolumn i en rad.

Syntax

  
int srv_describe (  
SRV_PROC *  
srvproc  
,  
int  
colnumber  
,  
DBCHAR *  
column_name  
,  
int  
namelen  
,  
DBINT  
desttype  
,  
DBINT  
destlen  
,  
DBINT  
srctype  
,  
DBINT  
srclen  
,  
void *  
srcdata  
);  

Arguments

srvproc
Är en pekare till den SRV_PROC struktur som är handtaget för en viss klientanslutning (i detta fall klienten som skickar raden). Strukturen innehåller all information som Extended Stored Procedure API-biblioteket använder för att hantera kommunikation och data mellan applikationen och klienten.

Kolnummer
Stöds för närvarande inte. Kolumnerna måste beskrivas i ordning. Alla kolumner måste beskrivas innan srv_sendrow anropas.

column_name
Specificerar namnet på kolumnen som datan tillhör. Denna parameter kan vara NULL eftersom en kolumn inte behöver ha ett namn.

Namelen
Specificerar längden, i bytes, av column_name. Om namelen är SRV_NULLTERM måste column_name vara nullterminerad.

desttype
Specificerar datatypen för destinationsradkolumnen. Detta är datatypen som skickas till klienten. Datatypen måste specificeras även om datan är NULL, för mer information, se Data Types (Extended Stored Procedure API).

Destlen
Specificerar längden, i bytes, på den data som ska skickas till klienten. För datatyper med fast längd som inte tillåter nullvärden ignoreras destlen . För datatyper med variabel längd och data med fast längd som tillåter nollvärden, specificerar destlen den maximala längden destinationsdata kan ha.

srctype
Specificerar datatypen för källdatan.

srclen
Specificerar längden, i bytes, på källdatan. Detta värde ignoreras för datatyper med fast längd.

srcdata
Tillhandahåller källdataadressen för en viss kolumn. När srv_sendrow anropas letar den efter data för colnumber på srcdata. Därför bör den inte frigöras innan ett samtal till srv_sendrow. Källdataadressen kan ändras mellan anrop till srv_sendrow genom att använda srv_setcoldata. Minne som tilldelats srcdata bör inte frigöras förrän kolumndatan ersätts av ett annat anrop till srv_setcoldata, eller tills srv_senddone anropas.

Om desttypen är SRVDECIMAL eller SRVNUMERISK måste parametern srcdata vara en pekare till en DBNUMERIC eller DBDECIMAL struktur där precisions- och skalfälten redan är satta till de värden du vill ha. Du kan använda DEFAULTPRECISION för att ange en standardprecision, och DEFAULTSCALE för att ange en standardskala.

Returns

Kolumnens nummer som beskrivs. Den första kolumnen är kolumn 1. Om ett fel uppstår, returnerar 0.

Remarks

Funktionen srv_describe måste anropas en gång för varje kolumn i raden innan det första anropet till srv_sendrow. Kolumnerna i en rad kan beskrivas i valfri ordning.

För att ändra platsen och längden på källdata i kolumnrader innan hela resultatuppsättningen har skickats, använd srv_setcoldata respektive srv_setcollen.

För en beskrivning av datatyper och Extended Store Procedure API:s datatypkonverteringar, se Data Types (Extended Stored Procedure API).

Om kolumnnamnet i din applikation är i Unicode behöver du konvertera det till serverns multibyte-kodsida innan du anropar srv_describe. För mer information, se Unicode Data och Server Code Pages.

Important

Du bör noggrant granska källkoden för utökade lagrade procedurer, och du bör testa de kompilerade DLL:erna innan du installerar dem på en produktionsserver. För information om säkerhetsgranskning och testning, se denna Microsoft-webbplats.