srv_paraminfo

Returns information about a parameter.

Important This function supersedes the following Open Data Services functions: srv_paramtype, srv_paramlen, srv_parammaxlen, and srv_paramdata. srv_paraminfo supports the new Open Data Services 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, Open Data Services 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 Open Data Services 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.