• Article

srv_pfieldex (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 a pointer to data containing the requested SRV_PROC field.

Syntax


void *srv_pfieldex(SRV_PROC * 
srvproc
, int 
field
, int * 
len
);

Arguments

  • srvproc
    Is a pointer to the SRV_PROC structure that is the handle for a particular client connection. The structure contains information the Extended Stored Procedure API library uses to manage communication and data between the application and the client.

  • field
    Specifies the srvproc field to return.

    Field

    Description

    Return-type

    SRV_MSGLCID

    Current session message LCID.

    ULONG*

    SRV_INSTANCENAME

    Instance name (if named); otherwise, returns NULL.

    WCHAR*

  • len
    Is a pointer to an int variable that contains the length of the returned field value in bytes. If len is NULL, the length is not returned. When NULL is returned *len is set to 0.

Returns

A pointer to data whose type depends on field. NULL is returned when len is NULL or srvproc is NULL. If the field is unknown, NULL is returned. When NULL is returned *len is set to 0.

Security noteSecurity Note

The buffer returned from the server should be read only. Otherwise, the server state may be corrupted.

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.