Scalar Properties

Using SmsDescribeFolder, your application can retrieve information about the scalars for an individual folder type. The SmsDescribeFolder function enables your application to retrieve information about an individual folder type. The properties for the specified folder type are stored in a FOLDER_INFO structure.

Within the FOLDER_INFO structure, the following members provide information about the scalars within the specified folder type:

ctScalars

Specifies the number of scalars that the specified folder supports.

pScalars

Points to an array of SCALAR_INFO structures that describe the scalars supported by the folder.

By accessing the members of the SCALAR_INFO structure, your application can get the following information about the scalar:

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.

Note that the access right of each scalar is set by the SMS API engine—your application can read the access right of a scalar but it cannot set the access right.

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

To read a scalar, the scalar must have an access right of ACCESS_READ.