FOLDER_INFO

The FOLDER_INFO structure contains information that describes the properties of a folder or container.

typedef struct _FOLDER_INFO {
    BASETYPE tObjectity;
    char *pszTag;
    DWORD dwTag;
    DWORD ctFolders;
    DWORD *pFolderTags;
    DWORD ctFilters;
    DWORD *pFilterTags;
    DWORD ctScalars;
    SCALAR_INFO *pScalars;
    void *pNewFunc;
} FOLDER_INFO;

The FOLDER_INFO structure contains information about folders of a specific type, such as the tag, the number of types of subfolders that are supported, the list of scalars for the folder type, and so on. The FOLDER_INFO structure can also be used to store information about containers of a specific type.

The FOLDER_INFO structure is used by the SmsDescribeFolder, SmsEnumContainers, and SmsEnumFolders functions.

Members

tObjectity

Specifies the type of object: T_CONTAINER or T_FOLDER. See BASETYPE.

Because the FOLDER_INFO structure is used to describe both containers and folders, this member indicates which of these types is being described.

pszTag

Points to the string form of the object's tag. For example, a job container has a string tag of "Job Container".

dwTag

Specifies the integer form of the object's tag. For example, a job container has an integer tag of C_JOB, where C_JOB is a manifest constant defined in SMSAPI.H.

ctFolders

Specifies the number of folder types that the specified folder or container contains. Note that ctFolders specifies the types of folders that the specified folder or container is capable of containing—not the number of actual folders contained within a specific folder or container.

pFolderTags

Points to an array of DWORD values that indicate the types of subfolders supported by the folder or container.

ctFilters

Specifies the number of filter types that the specified folder or container supports.

pFilterTags

Points to an array of DWORD values that indicate the types of filters supported by the folder or container.

ctScalars

Specifies the number of scalars that the specified folder supports. This member is used only for folders.

pScalars

Points to an array of SCALAR_INFO structures that describes the scalars supported by the folder. This member is used only for folders.

pNewFunc

Specifies a function used by the SMS API to initialize a container. Reserved for use by the SMS API. Do not modify this member.

Remarks

When your application calls the SmsDescribeFolder engine API, a pointer to a pointer to a FOLDER_INFO structure is returned. This structure will have been created in the process of registering a folder (or container) with the engine. It contains global data about a folder of the specified type, rather than information about an instance of one of these folders. The information contained in this structure will be true for all folders of the specified type.

The returned pointer addresses memory inside the SMS API engine and should not be modified or deleted.

Note Machine folders currently do not register their scalars; therefore, the ctScalars member will be zero. This does not necessarily mean that these types of folders have no scalars. It simply indicates that the set of scalars is currently unknown.