PFSCE_QUERY_INFO function pointer
The PFSCE_QUERY_INFO callback function queries service-specific information from the Security Configuration file or analysis database.
Syntax
typedef SCESTATUS ( *PFSCE_QUERY_INFO)(
_In_ SCE_HANDLE sceHandle,
_In_ SCESVC_INFO_TYPE sceType,
_In_opt_ LPTSTR lpPrefix,
_In_ BOOL bExact,
_Out_ PVOID *ppvInfo,
_Out_ PSCE_ENUMERATION_CONTEXT psceEnumHandle
);
Parameters
- sceHandle [in]
-
Type: SCE_HANDLE
Specifies the opaque handle passed to the attachment by the Security Configuration tool set during the call to ISceSvcAttachmentData::Initialize. This handle is used to store the queried information.
- sceType [in]
-
Type: SCESVC_INFO_TYPE
Specifies the type of information to be queried. Specify one of the following flags.
Value Meaning - SCE_SERVICE_CONFIGURATION_INFO
Requests configuration information from the database.
- SCE_SERVICE_ANALYSIS_INFO
Requests analysis information from the database.
- lpPrefix [in, optional]
-
Type: LPTSTR
Specifies a prefix or key (see bExact) for limiting the query. When a string is supplied, only those keys (and their corresponding values) that match the string are returned. When set to NULL, all keys are returned.
- bExact [in]
-
Type: BOOL
Specifies whether the string provided by lpPrefix should be treated as a specific key or a prefix. This parameter is ignored if lpPrefix is set to NULL. Specify one of the following values.
- ppvInfo [out]
-
Type: PVOID*
Returns a pointer to one of the following structures. The Security Configuration tool set (not the attachment) allocates the buffer for the information; therefore, this pointer must point to NULL.
Value Meaning - SCESVC_CONFIGURATION_INFO
When sceType is set to SCE_SERVICE_CONFIGURATION_INFO.
- SCESVC_ANALYSIS_INFO
When sceType is set to SCE_SERVICE_ANALYSIS_INFO.
- psceEnumHandle [out]
-
Type: PSCE_ENUMERATION_CONTEXT
Returns a handle that can be used in successive calls to this function. Due to the large number of keys that may be present, not all keys are returned in a single call. The maximum number of keys that may be returned in a single call is 256.
Return value
Type: SCESTATUS
An SCESTATUS value that indicates the result of the function call. If the function succeeds, it returns SCESTATUS_SUCCESS; otherwise, it returns an error value, which can be one of the following.
| Return code | Description |
|---|---|
|
One of the parameters passed into the function was not valid. |
|
The specified record was not found in the security database. |
|
The format is not valid. |
|
An unspecified error has occurred. |
|
There is insufficient memory. |
Remarks
The Security Configuration tool set allocates buffers when PFSCE_QUERY_INFO is called. To free these buffers call PFSCE_FREE_INFO after the returned information is no longer needed.
Examples
| For an example of | See |
|---|---|
| Retrieving configuration information | Implementing SceSvcAttachmentConfig |
| Retrieving analysis information | Implementing SceSvcAttachmentAnalyze |
| Retrieving configuration and analysis information | Implementing SceSvcAttachmentUpdate |
Requirements
|
Minimum supported client |
Windows XP [desktop apps only] |
|---|---|
|
Minimum supported server |
Windows Server 2003 [desktop apps only] |
|
Header |
|
See also