srv_paramstatus (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 status of a particular remote stored procedure call parameter.

Syntax


int srv_paramstatus (
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 number 1.

Returns

An int that contains status flags for the parameter. Currently, there is only one flag: If bit 0 is set to 1, the parameter is a return parameter. If there is no nth parameter or if there is no remote stored procedure, it returns -1.

Remarks

This routine returns the status flags for a remote stored procedure call parameter.

Parameters contain data passed between clients and the application with remote stored procedures. The client can specify certain parameters as return parameters. These return parameters can contain values that the application passes back to the client.

Currently, the only status flag is one that indicates whether the parameter is a return parameter.

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. If an error occurs, the SRV_RPC handler is still called, but it appears as if there were no parameters, and srv_rpcparams returns 0.

ms164620.security(en-US,SQL.90).gifSecurity 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.

See Also

Reference

srv_rpcparams (Extended Stored Procedure API)

Help and Information

Getting SQL Server 2005 Assistance