Get-PubItemIcon

NAME

Get-PubItemIcon

SYNOPSIS

Get the published resource icon.

SYNTAX

Get-PubItemIcon [-Id] <uint> [-DirPath] <string> [-SiteId <uint>] [<CommonParameters>]

DESCRIPTION

Save the published resource icon to a specified directory.

Get-PubItemIcon command returns the full path (with filename) of the saved published resource icon.

If HD icon data is available, the icon is saved with 2 resolutions (standard and HD). Otherwise, only the standard resolution is saved.

PARAMETERS


-Id <uint>
Published resource ID. 

        Required?                    true
        Position?                    0
        Default value                0
        Accept pipeline input?       false
        Accept wildcard characters?  false

-DirPath <string>
The target directory where to save the published resource icon file. 

        Required?                    true
        Position?                    1
        Default value                
        Accept pipeline input?       false
        Accept wildcard characters?  false

-SiteId <uint>
Site ID. 

        Required?                    false
        Position?                    named
        Default value                0
        Accept pipeline input?       false
        Accept wildcard characters?  false

<CommonParameters> 
        This cmdlet supports the common parameters: Verbose, Debug,
        ErrorAction, ErrorVariable, WarningAction, WarningVariable,
        OutBuffer, PipelineVariable, and OutVariable. For more information, see 
        about_CommonParameters documentation.

INPUTS

-none-

OUTPUTS

System.String

EXAMPLES


---------- EXAMPLE 1 ----------

Get-PubItemIcon -Id 11 -DirPath "C:\\MyIcons\\"

Saves the icon of a published resource specified by ID.

Directory path specified in -DirPath must exist.

RELATED LINKS