IUserInputString::GetStringType method (photoacquire.h)
The GetStringType
method retrieves a value indicating the type of string to obtain from the user.
Syntax
HRESULT GetStringType(
[out] USER_INPUT_STRING_TYPE *pnStringType
);
Parameters
[out] pnStringType
Pointer to an integer value containing the string type.
Value | Description |
---|---|
USER_INPUT_DEFAULT | Specifies that any string is allowed. |
USER_INPUT_PATH_ELEMENT | Specifies that the string will not accept characters that are illegal in file or directory names (such as * or /). |
Return value
The method returns an HRESULT. Possible values include, but are not limited to, those in the following table.
Return code | Description |
---|---|
|
The method succeeded. |
|
A NULL pointer was passed where a non-NULL pointer is expected. |
Requirements
Requirement | Value |
---|---|
Target Platform | Windows |
Header | photoacquire.h |
Library | PhotoAcquireUID.lib |