使用傳回碼傳回資料

發行項
12/15/2008

更新： 2006 年 7 月 17 日

預存程序可以傳回稱為傳回碼的整數值，以指示程序的執行狀態。若要為預存程序指定傳回碼，請使用 RETURN 陳述式。就像使用 OUTPUT 參數一樣，若要在呼叫程式中使用傳回碼，您必須在執行預存程序時將傳回碼儲存在變數中。比方說，資料類型為 int 的指派變數 @result 會用於儲存來自預存程序 my_proc 的傳回碼，例如：

DECLARE @result int;
EXECUTE @result = my_proc;

傳回碼常用於預存程序的流程控制區塊中，以設定每個可能錯誤狀況的傳回碼值。您可以在 Transact-SQL 陳述式後使用 @@ERROR 函數，來偵測陳述式執行過程中是否曾發生錯誤。

範例

A. 根據錯誤類型傳回不同的傳回碼

下列範例顯示具有可為各種錯誤設定特別傳回碼值之錯誤處理的 usp_GetSalesYTD 程序。下表顯示由預存程序指派給每個可能錯誤的整數值，以及每個值對應的意義。

傳回碼值	意義
0	成功執行。
1	未指定必要的參數值。
2	指定的參數值無效。
3	取得銷售值時發生錯誤。
4	銷售人員有 NULL 銷售值。

USE AdventureWorks;
GO
IF OBJECT_ID('Sales.usp_GetSalesYTD', 'P') IS NOT NULL
    DROP PROCEDURE Sales.usp_GetSalesYTD;
GO
CREATE PROCEDURE Sales.usp_GetSalesYTD
@SalesPerson nvarchar(50) = NULL,  -- NULL default value
@SalesYTD money = NULL OUTPUT
AS  

-- Validate the @SalesPerson parameter.
IF @SalesPerson IS NULL
   BEGIN
       PRINT 'ERROR: You must specify a last name for the sales person.'
       RETURN(1)
   END
ELSE
   BEGIN
   -- Make sure the value is valid.
   IF (SELECT COUNT(*) FROM HumanResources.vEmployee
          WHERE LastName = @SalesPerson) = 0
      RETURN(2)
   END
-- Get the sales for the specified name and 
-- assign it to the output parameter.
SELECT @SalesYTD = SalesYTD 
FROM Sales.SalesPerson AS sp
JOIN HumanResources.vEmployee AS e ON e.EmployeeID = sp.SalesPersonID
WHERE LastName = @SalesPerson;
-- Check for SQL Server errors.
IF @@ERROR <> 0 
   BEGIN
      RETURN(3)
   END
ELSE
   BEGIN
   -- Check to see if the ytd_sales value is NULL.
     IF @SalesYTD IS NULL
       RETURN(4) 
     ELSE
      -- SUCCESS!!
        RETURN(0)
   END
-- Run the stored procedure without specifying an input value.
EXEC Sales.usp_GetSalesYTD;
GO
-- Run the stored procedure with an input value.
DECLARE @SalesYTDForSalesPerson money, @ret_code int;
-- Execute the procedure specifying a last name for the input parameter
-- and saving the output value in the variable @SalesYTD
EXECUTE Sales.usp_GetSalesYTD
    N'Blythe', @SalesYTD = @SalesYTDForSalesPerson OUTPUT;
PRINT N'Year-to-date sales for this employee is ' +
    CONVERT(varchar(10), @SalesYTDForSalesPerson);

B. 處理從預存程序傳回的不同傳回碼

下列範例會建立程式以處理從 usp_GetSalesYTD 程序傳回的傳回碼。

-- Declare the variables to receive the output value and return code 
-- of the procedure.
DECLARE @SalesYTDForSalesPerson money, @ret_code int;

-- Execute the procedure with a title_id value
-- and save the output value and return code in variables.
EXECUTE @ret_code = Sales.usp_GetSalesYTD
    N'Blythe', @SalesYTD = @SalesYTDForSalesPerson OUTPUT;
--  Check the return codes.
IF @ret_code = 0
BEGIN
   PRINT 'Procedure executed successfully'
   -- Display the value returned by the procedure.
   PRINT 'Year-to-date sales for this employee is ' + CONVERT(varchar(10),@SalesYTDForSalesPerson)
END
ELSE IF @ret_code = 1
   PRINT 'ERROR: You must specify a last name for the sales person.'
ELSE IF @ret_code = 2 
   PRINT 'EERROR: You must enter a valid last name for the sales person.'
ELSE IF @ret_code = 3
   PRINT 'ERROR: An error occurred getting sales value.'
ELSE IF @ret_code = 4
   PRINT 'ERROR: No sales recorded for this employee.'   
GO

請參閱

變更歷程記錄

版本	歷程記錄
2006 年 7 月 17 日	新增內容：加入範例。

共用方式為

使用傳回碼傳回資料

範例

A. 根據錯誤類型傳回不同的傳回碼

B. 處理從預存程序傳回的不同傳回碼

請參閱

概念

其他資源

說明及資訊

變更歷程記錄

其他資源