CERT_SELECT_STRUCT_W structure (cryptdlg.h)

The CERT_SELECT_STRUCT structure contains criteria upon which to select certificates that are presented in a certificate selection dialog box. This structure is used in the CertSelectCertificate function.

Syntax

typedef struct tagCSSW {
  DWORD           dwSize;
  HWND            hwndParent;
  HINSTANCE       hInstance;
  LPCWSTR         pTemplateName;
  DWORD           dwFlags;
  LPCWSTR         szTitle;
  DWORD           cCertStore;
  HCERTSTORE      *arrayCertStore;
  LPCSTR          szPurposeOid;
  DWORD           cCertContext;
  PCCERT_CONTEXT  *arrayCertContext;
  LPARAM          lCustData;
  PFNCMHOOKPROC   pfnHook;
  PFNCMFILTERPROC pfnFilter;
  LPCWSTR         szHelpFileName;
  DWORD           dwHelpId;
  HCRYPTPROV      hprov;
} CERT_SELECT_STRUCT_W, *PCERT_SELECT_STRUCT_W;

Members

dwSize

The size, in bytes, of this structure.

hwndParent

A handle to the parent window of any dialog boxes that CertSelectCertificate generates.

hInstance

A handle to the module whose executable file contains the dialog box template.

pTemplateName

If the CSS_ENABLETEMPLATE flag is set in the dwFlags member, set pTemplateName to a pointer to a global memory object that contains the template that DialogBoxIndirectParam uses to create the dialog box. A dialog box template consists of a header that describes the dialog box. The header is followed by one or more additional blocks of data that describe each of the controls in the dialog box. The template can use either the standard format or the extended format.

If the CSS_ENABLETEMPLATEHANDLE flag is set in dwFlags, pTemplateName specifies the dialog box template. pTemplateName is either the pointer to a null-terminated character string that specifies the name of the dialog box template or an integer value that specifies the resource identifier of the dialog box template. If the specifies a resource identifier, its high-order word must be zero and its low-order word must contain the identifier. One way to create this integer value is to use the MAKEINTRESOURCE macro.

dwFlags

This member can be one or more of the following values.

Value	Meaning
CSS_HIDE_PROPERTIES	Hide the Properties button.
CSS_ENABLEHOOK	Pass a hook procedure in pfnHook.
CSS_ALLOWMULTISELECT	Enable multi-selection of certificates. This option is not currently supported and is ignored.
CSS_SHOW_HELP	Show the Help button.
CSS_ENABLETEMPLATE	Cause CertSelectCertificate function to call the DialogBoxIndirectParam function to create a dialog box. For more information, see pTemplateName.
CSS_ENABLETEMPLATEHANDLE	Cause the CertSelectCertificate function to call the DialogBoxParam function to create a dialog box. For more information, see pTemplateName.

szTitle

A pointer to a string that contains the text for the title of the dialog box.

cCertStore

The number of elements in arrayCertStore array.

arrayCertStore

A pointer to the array of certificate stores that the dialog box enumerates and displays the certificates from. The cCertStore member contains the number of elements in this array.

szPurposeOid

A pointer to a string representation of an object identifier (OID) for an enhanced key usage (EKU). If an OID is provided, only certificates that include this EKU will be displayed.

cCertContext

The number of elements in the arrayCertContext array. After the CertSelectCertificate function returns, this member contains the number of certificates that were selected by the user. Currently, only one certificate can be selected by the user.

arrayCertContext

A pointer to an array of CERT_CONTEXT structures. The cCertContext member specifies the number of elements in this array. This array must contain at least one element.

The certificates represented by these structures are selected when the dialog box displayed by the CertSelectCertificate function is initially displayed. Currently, only the first certificate in this array is used. The first certificate in this array will be released with the CertFreeCertificateContext function if the CertSelectCertificate function is successful. If the first element in this array is NULL, no certificates are initially selected in the dialog box.

After the CertSelectCertificate function returns, this array contains the certificates that were selected by the user. Currently, only one certificate can be selected by the user.

lCustData

A pointer to an array of byte values that hold custom data that is passed through to the filter procedure referenced by pfnFilter. This custom data is not used by the CertSelectCertificate function.

pfnHook

A PFNCMHOOKPROC function pointer to the Hook callback function. This function is called before messages are processed by the dialog box. For more information, see Hooks.

pfnFilter

A PFNCMFILTERPROC function pointer to the filter callback function. This is called to determine which certificates will be displayed by the dialog box.

szHelpFileName

A pointer to a null-terminated string that contains the full path to the Help file.

dwHelpId

The context identifier for the topic. For more information, see
WinHelp.

hprov

A handle to the Cryptographic Service Provider (CSP) to use for certificate verification.

Remarks

Note

The cryptdlg.h header defines CERT_SELECT_STRUCT as an alias which automatically selects the ANSI or Unicode version of this function based on the definition of the UNICODE preprocessor constant. Mixing usage of the encoding-neutral alias with code that not encoding-neutral can lead to mismatches that result in compilation or runtime errors. For more information, see Conventions for Function Prototypes.

Requirements

Requirement	Value
Minimum supported client	Windows XP [desktop apps only]
Minimum supported server	Windows Server 2003 [desktop apps only]
Header	cryptdlg.h

See also

CertSelectCertificate