rs_helpfstring

Displays the parameters and function string text for functions associated with a replication definition.

Syntax

rs_helpfstring replication_definition
[, function_name]

Parameters

replication_definition – The table or function replication definition for which you want to view functions.
function_name – A string of characters that corresponds to a function name. The string must match an entire function name or the first part of a name.

Examples

Example 1 – Displays parameters and function string text for all functions of the replication definition authors_rep.
```
rs_helpfstring authors_rep
```

Example 2 – Displays parameters and function string text for the rs_insert function of the replication definition authors_rep.

rs_helpfstring authors_rep, rs_insert

Function String information for Replication Definition.
                       'authors_rep'
Valid Parameters are:
 Parameter Name                  Datatype
 ------------------------------- ------------------------------
 @au_id                          varchar
 @au_lname                       varchar
 @au_fname                       varchar
 @phone                          char
 @address                        varchar
 @city                           varchar
 @state                          char
 @country                        varchar
 @postalcode                     char

Rep.Def.Name  Function Name   FString Name  FSClass Name
-------------- -------------- ------------ ---------------------------
 authors_rep    rs_insert     rs_insert     rs_sqlserver_function_class

    --- Begin FString Text ---
 --------------------------------------------------------
     *** System-Supplied Transact-SQL Statement ***
       --- End FString Text ---

Usage

If you do not supply a function_name parameter, rs_helpfstring displays all function strings defined for all functions of the replication definition.
If you supply a function_name string, rs_helpfstring displays function strings that match function_name, such as rs_insert, rs_delete, rs_update, and rs_select, or a user-defined function.
System-generated default function strings have no function string text stored in the RSSD. For these functions strings, rs_helpfstring displays the message “System-Supplied Transact-SQL Statement.”