[Top] [Prev] [Next] [Bottom] [Contents]

SaSiteGetVar

 Gets the "Boolean" value of a template conditional variable. A set variable section will be played in an "IF" section if the variable is set and not played in a "NOT" section. Alternatively, a reset variable section will be not be played in an "IF" section if the variable is reset and played in a "NOT" section. The default is to not "play" an "IF" section if the variable was never manipulated and to "play" a "NOT" section if the variable was never manipulated.

Synopsis

#include "SaRnHtml.h"
int SaSiteGetVar SUTPROTO((char* var));

Arguments

var
String specifying the name of a template variable. The name must match the template variable in case or the call will have no effect.
int
The value that the conditional template variable will have.

Return Values

 Returns the value that the conditional template variable has.

Description

Gets the "Boolean" value of a template conditional variable. A set variable section will be played in an "IF" section if the variable is set and not played in a "NOT" section. Alternatively, a reset variable section will be not be played in an "IF" section if the variable is reset and played in a "NOT" section. The default is to not "play" an "IF" section if the variable was never manipulated and to "play" a "NOT" section if the variable was never manipulated.

Example

int flag;
flag = SaSiteGetVar("mysite");

See Also

[Top] [Prev] [Next] [Bottom] [Contents]

info@bluestone.com
Copyright © 1997, Bluestone. All rights reserved.