SCALAR_INFO

The SCALAR_INFO structure contains information that describes the properties of a scalar in a folder.

typedef struct _SCALAR_INFO {
    char szName[BUFF_SIZE];
    SCALARTYPE scType;
    DWORD fAccess;
} SCALAR_INFO;

The SCALAR structure contains information about a specific scalar within a folder (including its value and the specific properties of the value, such as the length of a string scalar). In short, the SCALAR_INFO structure is used to get the general properties of a certain kind of scalar, and the SCALAR structure is used to store the actual value of a specific scalar within a specific folder.

The SCALAR_INFO structure is used by the SmsDescribeFolder function to retrieve the set of scalars supported by the folder.

Members

szName
Specifies the name of the scalar. The string has the length specified by BUFF_SIZE.
scType
Specifies a SCALARTYPE enumerated type that indicates the type of the scalar.
fAccess
Specifies the access rights of the scalar. See Access Rights.

To set the value of a scalar, the scalar must have access rights of ACCESS_CREATE or ACCESS_MODIFY and its folder must have access rights of ACCESS_CREATE or ACCESS_MODIFY. If the folder and scalar do not have these rights, SmsSetScalar returns an SMS_SCALAR_NO_UPDATE value. If you do not have access to the folder, the SmsSetScalar returns an SMS_FOLDER_NO_UPDATE value.

See Also

SCALAR, SmsDescribeFolder