Skip to content

Latest commit

 

History

History
192 lines (174 loc) · 5.51 KB

nf-pla-idatacollector-get_filenameformatpattern.md

File metadata and controls

192 lines (174 loc) · 5.51 KB
UID title description helpviewer_keywords old-location tech.root ms.assetid ms.date ms.keywords req.header req.include-header req.target-type req.target-min-winverclnt req.target-min-winversvr req.kmdf-ver req.umdf-ver req.ddi-compliance req.unicode-ansi req.idl req.max-support req.namespace req.assembly req.type-library req.lib req.dll req.irql targetos req.typenames req.redist ms.custom f1_keywords dev_langs topic_type api_type api_location api_name
NF:pla.IDataCollector.get_FileNameFormatPattern
IDataCollector::get_FileNameFormatPattern (pla.h)
Retrieves or sets the format pattern to use when decorating the file name. (Get)
FileNameFormatPattern property [PLA]
FileNameFormatPattern property [PLA]
IDataCollector interface
IDataCollector interface [PLA]
FileNameFormatPattern property
IDataCollector.FileNameFormatPattern
IDataCollector.get_FileNameFormatPattern
IDataCollector::FileNameFormatPattern
IDataCollector::get_FileNameFormatPattern
IDataCollector::put_FileNameFormatPattern
base.idatacollector_filenameformatpattern
get_FileNameFormatPattern
pla.idatacollector_filenameformatpattern
pla/IDataCollector::FileNameFormatPattern
pla/IDataCollector::get_FileNameFormatPattern
pla/IDataCollector::put_FileNameFormatPattern
pla\idatacollector_filenameformatpattern.htm
PLA
94e6bb13-fb99-4968-8a7f-fbda1f6ea42e
12/05/2018
FileNameFormatPattern property [PLA], FileNameFormatPattern property [PLA],IDataCollector interface, IDataCollector interface [PLA],FileNameFormatPattern property, IDataCollector.FileNameFormatPattern, IDataCollector.get_FileNameFormatPattern, IDataCollector::FileNameFormatPattern, IDataCollector::get_FileNameFormatPattern, IDataCollector::put_FileNameFormatPattern, base.idatacollector_filenameformatpattern, get_FileNameFormatPattern, pla.idatacollector_filenameformatpattern, pla/IDataCollector::FileNameFormatPattern, pla/IDataCollector::get_FileNameFormatPattern, pla/IDataCollector::put_FileNameFormatPattern
pla.h
Windows
Windows Vista [desktop apps only]
Windows Server 2008 [desktop apps only]
Pla.dll
Windows
19H1
IDataCollector::get_FileNameFormatPattern
pla/IDataCollector::get_FileNameFormatPattern
c++
APIRef
kbSyntax
COM
Pla.dll
IDataCollector.FileNameFormatPattern
IDataCollector.get_FileNameFormatPattern
IDataCollector.put_FileNameFormatPattern

IDataCollector::get_FileNameFormatPattern

-description

Retrieves or sets the format pattern to use when decorating the file name.

This property is read/write.

-parameters

-remarks

PLA uses the pattern only if the IDataCollector::FileNameFormat property is set to plaPattern.

PLA appends the decoration to the file name. Use the following pattern characters to define your own pattern. For example, the pattern "MMMM d, yyyy \a\t h:mmTt" could yield "January 31, 2005 at 4:20AM". If the file name is MyFile, the decorated file name would be "MyFile January 31, 2005 at 4:20AM".

Pattern Description
D Day of the year.
DDD Day of the year with leading zeros, if applicable.
d Day of the month.
dd Day of the month with a leading zero, if applicable.
ddd The abbreviated name of the weekday, for example, Tue for Tuesday.
dddd Full name of the weekday.
M Month.
MM Month with leading zero, if applicable.
MMM The abbreviated name of the month, for example, Jan for January.
MMMM Full name of the month.
y Year without the century.
yy Year without the century but including a leading zero, if applicable.
yyyy Year with the century.
h Hour in a 12-hour clock.
hh Hour in a 12-hour clock with a leading zero, if applicable.
H Hour in a 24-hour clock.
HH Hour in a 24-hour clock with a leading zero, if applicable.
m Minute.
mm Minute with a leading zero, if applicable.
S Second.
Ss Second with a leading zero, if applicable.
T The first character of the A.M./P.M. designator.
Tt The A.M./P.M. designator.
Z Time zone offset.
Zz Time zone offset with a leading zero, if applicable.
N Serial number. The number of leading zeros is defined by the number of characters. For example, if the serial number is 32 and the pattern is NNN, the serial number used is 032.
\c Escaped character, where c is any character. Unrecognized characters, excluding white space, that are not escaped will result in an error.

-see-also

IDataCollector

IDataCollector::FileName

IDataCollector::FileNameFormat