3.2.4.2.48.39 FileNamePattern (get) (Opnum 49)
The FileNamePattern (get) (Opnum 49) method retrieves the file name pattern for files that will be included when the file management job is run and returns S_OK upon successful completion.
-
[propget, id(FSRM_PROPERTY(FSRM_DISPID_FILE_MANAGEMENT_JOB | 0x17))] HRESULT FileNamePattern( [out, retval] BSTR* fileNamePattern );
fileNamePattern: Pointer to a variable that upon completion contains the file name pattern, if any, for files that will be included when the file management job is run.
Return Values: The method MUST return zero on success, or a nonzero error code on failure.
-
Return value/code
Description
0x80070057
E_INVALIDARG
This code is returned for the following reasons:
The fileNamePattern parameter is NULL.
The fileNamePattern parameter is not a valid pattern. The pattern cannot contain the following characters: question mark (?), slash mark (/), backslash (\), greater than sign (>), less than sign (<), vertical bar (|), or colon (:).
Upon receiving this message, the server MUST validate parameters:
Verify that fileNamePattern is not NULL.
If any validation fails, the server MUST terminate processing and return a nonzero error code.
The server MUST either set fileNamePattern to the file management job's file name pattern.