• Article

srv_paramtype (Extended Stored Procedure API)

Important

This feature will be removed in a future version of Microsoft SQL Server. Do not use this feature in new development work, and modify applications that currently use this feature as soon as possible. Use CLR integration instead.

Returns the data type of a remote stored procedure call parameter.

Syntax


int srv_paramtype (
SRV_PROC *
srvproc
,
int
n 
);

Arguments

  • srvproc
    Is a pointer to the SRV_PROC structure that is the handle for a particular client connection (in this case, the handle that received the remote stored procedure call). The structure contains information the Extended Stored Procedure API library uses to manage communication and data between the application and the client.

  • n
    Indicates the number of the parameter. The first parameter is 1.

Returns

A token value for the data type of the parameter. For information about data types, see Data Types (Extended Stored Procedure API). If there is no nth parameter or if there is no remote stored procedure, it returns - 1.

This function returns the following values, if the parameter is one of the Microsoft SQL Server 2005 data types.

New data types

Return value

BITN

SRVBIT

BIGVARCHAR

VARCHAR

BIGCHAR

CHAR

BIGBINARY

BINARY

BIGVARBINARY

VARBINARY

NCHAR

CHAR

NVARCHAR

VARCHAR

NTEXT

-1

Remarks

When a remote stored procedure call is made with parameters, the parameters can be passed either by name or by position (unnamed). If the remote stored procedure call is made with some parameters passed by name and some passed by position, an error occurs. The SRV_RPC handler is still called, but it appears as if there were no parameters and srv_rpcparams returns 0.

Security noteSecurity Note

You should thoroughly review the source code of extended stored procedures, and you should test the compiled DLLs before you install them on a production server. For information about security review and testing, see this Microsoft Web site.