Share via

  • Article

srv_paraminfo (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 information about a parameter. This function supersedes the following functions: srv_paramtype, srv_paramlen, srv_parammaxlen, and srv_paramdata. srv_paraminfo supports the data types in Data Types and zero-length data.

Syntax


int srv_paraminfo (
SRV_PROC *
srvproc
,
int
n
,
BYTE *
pbType
,
ULONG *
pcbMaxLen
,
ULONG *
pcbActualLen
,
BYTE *
pbData
,
BOOL *
pfNull
);

Arguments

  • srvproc
    A handle for a client connection.

  • n
    The ordinal number of the parameter to be set. The first parameter is 1.

  • pbType
    The data type of the parameter.

  • pcbMaxLen
    Pointer to the maximum length of the parameter.

  • pcbActualLen
    Pointer to the actual length of the parameter. A value of 0 (*pcbActualLen == 0) signifies zero-length data if *pfNull is set to FALSE.

  • pbData
    Pointer to the buffer for parameter data. If pbData is not NULL, the Extended Store Procedure API writes *pcbActualLen bytes of data to *pbData. If pbData is NULL, no data is written to *pbData but the function returns *pbType, *pcbMaxLen, *pcbActualLen, and *pfNull. The memory for this buffer must be managed by the application.

  • pfNull
    Pointer to a null flag. *pfNull is set to TRUE if the value of the parameter is NULL.

Returns

If the parameter information was successfully obtained, SUCCEED is returned; otherwise, FAIL. FAIL is returned when there is no current remote stored procedure and when there is no nth remote stored procedure parameter.

Remarks

Security 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.